search

Parsely / wp-parsely

The official WordPress plugin for Parse.ly - makes it a snap to add the required tracking code to enable Parse.ly on your WordPress site.
https://wordpress.org/plugins/wp-parsely/
GNU General Public License v2.0
64 stars 32 forks source link

GitHub Actions: Add Release and Bump Version workflows #2923

Closed vaurdan closed 2 weeks ago

vaurdan commented 2 weeks ago

Description

This PR adds two new workflows for the release process:

Motivation and context

How has this been tested?

Tested extensively on a different branch, directly on GitHub.

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 2 weeks ago
📝 Walkthrough ## Walkthrough A new issue template `release-template-new.md` has been added to streamline the release process for the `wp-parsely` plugin. Additionally, significant updates have been made to several GitHub Actions workflows, enhancing version management, testing, and deployment processes. The workflows now include improved validation steps, new jobs for integration and end-to-end tests, and better error handling in scripts. These changes collectively aim to ensure a more organized and efficient release cycle, maintaining compatibility with the latest PHP versions. ## Changes | File Path | Change Summary | |---------------------------------------------|--------------------------------------------------------------------------------------------------------------------| | `.github/ISSUE_TEMPLATE/release-template-new.md` | New issue template added for managing the release process of the `wp-parsely` plugin. | | `.github/workflows/bump-version.yml` | Updated to include version validation, renamed job from `display_version` to `validate_version`, added `run_release_php_script`. Introduced environment variable `NEW_VERSION`. | | `.github/workflows/e2e-tests.yml` | Added `workflow_call` trigger to allow invocation by other workflows; no changes to existing job steps. | | `.github/workflows/integration-tests.yml` | Added `workflow_call` trigger; expanded matrix to include PHP 8.2 and 8.4; clarified dependency installation checks. | | `.github/workflows/release-plugin.yml` | Major restructuring with new jobs for validation, integration tests, end-to-end tests, tagging, and deployment. Added input for version specification. | | `bin/release.php` | Enhanced to save generated changelog to an environment variable if PR is not created, with error handling for file operations. | | `bin/update-version.sh` | Improved error handling and cross-platform compatibility; added `sed_inplace` function for version updates. | | `.github/workflows/build-plugin.yml` | Updated to enhance build process with new triggers, environment variables, and improved branch handling logic. | ## Possibly related PRs - **#2687**: This PR updates the version number and changelog for the `wp-parsely` plugin, which is directly related to the new issue template introduced in the main PR that outlines the release process, including version updates and changelog management. - **#2878**: This PR adds PHP 8.4 to the testing workflows, which is relevant to the release process as it ensures compatibility and testing of the plugin with the latest PHP version, aligning with the structured release process described in the main PR. ## Suggested labels `Changelog: Added` ## Suggested reviewers - acicovic

[!WARNING]

Tool Failures:

Tool Failure Count:

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
acicovic commented 2 weeks ago

Side-note: There seems to be a double blank line in build-plugin.yml on line 84.

vaurdan commented 2 weeks ago

@acicovic addressed your feedback and replied to your comments 🙂