Generate Typescript Docs for @actions/artifact (#1595)

* autogenerate artifact documentation

* clean up comments for better autogen docs
This commit is contained in:
Rob Herley authored and GitHub committed 2023-12-07 09:57:20 -08:00
1 parent 3ceb7b1f27
commit 469fb7f7c6
19 files changed
+1530 -33

No files matched your search

+4 -1
View File
@@ -33,7 +33,8 @@
"test": "cd ../../ && npm run test ./packages/artifact",
"bootstrap": "cd ../../ && npm run bootstrap",
"tsc-run": "tsc",
"tsc": "npm run bootstrap && npm run tsc-run"
"tsc": "npm run bootstrap && npm run tsc-run",
"gen:docs": "typedoc --plugin typedoc-plugin-markdown --out docs/generated src/artifact.ts --githubPages false --readme none"
},
"bugs": {
"url": "https://github.com/actions/toolkit/issues"
@@ -57,6 +58,8 @@
},
"devDependencies": {
"@types/archiver": "^5.3.2",
"typedoc": "^0.25.4",
"typedoc-plugin-markdown": "^3.17.1",
"typescript": "^5.2.2"
}
}