Skip to content

Commit 5920937

Browse files
authored
ci: Update changelog publish details (#460)
Signed-off-by: André Silva <[email protected]>
1 parent 1a4b9cf commit 5920937

File tree

2 files changed

+72
-2
lines changed

2 files changed

+72
-2
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,32 @@ The instructions above will generate a test project for you.
4646

4747
Use `dotnet test` to test the entire project.
4848

49-
## Versioning and releasing
49+
## Automated Changelog
5050

51-
This repo uses _Release Please_ to release packages. Release Please sets up a running PR that tracks all changes for the library components, and maintains the versions according to [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), generated when [PRs are merged](https://github.com/amannn/action-semantic-pull-request). When Release Please's running PR is merged, any changed artifacts are published.
51+
Each time a release is published the changelogs will be generated automatically using [googleapis/release-please-action](https://github.com/googleapis/release-please-action). The tool will organise the changes based on the PR labels.
52+
Please make sure you follow the latest [conventions](https://www.conventionalcommits.org/en/v1.0.0/). We use an automation to check if the pull request respects the desired conventions. You can check it [here](https://github.com/open-feature/dotnet-sdk/actions/workflows/lint-pr.yml). Must be one of the following:
53+
54+
- build: Changes that affect the build system or external dependencies (example scopes: nuget)
55+
- ci: Changes to our CI configuration files and scripts (example scopes: GitHub Actions, Coverage)
56+
- docs: Documentation only changes
57+
- feat: A new feature
58+
- fix: A bug fix
59+
- perf: A code change that improves performance
60+
- refactor: A code change that neither fixes a bug nor adds a feature
61+
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
62+
- test: Adding missing tests or correcting existing tests
63+
64+
If you want to point out a breaking change, you should use `!` after the type. For example: `feat!: excellent new feature`.
65+
66+
### Changelog Visibility and Release Triggers
67+
68+
Only certain types are visible in the generated changelog:
69+
70+
- `feat`: ✨ New Features - New functionality added
71+
- `fix`: 🐛 Bug Fixes - Bug fixes and corrections
72+
- `perf`: 🚀 Performance - Performance improvements
73+
- `refactor`: 🔧 Refactoring - Code changes that neither fix bugs nor add features
74+
- `revert`: 🔙 Reverts - Reverted changes
5275

5376
## Dependencies
5477

release-please-config.json

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,53 @@
104104
{
105105
"type": "feat",
106106
"section": "✨ New Features"
107+
},
108+
{
109+
"type": "chore",
110+
"hidden": true,
111+
"section": "🧹 Chore"
112+
},
113+
{
114+
"type": "docs",
115+
"hidden": true,
116+
"section": "📚 Documentation"
117+
},
118+
{
119+
"type": "perf",
120+
"section": "🚀 Performance"
121+
},
122+
{
123+
"type": "build",
124+
"hidden": true,
125+
"section": "🛠️ Build"
126+
},
127+
{
128+
"type": "deps",
129+
"hidden": true,
130+
"section": "📦 Dependencies"
131+
},
132+
{
133+
"type": "ci",
134+
"hidden": true,
135+
"section": "🚦 CI"
136+
},
137+
{
138+
"type": "refactor",
139+
"section": "🔧 Refactoring"
140+
},
141+
{
142+
"type": "revert",
143+
"section": "🔙 Reverts"
144+
},
145+
{
146+
"type": "style",
147+
"hidden": true,
148+
"section": "🎨 Styling"
149+
},
150+
{
151+
"type": "test",
152+
"hidden": true,
153+
"section": "🧪 Tests"
107154
}
108155
],
109156
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"

0 commit comments

Comments
 (0)