Skip to content
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

Woo AI - Add a changelog.txt file for automation. #41215

Open
wants to merge 2 commits into
base: trunk
Choose a base branch
from

Conversation

tommyshellberg
Copy link
Contributor

@tommyshellberg tommyshellberg commented Nov 3, 2023

As part of this issue: #40894 we will add a changelog.txt file for WooRelease to be able to parse and generate the plugin changelog.txt file. This allows for the version to be automatically bumped using WooRelease. We will no longer need to manually update the plugin header files, the composer.json file, or the package.json file. However, in order for these files to be updated, we have to also have a changelog.txt file. We will deal with the CHANGELOG.md file in a different PR. Once the WooRelease plugin can generate the changelog.txt file, we can delete the CHANGELOG.md file and the automation in place that generates it.

Changes proposed in this Pull Request:

Add a changelog.txt file that satisfies the requirements needed for WooRelease to parse and modify it.

An example you can compare with:

https://github.com/woocommerce/woocommerce/blob/trunk/plugins/woocommerce-beta-tester/changelog.txt

And another:

https://github.com/woocommerce/woocommerce-bookings/blob/trunk/changelog.txt

Changelog entry

  • Automatically create a changelog entry from the details below.

Significance

  • Patch
  • Minor
  • Major

Type

  • Fix - Fixes an existing bug
  • Add - Adds functionality
  • Update - Update existing functionality
  • Dev - Development related task
  • Tweak - A minor adjustment to the codebase
  • Performance - Address performance issues
  • Enhancement - Improvement to existing functionality

Message

Comment

@tommyshellberg tommyshellberg marked this pull request as ready for review November 3, 2023 14:05
@github-actions github-actions bot added the plugin: woo-ai Issues related to the Woo AI features plugin. label Nov 3, 2023
@tommyshellberg tommyshellberg requested a review from a team November 3, 2023 14:23
Copy link
Contributor

github-actions bot commented Nov 3, 2023

Hi , @woocommerce/singularity

Apart from reviewing the code changes, please make sure to review the testing instructions as well.

You can follow this guide to find out what good testing instructions should look like:
https://github.com/woocommerce/woocommerce/wiki/Writing-high-quality-testing-instructions

Copy link
Contributor

github-actions bot commented Nov 3, 2023

Test Results Summary

Commit SHA: 285c53f

Test 🧪Passed ✅Failed 🚨Broken 🚧Skipped ⏭️Unknown ❔Total 📊Duration ⏱️
API Tests25900202610m 38s
E2E Tests215004021911m 9s

To view the full API test report, click here.
To view the full E2E test report, click here.
To view all test reports, visit the WooCommerce Test Reports Dashboard.

Copy link
Contributor

@nima-karimi nima-karimi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Let's merge this after updating our release process docs and switching over to Woorelease.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
plugin: woo-ai Issues related to the Woo AI features plugin.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants