github-action-readme-generator
Version:
The docs generator for GitHub Actions. Auto-syncs action.yml to README.md with 8 sections: inputs, outputs, usage, badges, branding & more. Works as CLI or GitHub Action.
205 lines (204 loc) • 6.45 kB
JSON
{
"name": "github-action-readme-generator",
"displayName": "bitflight-devops/github-action-readme-generator",
"version": "1.10.4",
"description": "The docs generator for GitHub Actions. Auto-syncs action.yml to README.md with 8 sections: inputs, outputs, usage, badges, branding & more. Works as CLI or GitHub Action.",
"keywords": [
"github-actions",
"actions",
"documentation",
"readme-generator",
"action-yml",
"markdown-generator",
"github-action-docs",
"auto-docs",
"devops",
"cli",
"inputs-outputs",
"usage-generator"
],
"homepage": "https://github.com/bitflight-devops/github-action-readme-generator#readme",
"bugs": {
"url": "https://github.com/bitflight-devops/github-action-readme-generator/issues"
},
"repository": {
"type": "git",
"url": "git+https://github.com/bitflight-devops/github-action-readme-generator.git"
},
"license": "Apache-2.0",
"author": "Jamie Nelson <jamie@bitflight.io>",
"type": "module",
"exports": {
"import": "./dist/mjs/index.js",
"require": "./dist/cjs/index.js"
},
"main": "dist/cjs/index.js",
"module": "dist/mjs/index.js",
"types": "dist/types/index.d.ts",
"bin": {
"github-action-readme-generator": "dist/bin/index.js"
},
"files": [
"package.json",
"README.md",
"LICENSE",
"CHANGELOG.md",
"action.yml",
"dist/"
],
"scripts": {
"all": "npm run build && npm run format && npm run lint && npm run test",
"prebuild": "tsc --project tsconfig.json --noemit",
"build": "rimraf dist out;node ./scripts/esbuild.mjs && chmod +x dist/bin/index.js",
"postbuild": "tsc --project tsconfig.json --emitDeclarationOnly --declaration --outFile dist/types/index.d.ts && tsc -p tsconfig-mjs.json && ./scripts/set_package_type.sh",
"build:docker": "run-script-os",
"build:docker:default": "docker run --rm -t -v $(pwd):/work -w /work node:20-alpine sh -c 'npm run build'",
"build:docker:win32": "docker run --rm -t -v \"%cd%\":/work -w /work node:20-alpine sh -c \"npm run build\"",
"clean": "rimraf dist",
"commit": "git-cz",
"corepack": "corepack enable",
"current-version": "jq -r '.version' package.json",
"format": "biome format --write ./src ./__tests__",
"format:check": "biome format ./src ./__tests__",
"format:prettier": "prettier --write . --config .prettierrc.cjs --ignore-unknown",
"generate-docs": "echo 'Generating docs';node dist/bin/index.js && git add README.md ./.github/ghadocs .ghadocs.json || true",
"postinstall": "echo '✨ Successfully Installed'",
"prelint": "npm run format && tsc --project tsconfig.json --noemit",
"lint": "npm run lint:biome && npm run lint:markdown",
"lint:fix": "npm run lint:biome:fix && npm run lint:markdown:fix",
"lint:biome": "biome lint ./src/ ./__tests__/",
"lint:biome:fix": "biome lint --write ./src/ ./__tests__/",
"check": "biome check ./src/ ./__tests__/",
"check:fix": "biome check --write ./src/ ./__tests__/",
"markdownlint": "markdownlint",
"lint:markdown": "markdownlint \"**/*.md\" --config=.markdownlint.json --ignore-path=.markdownlintignore",
"lint:markdown:fix": "npm run lint:markdown -- --fix",
"pre-commit": "lint-staged && npm run build && npm run generate-docs",
"prepare": "[ -n ${GITHUB_ACTIONS:-} ] || husky install",
"semantic-release": "semantic-release",
"test": "vitest",
"coverage": "vitest run --coverage",
"version:manual": "echo 'Run versioning commands';echo \"::set-output name=tag::v${npm_package_version}\"",
"postversion:manual": "git push --tags origin && git push origin"
},
"commitlint": {
"extends": [
"@commitlint/config-conventional"
],
"rules": {
"body-max-length": [
0
],
"body-max-line-length": [
0
],
"footer-max-length": [
0
],
"footer-max-line-length": [
0
],
"header-max-length": [
0
]
}
},
"lint-staged": {
"*.{md,yaml,yml,sh}": "prettier --write",
"{src,__tests__}/**/*.ts": "biome check --write",
"*.json": "biome format --write"
},
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog"
}
},
"release": {
"branches": [
"main",
"next",
{
"name": "alpha",
"prerelease": true
}
],
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
"@semantic-release/changelog",
[
"@semantic-release/exec",
{
"prepareCmd": "npm run generate-docs"
}
],
[
"@semantic-release/npm",
{
"npmPublish": true,
"provenance": true
}
],
"@semantic-release/github",
"@semantic-release/git"
],
"preset": "angular"
},
"dependencies": {
"@actions/core": "^3.0.0",
"@actions/github": "^9.0.0",
"@svgdotjs/svg.js": "^3.2.5",
"@types/feather-icons": "^4.29.4",
"@types/svgdom": "^0.1.2",
"chalk": "^5.6.2",
"feather-icons": "^4.29.2",
"nconf": "^0.13.0",
"prettier": "^3.8.1",
"svgdom": "^0.1.22",
"yaml": "^2.8.2"
},
"devDependencies": {
"@biomejs/biome": "2.4.9",
"@commitlint/cli": "^20.3.1",
"@commitlint/config-conventional": "^20.3.1",
"@commitlint/prompt": "^20.3.1",
"@semantic-release/changelog": "^6.0.3",
"@semantic-release/exec": "^7.1.0",
"@semantic-release/git": "^10.0.1",
"@tsconfig/node20": "^20.1.2",
"@types/nconf": "^0.10.5",
"@types/node": "^25.0.9",
"@vitest/coverage-v8": "^4.1.2",
"commitizen": "^4.3.1",
"conventional-commits": "^1.6.0",
"cz-conventional-changelog": "^3.3.0",
"dotenv": "^17.2.4",
"esbuild": "^0.27.2",
"esbuild-node-externals": "^1.20.1",
"husky": "^9.1.7",
"is-ci": "^4.1.0",
"lint-staged": "^16.2.7",
"markdownlint-cli": "^0.47.0",
"rimraf": "^6.1.2",
"run-script-os": "^1.1.6",
"semantic-release": "^25.0.2",
"ts-node": "^10.9.1",
"types-package-json": "^2.0.39",
"typescript": "^5.7.3",
"vitest": "^4.1.2"
},
"engines": {
"node": ">=20.11.0 <26.0.0",
"npm": ">=10.0.0"
},
"os": [
"!win32"
],
"publishConfig": {
"access": "public",
"registry": "https://registry.npmjs.org/"
},
"volta": {
"node": "20.9.0"
}
}