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

[Feature Request] Update readme.txt while deploying #112

Open
toolstack opened this issue Jan 8, 2023 · 3 comments
Open

[Feature Request] Update readme.txt while deploying #112

toolstack opened this issue Jan 8, 2023 · 3 comments
Assignees
Labels
type:enhancement New feature or request.

Comments

@toolstack
Copy link

Is your enhancement related to a problem? Please describe.
Currently the deployment script pushing the readme.txt file to wordpress.org as is, without doing any sanity checking/updating on the "Stable tag" or "Tested up to" fields.

This can cause issues if you forget to update these items before depoloyment, requiring a second deployment or manual updates on both GIT and SVN repos.

Describe the solution you'd like
The release script should automatically check these values and update them if required. Comminitting and pushing them back to GIT before deployment to the wordpress.org SVN.

Designs
Have PR... will submit it shortly 😁

It is in early stages and probably needs more options, like being able to disable the behaviour if it isn't wanted, but it gets the job done at the moment.

Describe alternatives you've considered
Keep doing it manually and hope my memory improves.

Additional context
None at this time.

@jeffpaul
Copy link
Member

jeffpaul commented Jan 9, 2023

@toolstack is the use case here where you attempt to do a deploy to WP.org and the "stable tag"/version from GH matches what's already the latest noted on WP.org? If so, I would expect that we might have the action fail rather than pick the next version number (as who's to say how it should increment in that case).

I also do not feel that we should automatically be bumping the "tested up to" if that doesn't match the latest major WP version number as some folks may not have tested that their latest plugin version in fact works with the latest WP major version.

@jeffpaul jeffpaul added the needs:feedback This requires reporter feedback to better understand the request. label Jan 9, 2023
@toolstack
Copy link
Author

@jeffpaul Use case is when deploying a new version of a plugin and you've forgotten to update the "stable tag" version in the readme file. This will cause the newly deployed version to not be used, but instead the old version still being zipped by wordpress.org for download. This is because wordpress.org uses the readme.txt's "stable tag" from trunk to determine which tag to actaully build from. If the readme has already been updated, no change will be made.

I was on the fence about disabling the "tested up to" check by default, it could go either way. Personally I think if you're deploying a new version of your plugin, you'd better have tested it on the latest releae of WordPress 🤷.

@github-actions github-actions bot removed the needs:feedback This requires reporter feedback to better understand the request. label Jan 9, 2023
@jeffpaul jeffpaul added the type:enhancement New feature or request. label Apr 10, 2023
@aaronware
Copy link

@toolstack you may want to take a look at release-please https://github.com/google-github-actions/release-please-action it's an action that does bumping of version numbers in any file you define

@jeffpaul jeffpaul modified the milestones: Future Release, 2.3.0 Jan 2, 2024
@jeffpaul jeffpaul moved this from In Progress to In Review in Open Source Practice Jan 2, 2024
@jeffpaul jeffpaul removed this from the 2.3.0 milestone Feb 5, 2024
@jeffpaul jeffpaul moved this from In Review to Done/Released in Open Source Practice Feb 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:enhancement New feature or request.
Projects
Archived in project
3 participants