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

Add support to automatically update the "Stable tag" and "Tested up to" lines in the readme.txt during deployment. #113

Closed
wants to merge 6 commits into from

Conversation

toolstack
Copy link

Description of the Change

Add support to automatically update the "Stable tag" and "Tested up to" lines in the readme.txt during deployment.

Closes #112

How to test the Change

Trigger a new deployment.

Changelog Entry

Added - Support for updating readme.txt "Tested up to" and "Stable tag" automatically as part of the deployment.

Credits

Props @toolstack

Checklist:

  • I agree to follow this project's Code of Conduct.
  • I have updated the documentation accordingly.
  • [] I have added tests to cover my change.
  • All new and existing tests pass.

@jeffpaul jeffpaul added this to the Future Release milestone Jan 9, 2023
README.md Outdated Show resolved Hide resolved
@jeffpaul jeffpaul added the needs:refresh This requires a refreshed PR to resolve. label Apr 10, 2023
@jeffpaul jeffpaul added the needs:feedback This requires reporter feedback to better understand the request. label Apr 24, 2023
Both "Stable tag" and "Tested up to" are updated (if required) and committed back to the repo, along with the tag being updated to include the new version of the readme file.
@toolstack toolstack requested a review from a team as a code owner September 1, 2023 00:20
@toolstack toolstack requested review from dkotter and removed request for a team September 1, 2023 00:20
As per discussion, make the default to not update the WP Version during a release, but have a flag to enable it.
@jeffpaul jeffpaul changed the title Readme updates Add support to automatically update the "Stable tag" and "Tested up to" lines in the readme.txt during deployment. Jan 2, 2024
@jeffpaul jeffpaul requested a review from a team January 2, 2024 17:27
@jeffpaul jeffpaul modified the milestones: Future Release, 2.3.0 Jan 2, 2024
@jeffpaul jeffpaul requested review from a team and removed request for a team January 16, 2024 15:58
@jeffpaul jeffpaul removed the request for review from dkotter January 29, 2024 14:04
@jeffpaul
Copy link
Member

In re-reviewing this, I don't think that our primary use case (or even an optional case here) would be to update the plugin source in GH from values on WP.org. I would expect that the values on GH should be updating WP.org (and not vice verse as I think this PR would do) and as such would recommend we close out this PR. @dkotter thoughts?

@dkotter
Copy link
Collaborator

dkotter commented Jan 29, 2024

In re-reviewing this, I don't think that our primary use case (or even an optional case here) would be to update the plugin source in GH from values on WP.org. I would expect that the values on GH should be updating WP.org (and not vice verse as I think this PR would do) and as such would recommend we close out this PR. @dkotter thoughts?

Yes, I agree with that and also agree with your initial comment here: #112 (comment). I think the most we should do here is have the deploy fail if the version number hasn't been bumped but I would not expect this action to automatically update that version and commit it back to GitHub.

@toolstack
Copy link
Author

In re-reviewing this, I don't think that our primary use case (or even an optional case here) would be to update the plugin source in GH from values on WP.org. I would expect that the values on GH should be updating WP.org (and not vice verse as I think this PR would do) and as such would recommend we close out this PR. @dkotter thoughts?

This PR pulls the current WP version from WP.org (through the update api), and then updates GitHub before the push out to wp.org's plugin directory. This ensure that both GH and WP's repo's are up to date.

@github-actions github-actions bot removed the needs:feedback This requires reporter feedback to better understand the request. label Jan 29, 2024
@toolstack
Copy link
Author

Yes, I agree with that and also agree with your initial comment here: #112 (comment). I think the most we should do here is have the deploy fail if the version number hasn't been bumped but I would not expect this action to automatically update that version and commit it back to GitHub.

I'm fine with not merging this if it's considered out of scope for the action. I wouldn't want it to fail due to the non-updated value, that would seem heavy handed if the user wanted that to be the result (aka, perhaps the plugin doesn't work with newer versions of WP yet).

If the decision is to reject the change I'll fork the action (or maybe a separate action that just does the update) and release my own as I do think this is a useful feature to have.

@jeffpaul
Copy link
Member

jeffpaul commented Feb 5, 2024

@toolstack that sounds reasonable to me, thanks!

@jeffpaul jeffpaul closed this Feb 5, 2024
@jeffpaul jeffpaul removed this from the 2.3.0 milestone Feb 5, 2024
@AlecRust
Copy link
Contributor

I'll fork the action (or maybe a separate action that just does the update) and release my own

Just FYI there are existing actions that can do this, like mine 🙂

My personal preference here is to manage all three things separately, "Stable tag" as part of the release process (example) "Tested up to" as a PR that gets created, and the plugin deploy via this action. This action should just deploy imo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs:refresh This requires a refreshed PR to resolve.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request] Update readme.txt while deploying
4 participants