actions/toolkit
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/actions/toolkit synced 2026-04-07 11:33:21 +08:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* autogenerate artifact documentation

* clean up comments for better autogen docs
This commit is contained in:
Rob Herley
2023-12-07 12:57:20 -05:00
committed by GitHub
parent 43ccaf05d9
commit 64d1b104d0
19 changed files with 1530 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
packages/artifact/package.json
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"
}
}