tiangolo/Tiangolo's Latest Changes
Update the release notes with the "latest changes" right after a PR is merged.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| token | Token for the repo. Can be passed in using {{ secrets.GITHUB_TOKEN }}. | yes | — |
| number | Optional PR number to call this GitHub Action manually in a workflow. | no | — |
| latest_changes_file | The file to add the latest changes. | no | README.md |
| latest_changes_header | Header to search for in the latest changes file, this action will add the changes right after that string. | no | ### Latest Changes |
| template_file | To override the default message with a custom Jinja2 template, use a path relative to the repo. | no | /app/latest_changes/latest-changes.jinja2 |
| end_regex | A RegEx string that marks the end of this release, so it normally matches the start of the header of the next release section, normally the same header level as `latest_changes_header`, so, if the `latest_changes_header` is `### Latest Changes`, the content for the next release below is probably something like `### 0.2.0`, then the `end_regex` should be `^### `. By default it is `(^### .*)|(^## .*)` to detect a possible next header, e.g. for the license. | no | (^### .*)|(^## .*) |
| debug_logs | Use debug=True to enable more logging, useful to see the object shape for custom Jinja2 templates | no | false |
| labels | A JSON array of JSON objects that contain a key `label` with the label you would add to each PR, and a key `header` with the header text that should be added to the release notes for that label. The order is important, the first label from the list that is found in your PR is the one that will be used. So, if you have a PR that has both labels `feature` and `bug`, if you use the default configuration, it will show up in the section for features, if you want it to show up in the section for bugs you would need to change the order of the list of this configuration to have `bug` first. Note that this JSON has to be passed as a string because that's the only thing that GitHub Actions support for configurations. | no | [ {"label": "breaking", "header": "Breaking Changes"}, {"label": "security", "header": "Security Fixes"}, {"label": "feature", "header": "Features"}, {"label": "bug", "header": "Fixes"}, {"label": "refactor", "header": "Refactors"}, {"label": "upgrade", "header": "Upgrades"}, {"label": "docs", "header": "Docs"}, {"label": "lang-all", "header": "Translations"}, {"label": "infra", "header": "Infrastructure"}, {"label": "internal", "header": "Internal"} ] |
| label_header_prefix | A prefix to put before each label's header. This is also used to detect where the next label header starts. By default it is `#### `, so the headers will look like `#### Features`. | — | #### |
| skip_labels | A JSON array of label names for PRs that should not be added to the latest changes. If a label is also configured in labels, labels takes precedence. | no | ["release"] |
Outputs
no outputs