Skip to content

fix: release notes date, update readme #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
usrrname merged 1 commit into from
Jun 21, 2025
Merged

fix: release notes date, update readme #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions .cursor/rules/utils/release-workflow-auto.mdc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,10 +147,13 @@ actions:
```

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

**Release Date**: [DATE]
**Release Date**: [RELEASE_DATE]
**Previous Version**: [PREVIOUS_VERSION]
**Version Bump**: [MAJOR|MINOR|PATCH] - [REASON]
**Branch**: [CURRENT_BRANCH]
Expand Down Expand Up @@ -345,7 +348,7 @@ actions:
echo "⏭️ Skipping version update"
fi
```
9. **Offer Git Tag Creation** 🏷️
9. **Offer Git Tag Creation** 🏷️
```bash

echo "🏷️ Would you like me to create a git tag for version $NEW_VERSION?"
Expand Down
25 changes: 10 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,10 +131,9 @@ In fact, any of the agents can be called upon to help with the workflow at any t

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

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

### 🚀 Automate Release Workflow
Use with caution. This isn't perfect.

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

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

# Specify version bump upfront
Create a release with a major version bump
Create a release with a minor version bump
Create a release with a patch version bump

# Interactive version selection (if no version specified)
# The rule will prompt you to choose:
# 1) Major version (breaking changes)
# 2) Minor version (new features)
# 3) Patch version (bug fixes)
# 4) Custom version
Create a major release
Create a minor release
Create a patch release
```

If you don't specify a version bump, the rule will ask you to choose a version bump.

<details>

<summary>Output Example</summary>
Expand All @@ -186,6 +180,9 @@ npm version minor --no-git-tag
git tag v0.2.0
git push origin v0.2.0
```

See [RELEASE_NOTES_v0.1.3_to_v0.1.4.md](./RELEASE_NOTES_v0.1.3_to_v0.1.4.md)

</details>

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

#### Output Example:

<details>
<summary>Output Example</summary>

Expand Down
Loading