Skip to content

Commit cdb095b

Browse files
authored
docs: update README and release workflow documentation (#21)
- Revised the README.md to enhance clarity on the automated release workflow, including version bumping and changelog generation. - Improved usage examples and added new commands for creating releases with specified version bumps. - Updated the release notes generation section to reflect changes in variable naming for release dates. - Enhanced formatting and structure for better user guidance on release automation features.
1 parent 4fd9066 commit cdb095b

2 files changed

Lines changed: 15 additions & 17 deletions

File tree

.cursor/rules/utils/release-workflow-auto.mdc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,10 +147,13 @@ actions:
147147
```
148148

149149
6. **Generate Structured Release Notes**:
150+
```bash
151+
$RELEASE_DATE=$(date +%Y-%m-%d)
152+
```
150153
```markdown
151154
# What's Changed in [PACKAGE_NAME] v[NEW_VERSION]
152155

153-
**Release Date**: [DATE]
156+
**Release Date**: [RELEASE_DATE]
154157
**Previous Version**: [PREVIOUS_VERSION]
155158
**Version Bump**: [MAJOR|MINOR|PATCH] - [REASON]
156159
**Branch**: [CURRENT_BRANCH]
@@ -345,7 +348,7 @@ actions:
345348
echo "⏭️ Skipping version update"
346349
fi
347350
```
348-
9. **Offer Git Tag Creation** 🏷️
351+
9. **Offer Git Tag Creation** 🏷️
349352
```bash
350353

351354
echo "🏷️ Would you like me to create a git tag for version $NEW_VERSION?"

README.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -131,10 +131,9 @@ In fact, any of the agents can be called upon to help with the workflow at any t
131131

132132
In the enablement of complete laziness, I tried getting Cursor to release from chat.
133133

134-
Generate professional release notes and changelogs automatically from your git history!
135-
These rules analyze your commits and create structured documentation following best practices.
134+
### :construction: Automate Release Workflow :construction:
136135

137-
### 🚀 Automate Release Workflow
136+
Use with caution. This isn't perfect.
138137

139138
Create a release with a version bump, generate release notes and changelog, and update the version in package.json.
140139

@@ -150,18 +149,13 @@ Create/Prepare a release
150149
[Create|Generate] release notes
151150

152151
# Specify version bump upfront
153-
Create a release with a major version bump
154-
Create a release with a minor version bump
155-
Create a release with a patch version bump
156-
157-
# Interactive version selection (if no version specified)
158-
# The rule will prompt you to choose:
159-
# 1) Major version (breaking changes)
160-
# 2) Minor version (new features)
161-
# 3) Patch version (bug fixes)
162-
# 4) Custom version
152+
Create a major release
153+
Create a minor release
154+
Create a patch release
163155
```
164156

157+
If you don't specify a version bump, the rule will ask you to choose a version bump.
158+
165159
<details>
166160

167161
<summary>Output Example</summary>
@@ -186,6 +180,9 @@ npm version minor --no-git-tag
186180
git tag v0.2.0
187181
git push origin v0.2.0
188182
```
183+
184+
See [RELEASE_NOTES_v0.1.3_to_v0.1.4.md](./RELEASE_NOTES_v0.1.3_to_v0.1.4.md)
185+
189186
</details>
190187

191188
### 📚 Changelog Generator
@@ -205,8 +202,6 @@ Generates a comprehensive `changelog.md` file at the project root in the style o
205202
# - Follow Keep a Changelog format standards
206203
```
207204

208-
#### Output Example:
209-
210205
<details>
211206
<summary>Output Example</summary>
212207

0 commit comments

Comments
 (0)