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

Chore: update documentation and issue template due to tag-based releases #2270

Merged
merged 5 commits into from
Aug 7, 2024

Conversation

lalver1
Copy link
Member

@lalver1 lalver1 commented Aug 1, 2024

Closes #1249

This PR, which updates the documentation and the New Release issue template, is the last followup to PR #2213.

@lalver1 lalver1 self-assigned this Aug 1, 2024
Copy link

github-actions bot commented Aug 1, 2024

Coverage report

This PR does not seem to contain any modification to coverable code.

Copy link

github-actions bot commented Aug 1, 2024

@lalver1 lalver1 marked this pull request as ready for review August 1, 2024 20:31
@lalver1 lalver1 requested a review from a team as a code owner August 1, 2024 20:31
@lalver1 lalver1 marked this pull request as draft August 1, 2024 20:44
@lalver1
Copy link
Member Author

lalver1 commented Aug 1, 2024

Sorry, moving this back to draft again. I just remembered about Issue #1249 and I'm thinking that adding a new section called 'Making a rollback' under Making a release can be used to close #1249 using this PR, if that makes sense. The process is already laid out in the ticket and the docs would look very similar.

@thekaveman
Copy link
Member

Maybe that can even be another type of release in the dropdown / instructions? E.g. Rollback

@lalver1
Copy link
Member Author

lalver1 commented Aug 1, 2024

Yep, that's a good idea, I'll add it as another type of release 👍

@lalver1 lalver1 force-pushed the chore/update-release-docs branch 2 times, most recently from c345591 to 3e72043 Compare August 2, 2024 03:48
@lalver1
Copy link
Member Author

lalver1 commented Aug 2, 2024

Just a note: Since we delete the branch associated with a PR once a PR is merged, I thought that this might create a problem for our hotfix and rollback release processes (since a tag is created on the temporary branches that will get deleted once the hotfix or rollback is merged into main), but it looks like there won't be an issue since a branch is only a pointer to a commit, so the commit associated with the tag will exist even if the branch is deleted after it is merged.

@lalver1 lalver1 marked this pull request as ready for review August 2, 2024 14:14
@thekaveman
Copy link
Member

Just a note: Since we delete the branch associated with a PR once a PR is merged, I thought that this might create a problem for our hotfix and rollback release processes (since a tag is created on the temporary branches that will get deleted once the hotfix or rollback is merged into main), but it looks like there won't be an issue since a branch is only a pointer to a commit, so the commit associated with the tag will exist even if the branch is deleted after it is merged.

Interesting... that would seem to mean we don't need to keep test and prod branches around then??

@lalver1
Copy link
Member Author

lalver1 commented Aug 2, 2024

Yep, it looks like we don't need to keep the test and prod branches since as long as there is a branch or a tag pointing to a commit, git's garbage collector won't remove the commit. But I still feel uneasy about removing test and prod, it's not likely, but what if GitHub has a slightly different implementation of this behavior and we lose the past releases 😨.
And, we'll probably get warnings similar to this one:

image

It corresponds to -rc6 that was on a branch that didn't get merged into main. My guess is that the previous releases will behave the same way, so we may just want to keep test and prod?

Copy link
Member

@thekaveman thekaveman left a comment

Choose a reason for hiding this comment

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

This is great. Just a few minor suggestions to add some more context, and a couple notes on wording.

One change that I do think we should make for Hotfix and Rollback is that we should be starting from the last known good release tag, not the last known good commit.

Obviously those are the same thing, but we should be primed to think about releases/versions and not so much commits when talking about these types of releases.

.github/ISSUE_TEMPLATE/release.yml Outdated Show resolved Hide resolved
docs/deployment/.pages Outdated Show resolved Hide resolved
docs/deployment/hotfix.md Outdated Show resolved Hide resolved
docs/deployment/release.md Outdated Show resolved Hide resolved
docs/deployment/rollback.md Outdated Show resolved Hide resolved
docs/development/commits-branches-merging.md Outdated Show resolved Hide resolved
docs/development/commits-branches-merging.md Show resolved Hide resolved
docs/deployment/release.md Outdated Show resolved Hide resolved
Copy link
Member

@angela-tran angela-tran left a comment

Choose a reason for hiding this comment

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

Great work on this so far @lalver1

Left some comments / questions

.github/ISSUE_TEMPLATE/release.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release.yml Outdated Show resolved Hide resolved
docs/deployment/hotfix.md Show resolved Hide resolved
docs/deployment/rollback.md Outdated Show resolved Hide resolved
@lalver1 lalver1 force-pushed the chore/update-release-docs branch from 3e72043 to 66ac896 Compare August 6, 2024 17:05
.github/ISSUE_TEMPLATE/release.yml Outdated Show resolved Hide resolved
docs/deployment/.pages Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release.yml Outdated Show resolved Hide resolved
docs/deployment/rollback.md Outdated Show resolved Hide resolved
@lalver1 lalver1 force-pushed the chore/update-release-docs branch from e7742f2 to 828ce67 Compare August 6, 2024 23:19
@lalver1 lalver1 requested a review from thekaveman August 6, 2024 23:39
Copy link
Member

@thekaveman thekaveman left a comment

Choose a reason for hiding this comment

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

Very nice!

@lalver1 lalver1 merged commit 24b5915 into main Aug 7, 2024
14 checks passed
@lalver1 lalver1 deleted the chore/update-release-docs branch August 7, 2024 18:07
@lalver1
Copy link
Member Author

lalver1 commented Aug 7, 2024

Thanks for the helpful reviews and suggestions @angela-tran and @thekaveman !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Write down rollback procedure
3 participants