Skip to content

Commit cc83127

Browse files
authored
docs: improve release process (#1332)
1 parent 68522ce commit cc83127

File tree

3 files changed

+35
-109
lines changed

3 files changed

+35
-109
lines changed

.release-please-config.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
"site",
2626
".release-please-manifest.json",
2727
".release-please-config.json",
28+
"CONTRIBUTING.md",
2829
"tool"
2930
]
3031
}

CONTRIBUTING.md

Lines changed: 34 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -126,27 +126,45 @@ dart fix --apply
126126
💡 **Note**: While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional work, tests, or other changes before your pull request can be accepted.
127127

128128

129-
### 🛠️ Release Process (Automated via `release-please-action`)
129+
### Release Process 🚀
130130

131-
We use [`release-please-action`][release-please-action-link] to automate versioning and changelog generation.
131+
We use [`release-please-action`][release-please-action-link] to automate versioning and changelog generation, along with a GitHub workflow that automatically publish the CLI to pub.dev.
132132

133-
- Every commit to `main` is analyzed using [Conventional Commits][conventional_commits_link].
134-
- When a commit indicates a version bump is needed, a **release PR** is automatically created or updated.
135-
- The release PR includes:
136-
- An updated `CHANGELOG.md`
137-
- A version bump in `pubspec.yaml`
138-
- A version bump in `lib/src/version.dart`
139-
- Once the release PR is merged:
140-
- A new Git tag is created.
141-
- A GitHub release is published with the changelog.
133+
### How it works:
142134

143-
#### 💡 Notes
135+
- 📌 **On Every Commit to main:**
136+
- Commits are analyzed using [Conventional Commits][conventional_commits_link].
137+
- If a version bump is needed, a **release PR** is automatically created or updated by [`release-please-action`][release-please-action-link].
138+
- The **release PR** includes:
139+
- An updated `CHANGELOG.md`
140+
- A version bump in `pubspec.yaml`
141+
- A version bump in `lib/src/version.dart`
144142

145-
- Use `feat`, `fix`, or `BREAKING CHANGE:` in commit messages to trigger version bumps.
146-
- The release PR can be manually edited before merging.
147-
- The GitHub Action is configured in `.github/workflows/release_please.yaml`
148-
- release-please settings are defined in `.release-please-config.json` and `.release-please-manifest.json`
143+
##### 💡 Notes
149144

145+
- The GitHub Action workflow that automates the release process is configured in `.github/workflows/release_please.yaml`
146+
- release-please settings are defined in `.release-please-config.json` and `.release-please-manifest.json`
147+
- The release PR can be manually edited before merging.
148+
- The release PR should be merged **ONLY** when a new release is needed.
149+
150+
<br />
151+
152+
-**When the Release PR Is Merged:**
153+
- A new Git tag is created.
154+
- A GitHub Release is published with the changelog.
155+
- A new version of the cli is automatically published in pub.dev.
156+
157+
#### 💡 Notes
158+
159+
- The publishing process is automatically triggered when a version tag is created.
160+
- The automated publishing workflow to pub.dev is defined in `.github/workflows/pub_publish.yaml`
161+
162+
<br />
163+
164+
This document provides a good summary of how it works and how we use it, but we recommend that you also read the official documentation of [Conventional Commits][conventional_commits_link], [Semantic Versioning][sem_ver_link], [Publishing Dart packages][dart_publishing_link] and [`release-please-action`][release-please-action-link].
165+
166+
[dart_publishing_link]: https://dart.dev/tools/pub/publishing
167+
[sem_ver_link]: https://semver.org/
150168
[release-please-action-link]: https://github.com/googleapis/release-please-action
151169
[conventional_commits_link]: https://www.conventionalcommits.org/en/v1.0.0
152170
[bug_report_link]: https://github.com/VeryGoodOpenSource/very_good_cli/issues/new?assignees=&labels=bug&template=bug_report.md&title=fix%3A+

tool/release_ready.sh

Lines changed: 0 additions & 93 deletions
This file was deleted.

0 commit comments

Comments
 (0)