Skip to content

Add release process to PR template#67

Merged
jssblck merged 2 commits intomainfrom
release-process
Mar 21, 2025
Merged

Add release process to PR template#67
jssblck merged 2 commits intomainfrom
release-process

Conversation

@jssblck
Copy link
Contributor

@jssblck jssblck commented Mar 20, 2025

Overview

Updates the PR template to show release instructions.

Checklist

  • If I changed code, I ran yarn build and committed resulting changes.
  • I added an example exercising this PRs functionality to .github/workflows/test.yml or explained why it doesn't make sense to do so.

@jssblck jssblck requested a review from a team as a code owner March 20, 2025 23:53
@jssblck jssblck requested review from spatten and removed request for a team March 20, 2025 23:53
Copy link
Contributor

@spatten spatten left a comment

Choose a reason for hiding this comment

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

Looks good!

I had a question about whether it makes sense to add instructions for creating $TAG, but it's not blocking

> After merging, make sure to create a new GitHub release and associated tag for this release.
> Additionally, if this is not a breaking change, make sure to update the `v1` tag:
>
> ```shell
Copy link
Contributor

Choose a reason for hiding this comment

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

Is the tag in $TAG manually created too? If there is, let's add the instruction to create that tag here too. I'm guessing it's something like this:

git checkout master
export TAG=v1.2.3
git tag -a $TAG -m "Releases $TAG"
git push origin $TAG

If not, then ignore me :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated the directive- I just create the releases with the GitHub release UI since that also creates a tag.

@jssblck
Copy link
Contributor Author

jssblck commented Mar 21, 2025

The tests are failing because there was no FOSSA analysis for the prior commit, and we can see that for some reason the GitHub workflow didn't run for the previous dependabot PR:
image

I don't see a reason this wouldn't work in the config, and from searching around it seems like some people say this sometimes "just happens" with auto merges? Seems suspicious but I'm going to force merge this PR in the hopes that is accurate.

@jssblck jssblck merged commit 3927769 into main Mar 21, 2025
1 of 2 checks passed
@jssblck jssblck deleted the release-process branch March 21, 2025 00:13
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.

2 participants