Release v1.4.0

Changes in this Release:

• 📝 Update .gitignore and enhance PR description formatting

🔍 This commit includes the following changes:

• 🚫 Added .idea/ to .gitignore for better IDE-specific exclusions

• 🧹 Improved formatting in .gitignore for clarity

• 🎨 Enhanced PR description formatting in index.js:

  • Added a clear "AUTO DESCRIPTION" header
  • Included a link to the auto-pr-description-action repository
  • Adjusted the logic for handling existing descriptions

• 🔧 These updates improve project organization and make auto-generated PR descriptions more informative and visually distinct

• Merge pull request #6 from yuri-val/dev

🔄 Update actions/checkout to v4 in README

• 📚 Enhance README with features and todo list

• ✨ Added new feature: Fetches diff content and commit messages for context
• 📋 Introduced a new "ToDo" section with upcoming features
• 🎯 Listed three planned enhancements:

• Rate limiting and API call retries
• Configurable prompt templates
• Multi-language support for generated descriptions
  • 🔍 Improved documentation clarity and completeness

This update to the README provides a more comprehensive overview of the project's capabilities and future direction. By highlighting the new feature of fetching diff content and commit messages, users can better understand the context-aware nature of the auto-generated PR descriptions. The addition of a todo list demonstrates ongoing development efforts and gives potential contributors insight into planned improvements. This change not only enhances the documentation but also sets clear expectations for users and potential collaborators about the project's roadmap.

• 🔄 Update actions/checkout to v4 in README

• 📦 Bumped actions/checkout from v2 to v4 in the workflow example
• 🔧 Ensures the README reflects the latest recommended version
• 🚀 Improves compatibility with newer GitHub Actions features
• 📚 Keeps documentation up-to-date with current best practices

This minor update to the README.md file ensures that users of the auto-pr-description-action are guided to use the most recent version of the actions/checkout action. By recommending v4 instead of v2, we're promoting the use of the latest features and improvements in the GitHub Actions ecosystem. This change helps maintain the relevance and effectiveness of the documentation, potentially leading to better performance and fewer issues for users implementing the workflow.

Base Release v1

This is the base release for v1. Latest version: v1.4.0

Changelog:

• 📝 Update .gitignore and enhance PR description formatting

🔍 This commit includes the following changes:

• 🚫 Added .idea/ to .gitignore for better IDE-specific exclusions

• 🧹 Improved formatting in .gitignore for clarity

• 🎨 Enhanced PR description formatting in index.js:

  • Added a clear "AUTO DESCRIPTION" header
  • Included a link to the auto-pr-description-action repository
  • Adjusted the logic for handling existing descriptions

• 🔧 These updates improve project organization and make auto-generated PR descriptions more informative and visually distinct

• Merge pull request #6 from yuri-val/dev

🔄 Update actions/checkout to v4 in README

• 📚 Enhance README with features and todo list

• ✨ Added new feature: Fetches diff content and commit messages for context
• 📋 Introduced a new "ToDo" section with upcoming features
• 🎯 Listed three planned enhancements:

• Rate limiting and API call retries
• Configurable prompt templates
• Multi-language support for generated descriptions
  • 🔍 Improved documentation clarity and completeness

This update to the README provides a more comprehensive overview of the project's capabilities and future direction. By highlighting the new feature of fetching diff content and commit messages, users can better understand the context-aware nature of the auto-generated PR descriptions. The addition of a todo list demonstrates ongoing development efforts and gives potential contributors insight into planned improvements. This change not only enhances the documentation but also sets clear expectations for users and potential collaborators about the project's roadmap.

• 🔄 Update actions/checkout to v4 in README

• 📦 Bumped actions/checkout from v2 to v4 in the workflow example
• 🔧 Ensures the README reflects the latest recommended version
• 🚀 Improves compatibility with newer GitHub Actions features
• 📚 Keeps documentation up-to-date with current best practices

This minor update to the README.md file ensures that users of the auto-pr-description-action are guided to use the most recent version of the actions/checkout action. By recommending v4 instead of v2, we're promoting the use of the latest features and improvements in the GitHub Actions ecosystem. This change helps maintain the relevance and effectiveness of the documentation, potentially leading to better performance and fewer issues for users implementing the workflow.

Release v1.3.0

Changes in this Release:

• Merge pull request #5 from yuri-val/dev

🛠️ Enhance PR description update process

• 🛠️ Enhance PR description update process

• Implemented error handling for PR description updates
• Added creation of a comment with the original description
• Improved formatting of the new description
• Enhanced logging for better debugging and tracking

This update significantly improves the robustness and user-friendliness of the PR description update process. Here's a breakdown of the changes:

