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

Enhance readme CLI command to support standalone plugins #1075

Merged
merged 3 commits into from Mar 22, 2024

Conversation

felixarntz
Copy link
Member

Summary

Follow up to #1064: This PR enhances the npm run readme command to support standalone plugins. Given the changelog command was already updated, the only necessary change was to dynamically identify which readme.txt file to update, as before it would always update the root readme.txt file.

Relevant technical choices

  • A path option was added, however that's purely for flexibility and is optional.
  • By default, the path will automatically be detected via the milestone option.
    • Going forward, milestones should be named plugin-slug v.e.r.s.i.o.n so that this script can detect the relevant plugin automatically.
    • This will most likely be beneficial for other future workflow automation enhancements too.

You can test this by e.g. running:

  • npm run readme -- -m "performance-lab 3.0.0"
  • npm run readme -- -m "speculation-rules 1.1.0"

Don't commit the changes though, it's just for testing, particularly as both changelogs at this point contain a few manually added entries that are worth keeping.

@felixarntz felixarntz added [Type] Enhancement A suggestion for improvement of an existing feature Infrastructure Issues for the overall performance plugin infrastructure no milestone PRs that do not have a defined milestone for release Creating standalone plugins labels Mar 21, 2024
Copy link

github-actions bot commented Mar 21, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: felixarntz <flixos90@git.wordpress.org>
Co-authored-by: westonruter <westonruter@git.wordpress.org>
Co-authored-by: mukeshpanchal27 <mukesh27@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link
Member

@mukeshpanchal27 mukeshpanchal27 left a comment

Choose a reason for hiding this comment

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

Thanks for the PR @felixarntz. LGTM!

@mukeshpanchal27 mukeshpanchal27 merged commit 6e8f8c3 into trunk Mar 22, 2024
8 checks passed
@mukeshpanchal27 mukeshpanchal27 deleted the enhance/readme-command-for-standalone-plugins branch March 22, 2024 04:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Creating standalone plugins Infrastructure Issues for the overall performance plugin infrastructure no milestone PRs that do not have a defined milestone for release [Type] Enhancement A suggestion for improvement of an existing feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants