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

Keep previous example changes out of subsequent release PRs #234

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

jhkennedy
Copy link
Contributor

@jhkennedy jhkennedy commented Jan 17, 2025

I've always found it weird that for a release of version X, the example updates in the release PR are for version X-1.

We can eliminate those diffs instead by using examples update "hotfix" by doing a PR from the new tag^ -> main, and then merging that back to develop.

Notably, these X-1 changes will still appear in a tag-to-tag comparison because they would still be done after the tag is created. We'd have to work out some way to inject it before the tag if we wanted to eliminate that entirely. 🤔 though, that could be done as part of the bump-version workflow...


^ Update examples workflow checks out the refs for the context in which it's run. For tag push event, it'll check out the tag as seen here: https://github.com/ASFHyP3/actions/actions/runs/12657206611/job/35271475456#step:2:63


TODO:

@jhkennedy jhkennedy added the bumpless Changes to documentation, CI/CD pipelines, etc that don't affect the project's version label Jan 17, 2025
@jhkennedy
Copy link
Contributor Author

When thinking about this, it's essential to recognize that the develop branch is the default branch, and that branch's README is our primary documentation.

So, we want the examples in the README on the develop branch to be for the previous release, which is working currently.

This PR/discussion is just about how those changes appear in subsequent release PRs and in tag-to-tag (version) comparisons...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bumpless Changes to documentation, CI/CD pipelines, etc that don't affect the project's version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant