Skip to content

Commit 05e1acf

Browse files
committed
feat(release): include README.md updates and fix typo
1 parent 9e25efe commit 05e1acf

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

.gemini/commands/release.toml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,18 @@ Follow these steps precisely:
1212
4. **Propose Version:**
1313
- Propose a new version number with a brief rationale.
1414
- Use `ask_user` to confirm the version.
15-
= Update the version in `package.json`, `pyproject.toml` or any other dependency configuration file, if it exists.
15+
- Update the version in `package.json`, `pyproject.toml` or any other dependency configuration file, if it exists.
1616
- Update the version in any relevant source files if necessary (e.g., `__version__.py`).
1717
- Update the version in any relevant documentation files if necessary (e.g., `README.md`).
18-
5. **Update CHANGELOG.md:**
18+
5. **Update CHANGELOG.md and README.md:**
1919
- **IMMEDIATELY** after the version is decided, update `CHANGELOG.md`.
2020
- Create a new entry for the version, summarizing all changes since the last release.
2121
- Follow the established format in `CHANGELOG.md`.
22+
- Update the README.md if it contains a version badge or any version references, plus update any relevant documentation in this file if necessary.
2223
6. **Finalize Release:**
2324
- Use `ask_user` to confirm the final release.
2425
- If confirmed:
25-
- Create a commit for the release: `git add CHANGELOG.md && git commit -m "chore(release): version <new_version>"`.
26+
- Create a commit for the release: `git add CHANGELOG.md README.md && git commit -m "chore(release): version <new_version>"` (include any other files updated during the version bump).
2627
- Create a git tag: `git tag -a "v<new_version>" -m "Release v<new_version>"`.
2728
- Push the tag to the remote if it exists.
2829
- Propose using `gh release create` for GitHub releases, including the changelog entry as the release notes.

0 commit comments

Comments
 (0)