Skip to content
Compare
Choose a tag to compare
@github-actions github-actions released this 21 Oct 22:12

🐛 Fix multiline changelog parsing in GitHub release creation

  • 🔧 Updated the Create or Update Base Release step in auto-release workflow
  • 🔀 Added env section to properly handle multiline changelog
  • 📦 Used toJSON function to safely pass changelog content
  • 🔍 Changed changelog parsing from direct string to JSON.parse(process.env.CHANGELOG)
  • 🚀 This fix ensures that multiline changelogs are correctly processed
  • 💬 Prevents potential issues with special characters or line breaks in commit messages
  • 📊 Improves reliability of changelog display in GitHub releases

This update addresses a potential issue where multiline changelogs might not be correctly parsed when creating or updating GitHub releases. By using toJSON and JSON.parse, we ensure that the full changelog content, including any special characters or line breaks, is accurately preserved and displayed in the release notes. This change complements the previous update to include full commit messages, ensuring that all commit information is properly captured and presented in the release documentation.

🚀 Update changelog generation to include full commit messages

  • 📝 Modified the Generate changelog step in the auto-release workflow
  • 🔄 Changed git log format from %s (subject only) to %B (full body)
  • 🧹 Added sed command to clean up trailing newlines
  • 💬 This change ensures that multiline commit messages are fully captured
  • 📊 Improves the detail and context provided in release changelogs
  • 🔍 Allows for better tracking of complex changes and feature additions

These updates will provide more comprehensive and informative release notes, helping users and developers better understand the changes in each release. The full commit messages will now be visible, preserving important details that might have been omitted in the single-line format.

📝 Refine action description for clarity and conciseness

🔍 This commit focuses on improving the readability and effectiveness of our Auto PR action's description:

  • Streamlined the action description to be more concise while retaining all key information
  • Maintained the clarity of purpose: automating PR creation, generating descriptions, and adding reviewers
  • Kept the emphasis on the action's core functionality: working with dev and main/master branches
  • Retained mention of OpenAI integration for description generation

This update enhances the action's presentation in the marketplace and documentation, making it easier for users to quickly understand the action's capabilities and purpose.