{"id":15762480,"url":"https://github.com/mangs/simple-release-notes-action","last_synced_at":"2026-01-08T21:37:17.072Z","repository":{"id":36976736,"uuid":"472081779","full_name":"mangs/simple-release-notes-action","owner":"mangs","description":"GitHub Action that auto-publishes release notes using a very simple-to-follow set of rules","archived":false,"fork":false,"pushed_at":"2024-04-14T16:04:56.000Z","size":739,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-04-18T14:12:02.401Z","etag":null,"topics":["github","github-action","release-notes","releases","simple"],"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/mangs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-03-20T19:28:40.000Z","updated_at":"2024-04-22T04:39:30.379Z","dependencies_parsed_at":"2024-03-29T22:24:48.542Z","dependency_job_id":"310a7107-deec-443d-bd79-3c7eca9945c0","html_url":"https://github.com/mangs/simple-release-notes-action","commit_stats":{"total_commits":37,"total_committers":3,"mean_commits":"12.333333333333334","dds":0.3783783783783784,"last_synced_commit":"af67532bb9d36ae104f1b413826ea08abc27a141"},"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mangs%2Fsimple-release-notes-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mangs%2Fsimple-release-notes-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mangs%2Fsimple-release-notes-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mangs%2Fsimple-release-notes-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mangs","download_url":"https://codeload.github.com/mangs/simple-release-notes-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246450425,"owners_count":20779406,"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","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":["github","github-action","release-notes","releases","simple"],"created_at":"2024-10-04T11:09:21.763Z","updated_at":"2026-01-08T21:37:17.043Z","avatar_url":"https://github.com/mangs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `mangs/simple-release-notes-action`\n\nGitHub Action that auto-publishes release notes using a very simple-to-follow set of rules\n\n## Example Use\n\n```yaml\n- uses: mangs/simple-release-notes-action@v2\n  with:\n    github_token: ${{ secrets.GITHUB_TOKEN }}\n```\n\n## Rules for Use\n\nAs its name implies, this action is intended to be easy to use. Here are the rules to follow for using this action:\n\n- When this action runs, the target version number is found in the `version` field in your `package.json`\n- Your changelog must be structured into version number \"sections\" as follows (use [this repository's changelog](./CHANGELOG.md) as an example)\n  - Version numbers must always be found at the same depth (e.g. always at `### \u003cversion\u003e` or depth of 3)\n  - Version number \"section\" ordering doesn't matter\n\n```markdown\n# \u003cchangelog title\u003e\n\n## \u003cversion number\u003e (May 30, 2077)\n\n\u003cany markdown can go here\u003e\n\n## v\u003canother version number\u003e The Big Release\n\n\u003cany markdown can go here\u003e\n\netc...\n```\n\n- A new GitHub release will be created automatically as follows:\n  - Title will be the full text of the heading containing the target version number (a.k.a. the `version` field in your `package.json`)\n  - Description will be the matched \"section\" of markdown\n  - Tag will be either (1) the combination of the `tag_prefix` and target version number or (2) the `tag_override` value\n- Use with a [Linux runner](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources) which is the default (this action was not tested with macOS or Windows runners, but it may function just fine)\n\n## Action Inputs\n\n| Name                           | Required | Default Value      | Descripition                                                                                                                                                                                                |\n| ------------------------------ | -------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `changelog_path`               | N        | `\"./CHANGELOG.md\"` | Path to the target changelog file                                                                                                                                                                           |\n| `github_token`                 | Y        | N/A                | GitHub authentication token used to authenticate on behalf of GitHub Actions                                                                                                                                |\n| `packagejson_path`             | N        | `\"./package.json\"` | Path to the target `package.json` file                                                                                                                                                                      |\n| `should_auto_update_major_tag` | N        | `true`             | Auto-update the major tag version of your repository when a new release gets published or create it if it doesn't exist. For example, when publishing version 2.3.4, major tag v2 will get updated to HEAD. |\n| `tag_override`                 | N        | `undefined`        | String to enforce an exact tag version; overrides default behavior                                                                                                                                          |\n| `tag_prefix`                   | N        | `\"v\"`              | Prefix to create a tag by combining this and the target version number; this is default behavior                                                                                                            |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmangs%2Fsimple-release-notes-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmangs%2Fsimple-release-notes-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmangs%2Fsimple-release-notes-action/lists"}