{"_id":"@action-validator/core","_rev":"6-b1e71d2c03c529a5b5ee7017618eacc3","name":"@action-validator/core","dist-tags":{"latest":"0.6.0"},"versions":{"0.4.0":{"name":"@action-validator/core","collaborators":["Matt Palmer ","Ben Heidemann "],"description":"Validator for GitHub action and workflow YAML files","version":"0.4.0","license":"GPL-3.0-only","repository":{"type":"git","url":"git+https://github.com/mpalmer/action-validator.git"},"main":"action_validator.js","homepage":"https://github.com/mpalmer/action-validator","types":"action_validator.d.ts","scripts":{"build":"npx wasm-pack build --out-dir target/wasm-pack/build --no-typescript --target nodejs --features js && cp target/wasm-pack/build/action_validator_bg.wasm dist/ && cp target/wasm-pack/build/action_validator.js dist/ && cp target/wasm-pack/build/action_validator.js dist/","test":"node test/run.mjs","lint":"prettier --check .","format":"prettier --write ."},"gitHead":"4e6f11946701196bde1a9f33ffcd8a6642ea52d2","bugs":{"url":"https://github.com/mpalmer/action-validator/issues"},"_id":"@action-validator/core@0.4.0","_nodeVersion":"18.14.2","_npmVersion":"9.5.0","dist":{"integrity":"sha512-V0I9QqJe3g953hgFbTR2zuEyJpfleXLYL5AD4C40jg6pF8SP5va8m2X2WmLJbhRf+I+ah1t9cxgWxORWpNE3Rg==","shasum":"03a30e5a3ae406a301f91798952ba2713a7f510c","tarball":"https://registry.npmjs.org/@action-validator/core/-/core-0.4.0.tgz","fileCount":6,"unpackedSize":2491530,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCP6v7POiEKlFBEKRwPmlF4617qPzbU3o+qBQ+Hzk3bvwIhAM6qXcAnvErZ46oi0cVOuDFUnSGDJ9dDCudR/ZWQ/SPR"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkAYgzACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqxcBAAk+UjuVf/ov/5OqcoGFE3BQdkfv/BWqJPnGYefXBphNkI2rzI\r\n3EP8TmojxRoNPFAJq882WFBladzzPbjz2AZfiV7FmZtcfOSZMyfNLWlqKcNt\r\n4J7J7sP5CEiAJaKJUhlbbCagt44f/0oQ8iFxKovRV8bXS5E3akLPnUC4R9UN\r\n/WUyBVXYSrwYL98AhnfIslAnAvpaUtJFkAT6tvdtiBJcu0iyFpYqyOF90Skr\r\nt+p1/MPjyxEzL5eiJPdq7aplVLWo9E/fwKTkT98pO+HfbEqDupccxW0d3gt4\r\nDWqCeV+kxQzDtN8yCZplQ/G1c1s4eG6gaw0dohdyik2y6RTaLa8kS+/yp28y\r\nNY0QCM1W8lokeVp+Qv6b07yScyNve3A8rD9GQOOge+OxvLCsneS9rk2dKuT4\r\nUgghY45rxFQkiN46LlECgC2fyruGcJlQHqE33aVZjEA86EyF2fuBhKrT7lqs\r\nRLP4MxJFCpHXaypUH8LBBkveBBCq1/tKCqMOExPPSILBecvLlB9BtXhcENhJ\r\n96TOOB7zl/ixq6NyGmWBDGv2O2emImYxRhDCE4TXb0vfNP5iaxRG3bKwlHjt\r\nENTc59P6kMX21wlMpAquI4NMkcjKOSBRytibhGe/jHDsKPBOBSHBE5TNER4T\r\nKgBnD/BGHmcFNQZqGI3XUPkNgswc01sBjb0=\r\n=FTQI\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"deterministicusername","email":"mp+npmjs@hezmatt.org"},"directories":{},"maintainers":[{"name":"deterministicusername","email":"mp+npmjs@hezmatt.org"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/core_0.4.0_1677822002733_0.45078694132173935"},"_hasShrinkwrap":false},"0.5.0":{"name":"@action-validator/core","collaborators":["Matt Palmer ","Ben Heidemann "],"description":"Validator for GitHub action and workflow YAML files","version":"0.5.0","license":"GPL-3.0-only","repository":{"type":"git","url":"git+https://github.com/mpalmer/action-validator.git"},"main":"action_validator.js","homepage":"https://github.com/mpalmer/action-validator","types":"action_validator.d.ts","scripts":{"build":"npx wasm-pack build --out-dir target/wasm-pack/build --no-typescript --target nodejs --features js && cp target/wasm-pack/build/action_validator_bg.wasm dist/ && cp target/wasm-pack/build/action_validator.js dist/ && cp target/wasm-pack/build/action_validator.js dist/","test":"node test/run.mjs","lint":"prettier --check .","format":"prettier --write ."},"gitHead":"822d4cd25dc9aed36229c3cb5948d1bd37f7a664","bugs":{"url":"https://github.com/mpalmer/action-validator/issues"},"_id":"@action-validator/core@0.5.0","_nodeVersion":"18.14.2","_npmVersion":"9.5.0","dist":{"integrity":"sha512-PtwNVj53FuhSrI4+7gRZ/b5amRtvOCapSsLY/e+GHaw+ZdTdCawrmgzNVCdknqRb7M8rmNjfxurqk1LIoh2WVA==","shasum":"d110e8a39e00e83f8279c0340883b35ea2d05a83","tarball":"https://registry.npmjs.org/@action-validator/core/-/core-0.5.0.tgz","fileCount":6,"unpackedSize":2494415,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHXqDpnHIONH/Or8Ptm9KaaywvXP7SHOv1I5DwbzWiu4AiA/alH37VpETNIn8qDUzo7/M5WPLTB77n2jA+miD5sGWA=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkB840ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpfTw//ddr2+jg2+bUN5WYjyuiiBMvlWAAZa8D7RBRYOA4YYIIcZHgA\r\nQVsSy6VrtFqMxeGo82KOIH67k4jTXtmEx6Re1SFOnHED541D+Xv3oem7TFIe\r\nq4pMvABXWakjToA2+gO/Z9t/JmarOujd8mJhA5sbXqj0t6pJTD1r7Fa31q7B\r\nZfaPpsjLb2n9BXF0CEdbQqD7BJV5Uv4wdEUfWj/cx1pQVWYd0u+YMwxygAF5\r\n3wVjjoKF7iIT+Q43o7usBmCvgpSBNYr1POp8N8QHaqR2K6SKzrmSFlcZ0KDQ\r\n7UdfwfmCJmlv/4aJQwVd5cNc2EPC2zejr67MWG0TfDaM6E42CGEGW0wqOP+1\r\nEXqoioMLJQLZHBK0/SjxtRyV+/eB0wcfmHXdQaDLwvjBguJfyt/hg2tErImd\r\nDRxxRTMfeUVkqxEqqtGjcYFdeAapJR0pXPJavQHOt5x3Fdd8oaYNJniju0OE\r\nfoVzM3YG58FkApcaKlZ2oemLlYLnttwp0ihKTdXRk67j1Myi+nl+aFFy+UMn\r\nJ8zc9YMi0JjLrYFDHoCIxDNOO+2CsurqHdSaGVq158Z8zqaD3bmVsQQTlAWv\r\nLpn5MhvxmtjZ/mGrxoKVUJ/qLZuQGIeVxRwgPd0hE+glBhQwTURiSTIOikBL\r\nigLK5KXbPbIiK8m8kHsHp76V7QFvdf61XwI=\r\n=EzMw\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"deterministicusername","email":"mp+npmjs@hezmatt.org"},"directories":{},"maintainers":[{"name":"deterministicusername","email":"mp+npmjs@hezmatt.org"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/core_0.5.0_1678233140662_0.21618758370239144"},"_hasShrinkwrap":false},"0.5.1":{"name":"@action-validator/core","collaborators":["Matt Palmer ","Ben Heidemann "],"description":"Validator for GitHub action and workflow YAML files","version":"0.5.1","license":"GPL-3.0-only","repository":{"type":"git","url":"git+https://github.com/mpalmer/action-validator.git"},"main":"action_validator.js","homepage":"https://github.com/mpalmer/action-validator","types":"action_validator.d.ts","scripts":{"build":"npx wasm-pack build --out-dir target/wasm-pack/build --no-typescript --target nodejs --features js && cp target/wasm-pack/build/action_validator_bg.wasm dist/ && cp target/wasm-pack/build/action_validator.js dist/ && cp target/wasm-pack/build/action_validator.js dist/","test":"node test/run.mjs","lint":"prettier --check .","format":"prettier --write ."},"gitHead":"d65ec569191c508a75c89275397be741e2f81706","bugs":{"url":"https://github.com/mpalmer/action-validator/issues"},"_id":"@action-validator/core@0.5.1","_nodeVersion":"18.14.2","_npmVersion":"9.5.0","dist":{"integrity":"sha512-NFCME2vkFYXQAftJS+5V7jMfop2OZCmWBKX76WucQwccts+Qfyq8+Z/MC8d28S34k9aIDsN6Y2IUOJd9Ssu1Jg==","shasum":"7189ffe50a6db7e73f4ca5274485396684b0e7f1","tarball":"https://registry.npmjs.org/@action-validator/core/-/core-0.5.1.tgz","fileCount":6,"unpackedSize":2488549,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBEhAgP3YiJ3/VbAPB0s7GDoND4NuW4t+Xr0x0cnfAvaAiEA4WaZf7Rhk+2jzhv+tr03WdtbGqznPNEAw3NMjznGZK8="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkCmscACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqUpA/9HjYwcWOhCOGJhdF60Gi4S5oSVBJP29/xGAJlURpuG2zMyRmk\r\neVIVPpPdw43+Ue2IZLf5jiWG260sp3GGxbxVnoxg4LJ20axz27SX6ARlob8s\r\ni4eN459M0wEbAhidtSephCz8xVlv/zqMUsOrYwBtD4xvSeMeCFqs1C7xIgCF\r\nPURwlYlM/T8C4GJV8X3d3kvEY+r/ewMxqMNlySIlKpCVyRtzImeRmofh5IwK\r\nX0fUw/OPiuJvUCF39Bi/9vUHWBF+8siOFQifUL0dwpCWGJL7x0lmMAB/Sura\r\n31UICQ8nbqbedxqTO1sesJYWtiy8yiWjLq8M/pRjiD+Dmw3J/ydYgELFSfY3\r\nG3mu6tRGt4MgEvc3TDMzpONS3I73LpHZG3fuTWHVLNmjRAtMdoVh2OlmiBso\r\nwSEQ8evQzpiVyKFg0wBrVIROMq7E/IpCBN49YlWybOsQ5u85a5L5S7kE5aag\r\n3zCIGRIMYEADCw1/z35fpWzWPazaStBJlkzSTByGE/JPAWKol9jqozTyhmbE\r\nM0dlLaRKylcuSBpmcqdv68rnAxUUipm/edJ471t9pgo16R8h3nfzu0Zrp39f\r\nkOVFv05CngmB3CuZUgsv2yVPcZIoz8gwpxPQuhcTJekN3s9dzP7k5pjJIUl8\r\neDG/PtAi4Xl/KIbfZNVQ+PAl6HFWr4g3/T0=\r\n=aH4w\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"deterministicusername","email":"mp+npmjs@hezmatt.org"},"directories":{},"maintainers":[{"name":"deterministicusername","email":"mp+npmjs@hezmatt.org"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/core_0.5.1_1678404379743_0.1873864902166813"},"_hasShrinkwrap":false},"0.5.2":{"name":"@action-validator/core","collaborators":["Matt Palmer ","Ben Heidemann "],"description":"Validator for GitHub action and workflow YAML files","version":"0.5.2","license":"GPL-3.0-only","repository":{"type":"git","url":"git+https://github.com/mpalmer/action-validator.git"},"main":"action_validator.js","homepage":"https://github.com/mpalmer/action-validator","types":"action_validator.d.ts","scripts":{"build":"npx wasm-pack build --out-dir target/wasm-pack/build --no-typescript --target nodejs --features js && cp target/wasm-pack/build/action_validator_bg.wasm dist/ && cp target/wasm-pack/build/action_validator.js dist/ && cp target/wasm-pack/build/action_validator.js dist/","test":"node test/run.mjs","lint":"prettier --check .","format":"prettier --write ."},"gitHead":"ab8b6bb1699d78dea9fbd547dade318ddff5f23e","bugs":{"url":"https://github.com/mpalmer/action-validator/issues"},"_id":"@action-validator/core@0.5.2","_nodeVersion":"18.16.1","_npmVersion":"9.5.1","dist":{"integrity":"sha512-kR81kFFj33ZvPaTcbcWCqRAKiFgLQX/ahXLiyoHzjOL6OFb2Uu8JUF0pMIubylBvPmrzD4maGEAeiCZl2cmsUw==","shasum":"9f7fa51470615393c135710c2fa4f0d70ba10f89","tarball":"https://registry.npmjs.org/@action-validator/core/-/core-0.5.2.tgz","fileCount":6,"unpackedSize":2551735,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCca/ymMbhy8C49GGwKOE8AfEAHga9on7Z8W/pXNpLE4AIgdKST4OGu0vSrxmoDb+kVk4kj85F40fYUFiWWebjkcy8="}]},"_npmUser":{"name":"deterministicusername","email":"mp+npmjs@hezmatt.org"},"directories":{},"maintainers":[{"name":"deterministicusername","email":"mp+npmjs@hezmatt.org"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/core_0.5.2_1688098864343_0.04327836294815568"},"_hasShrinkwrap":false},"0.5.3":{"name":"@action-validator/core","collaborators":["Matt Palmer ","Ben Heidemann "],"description":"Validator for GitHub action and workflow YAML files","version":"0.5.3","license":"GPL-3.0-only","repository":{"type":"git","url":"git+https://github.com/mpalmer/action-validator.git"},"main":"action_validator.js","homepage":"https://github.com/mpalmer/action-validator","types":"action_validator.d.ts","scripts":{"build":"npx wasm-pack build --out-dir target/wasm-pack/build --no-typescript --target nodejs --features js && cp target/wasm-pack/build/action_validator_bg.wasm dist/ && cp target/wasm-pack/build/action_validator.js dist/ && cp target/wasm-pack/build/action_validator.js dist/","test":"node test/run.mjs","lint":"prettier --check .","format":"prettier --write ."},"gitHead":"135c35f2426e24553a4a024b52a2ebea2c8bdda9","bugs":{"url":"https://github.com/mpalmer/action-validator/issues"},"_id":"@action-validator/core@0.5.3","_nodeVersion":"18.16.1","_npmVersion":"9.5.1","dist":{"integrity":"sha512-0ABelaY7nmpvV5q0z8Vl1cDeq2OZ1HyNXjXS54fBadLaCssZLbDvTa7M2uUaNMcEWV+Xl48WWbnqJWKePt9qHQ==","shasum":"493b850ef7a2801830069d78f60cbefe0697423f","tarball":"https://registry.npmjs.org/@action-validator/core/-/core-0.5.3.tgz","fileCount":6,"unpackedSize":2555045,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDpo4gH/lKy+aA1ECHeqe/PlKCTJa24TWHqBSfgPlZqPgIgbTJwK4XTZU6Cp1NKvtcQ2aEPXbtfM9Z9+Bi6JGWkM4g="}]},"_npmUser":{"name":"deterministicusername","email":"mp+npmjs@hezmatt.org"},"directories":{},"maintainers":[{"name":"deterministicusername","email":"mp+npmjs@hezmatt.org"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/core_0.5.3_1689049105487_0.502037547849234"},"_hasShrinkwrap":false},"0.5.4":{"name":"@action-validator/core","collaborators":["Matt Palmer ","Ben Heidemann "],"description":"Validator for GitHub action and workflow YAML files","version":"0.5.4","license":"GPL-3.0-only","repository":{"type":"git","url":"git+https://github.com/mpalmer/action-validator.git"},"main":"action_validator.js","homepage":"https://github.com/mpalmer/action-validator","types":"action_validator.d.ts","scripts":{"build":"npx wasm-pack build --out-dir target/wasm-pack/build --no-typescript --target nodejs --features js && cp target/wasm-pack/build/action_validator_bg.wasm dist/ && cp target/wasm-pack/build/action_validator.js dist/ && cp target/wasm-pack/build/action_validator.js dist/","test":"node test/run.mjs","lint":"prettier --check .","format":"prettier --write ."},"_id":"@action-validator/core@0.5.4","gitHead":"d954e0d6f381483fec22ff29c082f8bba12906bb","bugs":{"url":"https://github.com/mpalmer/action-validator/issues"},"_nodeVersion":"18.18.2","_npmVersion":"9.8.1","dist":{"integrity":"sha512-uODXaU5sJw9CilmjVG9IUpc1ENivixQI7+DtebWgG80PMQBfZ/4b5PKXJ5ESJVlvafrHcuIjN0qou99zN2bDtw==","shasum":"160a6d9ac8919a1eed0a0b0a7780b82ef03686fe","tarball":"https://registry.npmjs.org/@action-validator/core/-/core-0.5.4.tgz","fileCount":6,"unpackedSize":2553332,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGeXPKs9dU/g+5+FL8PB1cy+1VShP5dMNIUf05kSH+gZAiAx0ZMXK4e6dLRmMcPFfl8Y+xaBGHs20xVeWOlgXdSZRQ=="}]},"_npmUser":{"name":"deterministicusername","email":"mp+npmjs@hezmatt.org"},"directories":{},"maintainers":[{"name":"deterministicusername","email":"mp+npmjs@hezmatt.org"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/core_0.5.4_1700859250030_0.1038079962719638"},"_hasShrinkwrap":false},"0.6.0":{"name":"@action-validator/core","collaborators":["Matt Palmer ","Ben Heidemann "],"description":"Validator for GitHub action and workflow YAML files","version":"0.6.0","license":"GPL-3.0-only","repository":{"type":"git","url":"git+https://github.com/mpalmer/action-validator.git"},"main":"action_validator.js","homepage":"https://github.com/mpalmer/action-validator","types":"action_validator.d.ts","scripts":{"build":"npx wasm-pack build --out-dir target/wasm-pack/build --no-typescript --target nodejs --features js && cp target/wasm-pack/build/action_validator_bg.wasm dist/ && cp target/wasm-pack/build/action_validator.js dist/ && cp target/wasm-pack/build/action_validator.js dist/","test":"node test/run.mjs","lint":"prettier --check .","format":"prettier --write ."},"_id":"@action-validator/core@0.6.0","gitHead":"d064028881d71988f1fe4b0fd372e01a805458a7","bugs":{"url":"https://github.com/mpalmer/action-validator/issues"},"_nodeVersion":"18.19.1","_npmVersion":"10.2.4","dist":{"integrity":"sha512-tPglwCr8Mm8SWzwnVewwFmqRx91F0WvMsM0BRAqH4CLalyGndm53Xvp+UcUSzswpk1wkjIDYI7RyEhWMLyPkig==","shasum":"8fbaf45562a5377140815b79cc1ac9f610ff63e5","tarball":"https://registry.npmjs.org/@action-validator/core/-/core-0.6.0.tgz","fileCount":6,"unpackedSize":2599906,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCID851ujPYkEQaPin8sF8XuPY/phguePyOkL6lU1TDjEbAiEAwKmkWXfgLs6DXGhGme4AP5AURXiqpCf7VqIXxVOL3W8="}]},"_npmUser":{"name":"deterministicusername","email":"mp+npmjs@hezmatt.org"},"directories":{},"maintainers":[{"name":"deterministicusername","email":"mp+npmjs@hezmatt.org"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/core_0.6.0_1708667604550_0.05905558857824866"},"_hasShrinkwrap":false}},"time":{"created":"2023-03-03T05:40:02.672Z","0.4.0":"2023-03-03T05:40:02.964Z","modified":"2024-02-23T05:53:25.643Z","0.5.0":"2023-03-07T23:52:20.869Z","0.5.1":"2023-03-09T23:26:19.990Z","0.5.2":"2023-06-30T04:21:04.605Z","0.5.3":"2023-07-11T04:18:25.779Z","0.5.4":"2023-11-24T20:54:10.291Z","0.6.0":"2024-02-23T05:53:24.798Z"},"maintainers":[{"name":"deterministicusername","email":"mp+npmjs@hezmatt.org"}],"description":"Validator for GitHub action and workflow YAML files","homepage":"https://github.com/mpalmer/action-validator","repository":{"type":"git","url":"git+https://github.com/mpalmer/action-validator.git"},"bugs":{"url":"https://github.com/mpalmer/action-validator/issues"},"license":"GPL-3.0-only","readme":"The `action-validator` is a standalone tool designed to \"lint\" the YAML files\nused to define GitHub Actions and Workflows. It ensures that they are well-formed,\nby checking them against published JSON schemas, and it makes sure that any\nglobs used in `paths` / `paths-ignore` match at least one file in the repo.\n\nThe intended use case for `action-validator` is in Git pre-commit hooks and\nsimilar situations.\n\n\n# Installation\n\nWe have many ways to install `action-validator`.\n\n## Pre-built binaries\n\nThe [GitHub releases](https://github.com/mpalmer/action-validator/releases)\nhave some pre-built binaries -- just download and put them in your path. If a\nbinary for your platform isn't available, let me know and I'll see what I can\nfigure out.\n\n\n## Using cargo\n\nIf you've got a Rust toolchain installed, running `cargo install action-validator` should give you the latest release.\n\n\n## Using asdf\n\nIf you're a proponent of the [asdf tool](https://asdf-vm.com/), then you can\nuse that to install and manage `action-validator`:\n\n```shell\nasdf plugin add action-validator\n# or\nasdf plugin add action-validator https://github.com/mpalmer/action-validator.git\n```\n\nInstall/configure action-validator:\n\n```shell\n# Show all installable versions\nasdf list-all action-validator\n\n# Install specific version\nasdf install action-validator latest\n\n# Set a version globally (on your ~/.tool-versions file)\nasdf global action-validator latest\n\n# Now action-validator commands are available\naction-validator --help\n```\n\n## Using NPM\n\nNode users can install the latest version using NPM:\n\n> ℹ️ The `@action-validator/core` package can be used directly within Node.js applications.\n\n```sh\nnpm install -g @action-validator/core @action-validator/cli --save-dev\n```\n\n## Building from the repo\n\nIf you want to build locally, you'll need to:\n\n1. Checkout the git repository somewhere;\n\n1. Grab the `SchemaStore` submodule, by running `git submodule init && git submodule update`;\n\n1. Install a [Rust](https://rust-lang.org) toolchain; and then\n\n1. run `cargo build`.\n\n\n# Usage\n\nCouldn't be simpler: just pass a file to the program:\n\n```shell\naction-validator .github/workflows/build.yml\n```\n\nUse `action-validator -h` to see additional options.\n\n> ### CAUTION\n>\n> As the intended use-case for `action-validator` is in pre-commit hooks,\n> it assumes that it is being run from the root of the repository. Glob\n> checking will explode horribly if you run it from a sub-directory of the\n> repo -- or, heaven forfend, outside the repository entirely.\n\n\n## In a GitHub Action\n\nThe action-validator can be run in a Github action itself, as a pull request job. See the `actions` job in the [QA workflow](https://github.com/mpalmer/action-validator/tree/main/.github/workflows/qa.yml), in this repository, as an example of how to use action-validator + asdf in a GitHub workflow.\nThis may seem a little redundant (after all, an action has to be valid in order for GitHub to run it), but this job will make sure that all your *other* actions are also valid.\n\n## Using pre-commit\n\nUpdate your .pre-commit-config.yaml:\n\n```\nrepos:\n- repo: https://github.com/mpalmer/action-validator\n rev: v0.5.1\n hooks:\n - id: action-validator\n```\n\n## Pre-commit hook example\n\nCreate an executable file in the .git/hooks directory of the target repository:\n`touch .git/hooks/pre-commit && chmod +x .git/hooks/pre-commit` and paste the following example code:\n\n```bash\n#!/bin/bash\nif ! command -v action-validator >/dev/null; then\n echo \"action-validator is not installed.\"\n echo \"Installation instructions: https://github.com/mpalmer/action-validator\"\n exit 1\nfi\necho \"Running pre-commit hook for GitHub Actions: https://github.com/mpalmer/action-validator\"\nscan_count=0\nfor action in $(git diff --cached --name-only --diff-filter=ACM | grep -E '^\\.github/(workflows|actions)/.*\\.ya?ml$'); do\n if action-validator \"$action\"; then\n echo \"✅ $action\"\n else\n echo \"❌ $action\"\n exit 1\n fi\n scan_count=$((scan_count+1))\ndone\necho \"action-validator scanned $scan_count GitHub Actions and found no errors!\"\n```\n\nThis script will run on every commit to the target repository, whether the github action yaml files are being committed, or not and prevent any commit if there are linting errors.\n\n```\n# All action-validator linting errors must be resolved before any commit will succeed.\n$ echo \"\" >> README.md && git add README.md && git commit -m \"Update read-me\"\nRunning pre-commit hook for GitHub Actions: https://github.com/mpalmer/action-validator\nValidation failed: ValidationState {\n errors: [\n Properties {\n path: \"\",\n detail: \"Additional property 'aname' is not allowed\",\n },\n ],\n missing: [],\n replacement: None,\n}\n❌ .github/workflows/ci.yaml\nFatal error validating .github/workflows/ci.yaml: validation failed\n\n\n# Fix error and try again\n$ echo \"\" >> README.md && git add README.md && git commit -m \"Update read-me\"\nRunning pre-commit hook for GitHub Actions: https://github.com/mpalmer/action-validator\n✅ .github/workflows/ci.yaml\n✅ .github/workflows/release.yml\naction-validator scanned 2 GitHub Actions found no errors!\n[main c34fda3] Update read-me\n 1 file changed, 2 insertions(+)\n```\n\n## NPM\n\nProvided you have followed the [installation instructions for NPM](#using-npm), you can run the action\nvalidator CLI as follows\n\n```sh\nnpx action-validator \n```\n\nOr, if you've installed the package globally:\n\n```sh\naction-validator \n```\n\n## Node API\n\nThe Node API can be used to validate action and workflow files from Node.js as follows:\n\n> ⚠️ The Node API does not currently support glob validation.\n\n```ts\nimport { readFileSync } from \"fs\";\nimport { validateAction, validateWorkflow } from \"@action-validator/core\";\n\n// Validate Action\nconst actionSource = readFileSync(\"action.yml\", \"utf8\");\nconst state = validator.validateAction(actionSource);\nconst isValid = state.errors.length === 0;\n\n// Validate Workflow\nconst workflowSource = readFileSync(\"workflow.yml\", \"utf8\");\nconst state = validator.validateWorkflow(workflowSource);\nconst isValid = state.errors.length === 0;\n```\n\n# Contributing\n\nPlease see [CONTRIBUTING.md](CONTRIBUTING.md).\n\n\n# Licence\n\nUnless otherwise stated, everything in this repo is covered by the following\ncopyright notice:\n\n Copyright (C) 2021 Matt Palmer \n\n This program is free software: you can redistribute it and/or modify it\n under the terms of the GNU General Public License version 3, as\n published by the Free Software Foundation.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU General Public License for more details.\n\n You should have received a copy of the GNU General Public License\n along with this program. If not, see .\n","readmeFilename":"README.md"}