1. 🔍 Added a try-catch block to handle potential errors during the update process
2. 💾 Preserved the original PR description by creating a new comment
3. 🎨 Improved formatting of the new description with a clear separator
4. 📝 Enhanced console logging for better visibility into the process
5. 🐛 Ensured errors are properly propagated for handling in the main try-catch block

These enhancements will provide a smoother experience for users and make troubleshooting easier for developers. The preservation of the original description ensures no information is lost during the update process.

• Merge pull request #4 from yuri-val/dev

📝 Enhance README with more engaging introduction

• 📝 Enhance README with more engaging introduction

This commit significantly improves the README.md file, making it more attractive and informative for potential users. Here's what's been updated:

• 🎨 Added an eye-catching emoji to the main title, making it more visually appealing
• 🚀 Expanded the title to better convey the action's purpose: "Supercharge Your Pull Requests!"
• 📚 Rewrote the introductory paragraph to provide a more comprehensive and compelling description of the action's capabilities
• 💡 Highlighted key benefits: detailed, insightful descriptions and improved team collaboration
• 🔍 Emphasized the use of OpenAI's cutting-edge language models
• 🌟 Used more engaging language to capture the reader's interest

These changes aim to make the project more appealing to potential users and contributors, clearly communicating the value proposition of the Auto-generate PR Description Action. The enhanced README will help users quickly understand the action's purpose and benefits, potentially increasing adoption and engagement with the project.

Release v1.2

Changes in this Release:

• Merge pull request #3 from yuri-val/dev

🔧 Enhance PR description handling and improve variable naming

• 🔧 Enhance PR description handling and improve variable naming

This commit improves the handling of pull request descriptions and enhances variable naming for clarity. Here's a breakdown of the changes:

• 📝 Renamed description to generatedDescription for better clarity
• 🔄 Updated updatePRDescription function to append new descriptions instead of overwriting
• 📊 Fetch existing PR description before updating
• ➕ Add separator between existing and new descriptions
• 🔍 Ensure consistent use of generatedDescription throughout the code

These changes improve the functionality of the auto-PR-description action by preserving existing descriptions and clearly separating newly generated content. The enhanced variable naming also contributes to better code readability and maintainability.

• Merge pull request #2 from yuri-val/dev

🔒 Update permissions in README for Auto PR Description action

• 🔒 Update permissions in README for Auto PR Description action

🛠️ Enhanced workflow permissions documentation in README.md

• Added explicit permissions configuration to the example workflow
• Included contents: read, pull-requests: write, and issues: write permissions
• This update ensures users properly configure the necessary access rights
• Helps prevent potential "Resource not accessible by integration" errors
• Improves clarity and ease of setup for new users of the action
• Aligns documentation with best practices for GitHub Actions

Release v1.1

Changes in this Release:

• Merge pull request #1 from yuri-val/dev

Release 1.1

• 📝 Update Auto PR Description workflow permissions

🔒 Enhance security and functionality of the Auto-generate PR Description action

• Added issues: write permission to the workflow job

• This new permission allows the action to create or update issue comments if needed

• Ensures the action has the necessary access to fully interact with pull requests and related issues

• Helps prevent potential "Resource not accessible by integration" errors

• Improves overall reliability and capability of the automated PR description generation

• This commit introduces a new GitHub Actions workflow for automatically generating pull request descriptions:

📄 New file: .github/workflows/auto-pr-description.yml

Key features of the workflow:

• 🔄 Triggers on pull request events: opened, edited, reopened, and synchronize
• 🏃‍♂️ Runs on the latest Ubuntu environment
• 📥 Checks out the repository with full history using actions/checkout@v4
• 🚀 Utilizes the custom action yuri-val/auto-pr-description-action@v1 to generate PR descriptions
• 🔐 Securely uses OpenAI API key and GitHub token from repository secrets
• 🧠 Configures OpenAI model to 'gpt-4o-mini' for optimal performance

This workflow automates the process of creating informative and consistent pull request descriptions, enhancing collaboration and code review efficiency.

• This commit introduces significant improvements to our development and release processes:

🔄 Auto Release Workflow:

• Added .github/workflows/auto-release.yml to automate the release process
• Triggers on pushes of tags starting with 'v'
• Generates changelogs based on commits since the last tag
• Creates or updates base version releases (e.g., v1, v2) with cumulative changes
• Creates full version releases (e.g., v1.2.3) with specific changes

🪝 Pre-commit Hook:

• Implemented a pre-commit hook using Husky
• Automatically runs the build process before each commit
• Adds the updated dist/* files to the commit

📦 Package.json Updates:

• Added husky as a dev dependency
• Included prepare script to set up Husky
• Updated build script to use ncc for bundling

These changes streamline our release management and ensure that our distributed files are always up-to-date with the latest changes.