docs: configure release notes categories based on labels #2184
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 task
laughedelic
changed the title
kfcampbell
approved these changes
Mar 8, 2024
kireque
referenced
this pull request
in kireque/home-ops
Mar 22, 2024
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github](https://registry.terraform.io/providers/integrations/github) ([source](https://togithub.com/integrations/terraform-provider-github)) | required_provider | minor | `6.0.1` -> `6.2.0` | --- ### Release Notes <details> <summary>integrations/terraform-provider-github (github)</summary> ### [`v6.2.0`](https://togithub.com/integrations/terraform-provider-github/releases/tag/v6.2.0) [Compare Source](https://togithub.com/integrations/terraform-provider-github/compare/v6.1.0...v6.2.0) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed ##### Features - feat: add `github_enterprise_actions_runner_group` by [@​bradam12](https://togithub.com/bradam12) in [https://github.com/integrations/terraform-provider-github/pull/2158](https://togithub.com/integrations/terraform-provider-github/pull/2158) - Feat: Fixes abandoned PR [#​2017](https://togithub.com/integrations/terraform-provider-github/issues/2017): Add support for the require_last_push_approval flag in github_branch_protection_v3 by [@​georgekaz](https://togithub.com/georgekaz) in [https://github.com/integrations/terraform-provider-github/pull/2199](https://togithub.com/integrations/terraform-provider-github/pull/2199) ##### Bugfixes - fix(data_source_github_rest_api): just read body and convert bytes into string by [@​riezebosch](https://togithub.com/riezebosch) in [https://github.com/integrations/terraform-provider-github/pull/2152](https://togithub.com/integrations/terraform-provider-github/pull/2152) ##### 🛠️ Maintenance - build(deps): bump golang.org/x/oauth2 from 0.17.0 to 0.18.0 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/integrations/terraform-provider-github/pull/2189](https://togithub.com/integrations/terraform-provider-github/pull/2189) - build(deps): bump google.golang.org/protobuf from 1.32.0 to 1.33.0 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/integrations/terraform-provider-github/pull/2194](https://togithub.com/integrations/terraform-provider-github/pull/2194) **Full Changelog**: integrations/terraform-provider-github@v6.1.0...v6.2.0 ### [`v6.1.0`](https://togithub.com/integrations/terraform-provider-github/releases/tag/v6.1.0) [Compare Source](https://togithub.com/integrations/terraform-provider-github/compare/v6.0.1...v6.1.0) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed - fix: validation rule for `results_per_page` of `github_repositories` data source by [@​dschniepp](https://togithub.com/dschniepp) in [https://github.com/integrations/terraform-provider-github/pull/2185](https://togithub.com/integrations/terraform-provider-github/pull/2185) - fix: Prevent loading of allowed actions if not configured by [@​Danielku15](https://togithub.com/Danielku15) in [https://github.com/integrations/terraform-provider-github/pull/2186](https://togithub.com/integrations/terraform-provider-github/pull/2186) - fix(data_source_github_rest_api): only allow for 404 on err by [@​riezebosch](https://togithub.com/riezebosch) in [https://github.com/integrations/terraform-provider-github/pull/2154](https://togithub.com/integrations/terraform-provider-github/pull/2154) - fix: error if autolink reference not found by [@​bradam12](https://togithub.com/bradam12) in [https://github.com/integrations/terraform-provider-github/pull/2164](https://togithub.com/integrations/terraform-provider-github/pull/2164) - feat: Add `github_actions_enterprise_permissions` by [@​ErikElkins](https://togithub.com/ErikElkins) in [https://github.com/integrations/terraform-provider-github/pull/2155](https://togithub.com/integrations/terraform-provider-github/pull/2155) - docs: configure release notes categories based on labels by [@​laughedelic](https://togithub.com/laughedelic) in [https://github.com/integrations/terraform-provider-github/pull/2184](https://togithub.com/integrations/terraform-provider-github/pull/2184) #### New Contributors - [@​dschniepp](https://togithub.com/dschniepp) made their first contribution in [https://github.com/integrations/terraform-provider-github/pull/2185](https://togithub.com/integrations/terraform-provider-github/pull/2185) - [@​riezebosch](https://togithub.com/riezebosch) made their first contribution in [https://github.com/integrations/terraform-provider-github/pull/2154](https://togithub.com/integrations/terraform-provider-github/pull/2154) - [@​bradam12](https://togithub.com/bradam12) made their first contribution in [https://github.com/integrations/terraform-provider-github/pull/2164](https://togithub.com/integrations/terraform-provider-github/pull/2164) - [@​ErikElkins](https://togithub.com/ErikElkins) made their first contribution in [https://github.com/integrations/terraform-provider-github/pull/2155](https://togithub.com/integrations/terraform-provider-github/pull/2155) - [@​laughedelic](https://togithub.com/laughedelic) made their first contribution in [https://github.com/integrations/terraform-provider-github/pull/2184](https://togithub.com/integrations/terraform-provider-github/pull/2184) **Full Changelog**: integrations/terraform-provider-github@v6.0.1...v6.1.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://togithub.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yNDAuMSIsInVwZGF0ZWRJblZlciI6IjM3LjI1Ny4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: kireque-bot[bot] <143391978+kireque-bot[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #1506
Based on #1506 (comment), I added a configuration to customize the auto-generated changelog (release notes). I mainly used the labels with
Type:prefix, but added a couple more categories for dependency updates and deprecations. Any changes that don't have one of those labels will go into the "Others" category.This is purely cosmetic change, but I believe it will make it easier for the users to see what's new and what is more important to them.
Before the change?
After the change?
Pull request checklist
Does this introduce a breaking change?