{"id":21133353,"url":"https://github.com/purpleclay/nsv-action","last_synced_at":"2026-01-19T02:31:55.504Z","repository":{"id":177769489,"uuid":"624728789","full_name":"purpleclay/nsv-action","owner":"purpleclay","description":":octocat: GitHub action for the NSV tool","archived":false,"fork":false,"pushed_at":"2024-10-04T22:34:57.000Z","size":148,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-31T04:44:28.788Z","etag":null,"topics":["conventional-commits","git","github","github-actions","go","semver","semver-release"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/purpleclay.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-04-07T05:52:00.000Z","updated_at":"2024-09-27T01:38:44.000Z","dependencies_parsed_at":"2024-04-04T20:44:38.256Z","dependency_job_id":"ab56bb4c-15a0-44e5-8dc3-0696da0dee42","html_url":"https://github.com/purpleclay/nsv-action","commit_stats":null,"previous_names":["purpleclay/nsv-action"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/purpleclay/nsv-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/purpleclay%2Fnsv-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/purpleclay%2Fnsv-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/purpleclay%2Fnsv-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/purpleclay%2Fnsv-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/purpleclay","download_url":"https://codeload.github.com/purpleclay/nsv-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/purpleclay%2Fnsv-action/sbom","scorecard":{"id":750093,"data":{"date":"2025-08-11","repo":{"name":"github.com/purpleclay/nsv-action","commit":"f70a5b1829dac862bcec92f5835aaf240cad2fec"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/9 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: jobLevel 'contents' permission set to 'write': .github/workflows/tag.yml:29","Warn: no topLevel permission defined: .github/workflows/ci.yml:1","Warn: no topLevel permission defined: .github/workflows/tag.yml:1"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":4,"reason":"dependency not pinned by hash detected -- score normalized to 4","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/purpleclay/nsv-action/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/purpleclay/nsv-action/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tag.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/purpleclay/nsv-action/tag.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/tag.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/purpleclay/nsv-action/tag.yml/main?enable=pin","Info:   0 out of   3 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   1 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 10 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"10 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q","Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38","Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-c76h-2ccp-4975","Warn: Project is vulnerable to: GHSA-cxrh-j4jr-qwg3"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-22T20:03:54.379Z","repository_id":177769489,"created_at":"2025-08-22T20:03:54.379Z","updated_at":"2025-08-22T20:03:54.379Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28558229,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-19T00:46:33.223Z","status":"online","status_checked_at":"2026-01-19T02:00:08.049Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["conventional-commits","git","github","github-actions","go","semver","semver-release"],"created_at":"2024-11-20T06:07:13.265Z","updated_at":"2026-01-19T02:31:55.488Z","avatar_url":"https://github.com/purpleclay.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NSV Action\n\nNSV (Next Semantic Version) is a convention-based semantic versioning tool that leans on the power of conventional commits to make versioning your software a breeze!\n\nCheck out the latest [documentation](https://docs.purpleclay.dev/nsv/).\n\n## Inputs\n\n| Name        | Required | Type    | Description                                                                                              |\n| ----------- | -------- | ------- | -------------------------------------------------------------------------------------------------------- |\n| `token`     | no       | string  | A token for performing authenticated requests to the GitHub API                                          |\n| `version`   | no       | string  | The version of NSV to download (default: `latest`)                                                       |\n| `next-only` | no       | boolean | If the next semantic version should just be calculated. Repository will not be tagged (default: `false`) |\n| `projects`  | no       | string  | A comma-separated list of paths to monorepo projects                                                     |\n\n## Outputs\n\n| Name  | Type   | Description                                                                                                     |\n| ----- | ------ | --------------------------------------------------------------------------------------------------------------- |\n| `nsv` | string | The calculated next semantic version. Can be a comma-separated list if multiple monorepo projects were provided |\n\n## Environment variables\n\nYou can also define CI/CD variables within your GitLab project to configure the behavior of both [nsv](https://docs.purpleclay.dev/nsv/reference/env-vars/) and [gpg-import](https://github.com/purpleclay/gpg-import/blob/main/README.md#features). All are optional:\n\n- `NSV_FORMAT` is a Go template for formatting the generated semantic version tag.\n- `NSV_TAG_MESSAGE` is a custom message when creating an annotated tag.\n- `GPG_PRIVATE_KEY` is the base64 encoded GPG private key in armor format.\n- `GPG_PASSPHRASE` is an optional passphrase if the GPG key is password protected.\n- `GPG_TRUST_LEVEL` is an owner trust level assigned to the imported GPG key.\n\n\u003e Ensure all environment variables are wrapped within double quotes to prevent any unintentional side effects\n\n## Using the action\n\n### Tag the repository\n\nIf you wish to tag the repository without triggering another workflow, you must set the permissions of the job to `contents: write`.\n\n```yaml\nname: ci\non:\n  push:\n    branches:\n      - main\njobs:\n  ci:\n    runs-on: ubuntu-latest\n    permissions:\n      contents: write\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v3\n        with:\n          fetch-depth: 0\n\n      - name: NSV\n        uses: purpleclay/nsv-action@v1\n        env:\n          GPG_PRIVATE_KEY: '${{ secrets.GPG_PRIVATE_KEY }}'\n```\n\n#### User impersonation\n\nWhen tagging your repository, `nsv` will identify the person associated with the commit that triggered the release and pass this to git through the `user.name` and `user.email` config settings.\n\nYou can override this behavior by importing a GPG key, manually setting those git config settings, or using the reserved git environment variables `GIT_COMMITTER_NAME` and `GIT_COMMITTER_EMAIL`; see the [documentation](https://docs.purpleclay.dev/nsv/tag-version/#committer-impersonation) for further details.\n\n### Tag a monorepo project\n\nIf working with a monorepo project, the project to tag can be specified through the `projects` input:\n\n```yaml\nname: ci\non:\n  push:\n    branches:\n      - main\njobs:\n  ci:\n    runs-on: ubuntu-latest\n    permissions:\n      contents: write\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v3\n        with:\n          fetch-depth: 0\n\n      - name: NSV\n        uses: purpleclay/nsv-action@v1\n        with:\n          projects: src/project\n        env:\n          GPG_PRIVATE_KEY: '${{ secrets.GPG_PRIVATE_KEY }}'\n```\n\nMultiple monorepo projects can be tagged by providing a comma-separated list to the `projects` input.\n\n### Trigger another workflow\n\nIf you wish to trigger another workflow after `nsv` tags the repository, you must manually create a token (PAT) with the `public_repo` permission and use it during the checkout. For best security practice, use a short-lived token.\n\n```yaml\nname: ci\non:\n  push:\n    branches:\n      - main\njobs:\n  ci:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v3\n        with:\n          fetch-depth: 0\n          token: '${{ secrets.TOKEN }}'\n\n      - name: NSV\n        uses: purpleclay/nsv-action@v1\n        env:\n          GPG_PRIVATE_KEY: '${{ secrets.GPG_PRIVATE_KEY }}'\n          GPG_PASSPHRASE: '${{ secrets.GPG_PASSPHRASE }}'\n```\n\n### Capturing the next tag\n\nYou can capture the next tag without tagging the repository by setting the `next-only` input to `true`.\n\n```yaml\nname: ci\non:\n  push:\n    branches:\n      - main\njobs:\n  ci:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v3\n        with:\n          fetch-depth: 0\n\n      - name: NSV\n        id: nsv\n        uses: purpleclay/nsv-action@v1\n        with:\n          next-only: true\n\n      - name: Print Tag\n        run: |\n          echo \"Next calculated tag: ${{ steps.nsv.outputs.nsv }}\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpurpleclay%2Fnsv-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpurpleclay%2Fnsv-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpurpleclay%2Fnsv-action/lists"}