{"id":13602440,"url":"https://github.com/mindsers/changelog-reader-action","last_synced_at":"2025-10-10T12:33:57.107Z","repository":{"id":37731237,"uuid":"239882574","full_name":"mindsers/changelog-reader-action","owner":"mindsers","description":"A GitHub action to read and get data from the CHANGELOG.md file 🚀","archived":false,"fork":false,"pushed_at":"2024-07-05T20:24:12.000Z","size":648,"stargazers_count":101,"open_issues_count":6,"forks_count":45,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-29T15:41:44.830Z","etag":null,"topics":["actions","changelog","github","github-actions","hacktoberfest","workflow"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/mindsers.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["mindsers"],"patreon":null,"open_collective":null,"ko_fi":"mindsers","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":"mindsers","otechie":null,"custom":null}},"created_at":"2020-02-11T23:02:10.000Z","updated_at":"2025-05-09T15:20:31.000Z","dependencies_parsed_at":"2024-03-29T07:29:37.412Z","dependency_job_id":"b6228fb0-6c26-4e5f-9afb-a97655a9e7c3","html_url":"https://github.com/mindsers/changelog-reader-action","commit_stats":{"total_commits":183,"total_committers":12,"mean_commits":15.25,"dds":0.5027322404371585,"last_synced_commit":"d8f4048265c49bd76854ce1faa024467ca39bd7e"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":"actions/javascript-action","purl":"pkg:github/mindsers/changelog-reader-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mindsers%2Fchangelog-reader-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mindsers%2Fchangelog-reader-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mindsers%2Fchangelog-reader-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mindsers%2Fchangelog-reader-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mindsers","download_url":"https://codeload.github.com/mindsers/changelog-reader-action/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mindsers%2Fchangelog-reader-action/sbom","scorecard":{"id":647891,"data":{"date":"2025-08-11","repo":{"name":"github.com/mindsers/changelog-reader-action","commit":"39589207653b9478298e17e63464e8953afcc98a"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.7,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 1 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":"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":"Code-Review","score":1,"reason":"Found 2/14 approved changesets -- score normalized to 1","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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/test.yml:1","Info: no jobLevel write permissions found"],"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":"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":"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":3,"reason":"dependency not pinned by hash detected -- score normalized to 3","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/mindsers/changelog-reader-action/test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/mindsers/changelog-reader-action/test.yml/master?enable=pin","Info:   0 out of   2 GitHub-owned 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 19 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":6,"reason":"4 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv"],"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-21T12:38:41.122Z","repository_id":37731237,"created_at":"2025-08-21T12:38:41.122Z","updated_at":"2025-08-21T12:38:41.122Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279003897,"owners_count":26083641,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"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":["actions","changelog","github","github-actions","hacktoberfest","workflow"],"created_at":"2024-08-01T18:01:23.340Z","updated_at":"2025-10-10T12:33:57.078Z","avatar_url":"https://github.com/mindsers.png","language":"JavaScript","funding_links":["https://github.com/sponsors/mindsers","https://ko-fi.com/mindsers","https://issuehunt.io/r/mindsers"],"categories":["JavaScript"],"sub_categories":[],"readme":"# Changelog Reader\n\n\u003ca href=\"https://github.com/mindsers/changelog-reader-action\"\u003e\u003cimg alt=\"changelog-reader-action status\" src=\"https://github.com/mindsers/changelog-reader-action/workflows/units-test/badge.svg\"\u003e\u003c/a\u003e\n\nA GitHub action to read and get data from the `CHANGELOG.md` file :rocket:\n\n**This action only works if your `CHANGELOG.md` file follows the [_Keep a Changelog_](https://github.com/olivierlacan/keep-a-changelog) standard for now.**\n\n## Usage\n\n### Pre-requisites\n\nCreate a workflow `.yml` file in your repositories `.github/workflows` directory. An [example workflow](#example-workflow---upload-a-release-asset) is available below. For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).\n\n### Inputs\n\n- `path`: The path the action can find the CHANGELOG. Optional. Defaults to `./CHANGELOG.md`.\n- `version`: The [exact version](https://semver.org) of the log entry you want to retreive or \"Unreleased\" for the unreleased entry. Optional. Defaults to the last version number.\n- `validation_level`: Specifies at which level the validation system is set. Can be 'none', 'warn', 'error'. Optional. Defaults to `none`.\n- `validation_depth`: Specifies how many entries to validate in the CHANGELOG.md file. Optional. Defaults to `10`.\n\n### Outputs\n\n- `version`: Version of the log entry found. Ex: `2.0.0`.\n- `date`: Release date of the log entry found. Ex: `2020-08-22`.\n- `status`: Status of the log entry found (`prereleased`, `released`, `unreleased`, or `yanked`).\n- `changes`: Description text of the log entry found.\n\n### Validation / Linting\n\nA validation engine is available in _Changelog Reader_. It is by default disabled but can be enabled by setting `validation_level` to 'warn' or 'error'.\n\nThe validation engine will enforce [Semantic Versioning 2.0.0](https://semver.org/) standards as well as [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) standards and formatting. **If your project doesn't follow Semantic Versioning 2.0.0 or Keep a Changelog, do not enable the validation engine.** It might break your build unnecessarily.\n\nYou can utilize the `validation_depth` input param to specify how many entries to validate. Changelog Reader will by default validates only the last 10 changelog entries.\n\nWhen `validation_level` is set at 'warn', Changelog Reader will print check results as warnings in your logs without breaking your build.\nWhen `validation_level` is set at 'error', Changelog Reader will print check results as errors in your logs and will throw an error to prevent the build to go further.\n\n### Example workflow - create a release from changelog\n\nOn every `push` to a tag matching the pattern `v*`, [create a release](https://developer.github.com/v3/repos/releases/#create-a-release) using the CHANGELOG.md content.\nThis Workflow example assumes you'll use the [`@actions/create-release`](https://www.github.com/actions/create-release) Action to create the release step:\n\n```yaml\non:\n  push:\n    # Sequence of patterns matched against refs/tags\n    tags:\n      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10\n\nname: Create Release\n\njobs:\n  build:\n    name: Create Release\n    runs-on: ubuntu-latest\n    steps:\n      - name: Get version from tag\n        id: tag_name\n        run: |\n          echo \"current_version=${GITHUB_REF#refs/tags/v}\" \u003e\u003e $GITHUB_OUTPUT\n        shell: bash\n      - name: Checkout code\n        uses: actions/checkout@v2\n      - name: Get Changelog Entry\n        id: changelog_reader\n        uses: mindsers/changelog-reader-action@v2\n        with:\n          validation_level: warn\n          version: ${{ steps.tag_name.outputs.current_version }}\n          path: ./CHANGELOG.md\n      - name: Create/update release\n        uses: ncipollo/release-action@v1\n        with:\n          # This pulls from the \"Get Changelog Entry\" step above, referencing it's ID to get its outputs object.\n          # See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps\n          tag: ${{ steps.changelog_reader.outputs.version }}\n          name: Release ${{ steps.changelog_reader.outputs.version }}\n          body: ${{ steps.changelog_reader.outputs.changes }}\n          prerelease: ${{ steps.changelog_reader.outputs.status == 'prereleased' }}\n          draft: ${{ steps.changelog_reader.outputs.status == 'unreleased' }}\n          allowUpdates: true\n          token: ${{ secrets.GITHUB_TOKEN }}\n```\n\n## Contribution\n\nContributions to the source code of _Changelog Reader Action_ are welcomed and greatly appreciated.\nFor help on how to contribute in this project, please refer to [How to contribute to Changelog Reader Action](CONTRIBUTING.md).\n\nTo see the project's list of **awesome contributors**, please refer to our [Contributors Wall](CONTRIBUTORS.md).\n\n## Support\n\n_Changelog Reader Action_ is licensed under an MIT license, which means that it's a completely free open source software. Unfortunately, _Changelog Reader Action_ doesn't make itself. Version 2.0.0 is the next step, which will result in many late, beer-filled nights of development.\n\nIf you're using _Changelog Reader Action_ and want to support the development, you now have the chance! Go on my [GitHub Sponsor page](https://github.com/sponsors/mindsers) and become my joyful sponsor!!\n\nFor more help on how to support Changelog Reader Action, please refer to [The awesome people who support Changelog Reader Action](SPONSORS.md).\n\n\u003c!-- ### Premium sponsors --\u003e\n\n## License\n\nThe scripts and documentation in this project are released under the [MIT License](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmindsers%2Fchangelog-reader-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmindsers%2Fchangelog-reader-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmindsers%2Fchangelog-reader-action/lists"}