https://github.com/mangs/simple-release-notes-action
GitHub Action that auto-publishes release notes using a very simple-to-follow set of rules
https://github.com/mangs/simple-release-notes-action
github github-action release-notes releases simple
Last synced: 6 months ago
JSON representation
GitHub Action that auto-publishes release notes using a very simple-to-follow set of rules
- Host: GitHub
- URL: https://github.com/mangs/simple-release-notes-action
- Owner: mangs
- License: mit
- Created: 2022-03-20T19:28:40.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-14T16:04:56.000Z (about 2 years ago)
- Last Synced: 2024-04-18T14:12:02.401Z (about 2 years ago)
- Topics: github, github-action, release-notes, releases, simple
- Language: JavaScript
- Homepage:
- Size: 722 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# `mangs/simple-release-notes-action`
GitHub Action that auto-publishes release notes using a very simple-to-follow set of rules
## Example Use
```yaml
- uses: mangs/simple-release-notes-action@v2
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
```
## Rules for Use
As its name implies, this action is intended to be easy to use. Here are the rules to follow for using this action:
- When this action runs, the target version number is found in the `version` field in your `package.json`
- Your changelog must be structured into version number "sections" as follows (use [this repository's changelog](./CHANGELOG.md) as an example)
- Version numbers must always be found at the same depth (e.g. always at `### ` or depth of 3)
- Version number "section" ordering doesn't matter
```markdown
#
## (May 30, 2077)
## v The Big Release
etc...
```
- A new GitHub release will be created automatically as follows:
- Title will be the full text of the heading containing the target version number (a.k.a. the `version` field in your `package.json`)
- Description will be the matched "section" of markdown
- Tag will be either (1) the combination of the `tag_prefix` and target version number or (2) the `tag_override` value
- 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)
## Action Inputs
| Name | Required | Default Value | Descripition |
| ------------------------------ | -------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `changelog_path` | N | `"./CHANGELOG.md"` | Path to the target changelog file |
| `github_token` | Y | N/A | GitHub authentication token used to authenticate on behalf of GitHub Actions |
| `packagejson_path` | N | `"./package.json"` | Path to the target `package.json` file |
| `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. |
| `tag_override` | N | `undefined` | String to enforce an exact tag version; overrides default behavior |
| `tag_prefix` | N | `"v"` | Prefix to create a tag by combining this and the target version number; this is default behavior |