Skip to content

feat: fix release notes references to use final tags #29

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.

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
merged 1 commit into from
Jun 29, 2025

Conversation

fpelliccioni
Copy link
Contributor

Fixed the release script to ensure correct tag references in both GitHub releases and local release notes documentation.

🔧 Issues Fixed:

  1. GitHub Release References:

    • Changed final release creation to use --generate-notes
    • Ensures 'Full Changelog' links point to final tag (v0.68.0)
    • Previously pointed to temporary tag (temp-v0.68.0)
  2. Local Release Notes (.md) References:

    • Added sed replacement to fix temporary tag references
    • Replaces 'temp-vX.X.X' with 'vX.X.X' in extracted notes
    • Ensures documentation has correct links

⚡ Process Flow:

  1. Create temporary tag → Generate notes for .md file
  2. Extract and fix references → Replace temp tags with final tags
  3. Save corrected notes to .md → With proper references
  4. Delete temporary tag → Clean up
  5. Create final release → Auto-generate fresh notes with correct refs

✅ Result:

  • GitHub Release: Correct 'Full Changelog' → vX.X.X
  • Local .md file: Correct references → vX.X.X
  • No temporary tag references remain anywhere

This fix ensures consistency between GitHub releases and local documentation, providing users with proper changelog links.

Fixed the release script to ensure correct tag references in both
GitHub releases and local release notes documentation.

🔧 Issues Fixed:

1. **GitHub Release References**:
   - Changed final release creation to use --generate-notes
   - Ensures 'Full Changelog' links point to final tag (v0.68.0)
   - Previously pointed to temporary tag (temp-v0.68.0)

2. **Local Release Notes (.md) References**:
   - Added sed replacement to fix temporary tag references
   - Replaces 'temp-vX.X.X' with 'vX.X.X' in extracted notes
   - Ensures documentation has correct links

⚡ Process Flow:
1. Create temporary tag → Generate notes for .md file
2. Extract and fix references → Replace temp tags with final tags
3. Save corrected notes to .md → With proper references
4. Delete temporary tag → Clean up
5. Create final release → Auto-generate fresh notes with correct refs

✅ Result:
- GitHub Release: Correct 'Full Changelog' → vX.X.X
- Local .md file: Correct references → vX.X.X
- No temporary tag references remain anywhere

This fix ensures consistency between GitHub releases and local
documentation, providing users with proper changelog links.
@fpelliccioni fpelliccioni merged commit ce298bd into master Jun 29, 2025
17 checks passed
@fpelliccioni fpelliccioni deleted the feat/fix-release-notes-references-in-script branch June 29, 2025 20:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant