v1.5

Release Note for Auto Pull Bot v1.5

Overview

Version 1.5 of the Auto Pull Bot introduces enhancements and improvements aimed at increasing usability and performance. This update focuses on refining the pull request creation process and ensuring better error handling and feedback for users.

New Features

• Improved Pull Request Creation: The bot now automatically creates pull requests when a branch is behind the main branch, enhancing the integration process.
• Existing Pull Request Check: Added functionality to check for existing pull requests before creating a new one, preventing duplicate requests.

Enhancements

• Better Logging: Improved output messages for better visibility during the workflow execution, including detailed information about branch status and pull request creation.
• Error Handling: Enhanced error handling when using the GitHub CLI, ensuring that the workflow exits gracefully with informative messages.

Bug Fixes

• Fixed an issue where the workflow did not set the GH_TOKEN environment variable consistently, causing failures when checking for existing pull requests.

Usage

• The Auto Pull Bot now runs on every push to branches other than main, automatically creating pull requests for branches that are behind the main branch. Users can still manually trigger the workflow for testing purposes.

Future Plans

• In the upcoming versions, we plan to introduce features based on user feedback, such as more customizable pull request messages and additional label options.

v1.4

Change Note for Auto Pull Bot

Version 1.4

Enhancements

1. Added Notification Step:

   • Introduced a new step (Notify PR Creation) to confirm the successful creation of a pull request, providing users with immediate feedback.

2. Improved Logging:

   • Enhanced descriptive echo statements throughout the script to provide clarity on each operation's outcome, aiding in debugging and monitoring.

3. Branch Checking Enhancement:

   • Maintained checks to ensure the current branch is not main and that it is up to date with the main branch before proceeding with pull request creation.

4. Condition for PR Creation:

   • Preserved existing logic to ensure that a new pull request is created only if no existing PR is found for the branch.

5. Streamlined Output Handling:

   • Improved logic for handling outputs and messages for better readability and maintainability.

Summary

These enhancements aim to improve the usability and functionality of the Auto Pull Bot script, ensuring it provides clear feedback and better handles the pull request creation process. The focus on logging and notification enhances the user experience by making the bot's actions more transparent.

v1.3.1

Release Note: Auto Pull Bot v1.3.1

Overview

Version 1.3.1 of the Auto Pull Bot introduces several enhancements aimed at improving the functionality and robustness of the workflow. This version focuses on better handling of pull requests, branch validation, and improved logging for easier debugging.

Key Features and Updates

1. Branch Handling Enhancements:

   • Branch Name Extraction: The branch name is now extracted and logged more efficiently, ensuring compatibility with various shell environments.
   • Current Branch Check: The workflow now explicitly checks if the current branch is main and avoids creating pull requests if true.

2. Pull Request Management:

   • Pull Request Existence Check: The bot checks for existing pull requests for the current branch before attempting to create a new one, preventing duplicate pull requests.
   • Pull Request Creation: If no existing pull request is found, the bot will create a new pull request with a clear title and body indicating the source branch.
   • Automatic Labeling: Upon creating a pull request, the bot automatically adds the labels github_actions and Auto Merge to facilitate automated workflows and categorization.

3. Logging and Feedback Improvements:

   • Enhanced logging for better traceability of actions taken by the bot, including the state of branches and the results of operations.
   • Clear console messages guide users through the process, indicating what the bot is doing at each step.

Workflow Triggers

• The workflow is triggered on push events to branches other than main, and it can also be manually triggered via workflow_dispatch for testing purposes.

Environment Variables

• The workflow utilizes GITHUB_TOKEN to authenticate and interact with the GitHub API, ensuring secure operations without exposing sensitive information.

Conclusion

With these improvements, Auto Pull Bot v1.3.1 aims to streamline the process of managing pull requests in your repository, reduce manual intervention, and enhance overall workflow efficiency.

v1.3

Release Note: Auto Pull Bot v1.3

Overview

Version 1.3 of the Auto Pull Bot introduces several enhancements aimed at improving the functionality and robustness of the workflow. This version focuses on better handling of pull requests, branch validation, and improved logging for easier debugging.

Key Features and Updates

1. Branch Handling Enhancements:

   • Branch Name Extraction: The branch name is now extracted and logged more efficiently, ensuring compatibility with various shell environments.
   • Current Branch Check: The workflow now explicitly checks if the current branch is main and avoids creating pull requests if true.

2. Pull Request Management:

   • Pull Request Existence Check: The bot checks for existing pull requests for the current branch before attempting to create a new one, preventing duplicate pull requests.
   • Pull Request Creation: If no existing pull request is found, the bot will create a new pull request with a clear title and body indicating the source branch.
   • Automatic Labeling: Upon creating a pull request, the bot automatically adds the labels github_actions and Auto Merge to facilitate automated workflows and categorization.

3. Logging and Feedback Improvements:

   • Enhanced logging for better traceability of actions taken by the bot, including the state of branches and the results of operations.
   • Clear console messages guide users through the process, indicating what the bot is doing at each step.

Workflow Triggers

• The workflow is triggered on push events to branches other than main, and it can also be manually triggered via workflow_dispatch for testing purposes.

Environment Variables

• The workflow utilizes GITHUB_TOKEN to authenticate and interact with the GitHub API, ensuring secure operations without exposing sensitive information.

Conclusion

With these improvements, Auto Pull Bot v1.3 aims to streamline the process of managing pull requests in your repository, reduce manual intervention, and enhance overall workflow efficiency.

v1.2

Release Note: v1.2

Release Date: October 11.2024

New Features

• Automated Pull Request Creation: The action now automatically creates a pull request when the current branch is behind the main branch, ensuring your branches are always up to date.
• Branch Name Logging: Enhanced logging of the current branch name for better visibility and tracking.

Improvements

• Error Handling: Improved error handling for GitHub CLI commands to ensure smoother execution and better feedback when actions fail.
• Code Refactoring: Cleaned up the code for better readability and maintainability, making it easier to understand and modify in the future.

Bug Fixes

• Fixed an issue where the action would not correctly identify existing pull requests, preventing unnecessary duplications.
• Resolved minor bugs related to environment variable handling.

Breaking Changes

• No breaking changes in this release.

v1.1

Release Notes for Auto Pull Request Workflow - Version 1.1

Release Date: October 11, 2024

Overview

This release introduces enhancements to the Auto Pull Request GitHub Actions workflow, aimed at improving usability, performance, and maintainability.

Changelog

Enhancements:

• Improved Logging:

  • Added more descriptive echo statements to provide clearer insights into the workflow's execution, particularly regarding branch checks and pull request status.

• Step Naming:

  • Renamed workflow steps for better clarity and consistency. Each step now has a more descriptive name reflecting its specific action.

• Documentation:

  • Enhanced inline comments to ensure maintainers understand the purpose of each step clearly.

Bug Fixes:

• Pull Request Checks:
  • Fixed an issue where the workflow would not correctly handle cases where the branch was already up to date with the main branch, improving overall reliability.

Miscellaneous:

• Updated to use the latest version of actions/checkout to ensure compatibility and performance enhancements.

Known Issues

• No known issues reported in this release.

Future Plans

• Future updates may include additional functionality for handling multiple branches and improving the integration with GitHub's API.

Contributors

Thanks to all contributors for their efforts in making this release possible!

v1.0

Autopullbot Release Notes

Version 1.0 - October 11, 2024

Overview

We are excited to announce the release of Autopullbot, an automated solution designed to streamline the process of keeping your GitHub repository branches synchronized. With this tool, developers can ensure that the target branch is always up to date with the latest changes from specified source branches without manual intervention.

Key Features

• Automated Branch Synchronization: Automatically pulls changes from specified branches, minimizing the need for manual merges and reducing the risk of conflicts.

• Configurable Settings: Users can easily customize the source and target branches to fit their workflow, making it adaptable for various project needs.

• Commit History Preservation: Maintains the integrity of the commit history during merges, allowing for transparent tracking of changes.

Improvements

• User-Friendly Configuration: Simplified YAML configuration format for easy setup and customization.

• Robust Error Handling: Enhanced error handling mechanisms to ensure smooth operation and provide informative logs for troubleshooting.

Getting Started

To get started with Autopullbot, follow these steps:

1. Clone the Repository: Clone the repository where you wish to implement the Autopullbot.

2. Update Configuration: Modify the Autopullbot.yml file to set your source and target branches, as well as your user details for commit attribution.

3. Deploy the Bot: Add the Autopullbot to your GitHub Actions workflows, ensuring it has the required permissions to perform merges.

Known Issues

• Currently, there are no known issues, but users are encouraged to report any bugs or suggestions for improvements through the repository’s issue tracker.

Contribution

We welcome contributions from the community! If you would like to contribute, please refer to the Contributing Guidelines.

Acknowledgments

Thank you to everyone who contributed to the development and testing of Autopullbot. Your feedback and support have been invaluable in bringing this project to fruition.