actions/setup-node
1
0
Fork 0
mirror of https://code.forgejo.org/actions/setup-node.git synced 2025-06-02 10:41:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Generate documentation from actions.yml

Browse source 
Right now the documentation of valid inputs (and outputs) seems to be
manually maintained inside the `README.md` with a reference to the
`actions.yml` file.

Since this can be rather tedious to maintain this commit now uses
[github-actions-docs][1] to automatically generate documentation.

[1]: https://www.npmjs.com/package/github-action-docs
This commit is contained in:
Stefan Schulte 2025-03-03 22:32:11 +01:00
parent 802632921f
commit c6d37f6ecc
3 changed files with 66 additions and 60 deletions
Download patch file Download diff file Expand all files Collapse all files

4
package.json
View file

@ -11,7 +11,8 @@
"lint": "eslint --config ./.eslintrc.js \"**/*.ts\"",
"lint:fix": "eslint --config ./.eslintrc.js \"**/*.ts\" --fix",
"test": "jest --coverage",
"pre-checkin": "npm run format && npm run lint:fix && npm run build && npm test"
"pre-checkin": "npm run gen-docs && npm run format && npm run lint:fix && npm run build && npm test",
"gen-docs": "github-action-docs --sections inputs outputs --output-file README.md --mode inject action.yml"
},
"repository": {
"type": "git",
@ -47,6 +48,7 @@
"eslint-config-prettier": "^8.6.0",
"eslint-plugin-jest": "^27.9.0",
"eslint-plugin-node": "^11.1.0",
"github-action-docs": "^1.1.0",
"jest": "^29.7.0",
"jest-circus": "^29.7.0",
"jest-each": "^29.7.0",