Skip to content

Commit

Permalink
Update RELEASE_GUIDE
Browse files Browse the repository at this point in the history
Reflect the NEW_RELEASE_NOTES process
  • Loading branch information
bejado authored Mar 9, 2023
1 parent 7cca872 commit 673c110
Showing 1 changed file with 12 additions and 57 deletions.
69 changes: 12 additions & 57 deletions RELEASE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,7 @@ Before starting, ensure that each of these branches is up-to-date with origin:

It should have the version corresponding to its name, $RELEASE.

## 1. Update RELEASE_NOTES.md on the rc branch.

Checkout the rc/$RELEASE branch. In RELEASE_NOTES.md, locate the header corresponding to $RELEASE
and write release notes. To see which commits make up the release, run:

```
build/common/release.sh -c rc/$RELEASE
```

Commit the changes to rc/$RELEASE with the title:

```
Update RELEASE_NOTES for $RELEASE
```

## 2. Bump versions on main to $RELEASE.
## 1. Bump versions on main to $RELEASE.

Checkout main and run the following command to bump Filament's version to $RELEASE:

Expand All @@ -44,49 +29,19 @@ Release Filament $RELEASE

Do not push to origin yet.

## 3. Cherry-pick RELEASE_NOTES change from rc branch to main.

```
git cherry-pick rc/$RELEASE
```
## 2. Update RELEASE_NOTES.md on main.

Update the headers. The "main branch" header becomes a header for $NEXT_RELEASE, and a new "main
branch" header is added.

For example, this:

```
## main branch
- foo
- bar
## v1.9.3
- baz
- bat
```

becomes:

```
## main branch
## v1.9.4
- foo
- bar
## v1.9.3
- baz
- bat
```
Create a new header in RELEASE_NOTES.md for $NEXT_RELEASE. Copy the release notes in
NEW_RELEASE_NOTES.md to RELEASE_NOTES.md under the new header. Clear NEW_RELEASE_NOTES.md.

Ammend these changes to the cherry-picked change.
Amend these changes to the "Release Filament $RELEASE" commit.

```
git add -u
git commit --amend --no-edit
```

## 4. Run release script.
## 3. Run release script.

```
build/common/release.sh rc/$RELEASE rc/$NEXT_RELEASE
Expand All @@ -95,13 +50,13 @@ build/common/release.sh rc/$RELEASE rc/$NEXT_RELEASE
This script will merge rc/$RELEASE into release, delete the rc branch, and create a new rc
branch called rc/$NEXT_RELEASE. Verify that everything looks okay locally.

## 5. Push the release branch.
## 4. Push the release branch.

```
git push origin release
```

## 6. Create the GitHub release.
## 5. Create the GitHub release.

Use the GitHub UI to create a GitHub release corresponding to $RELEASE version.
Make sure the target is set to the release branch.
Expand All @@ -114,7 +69,7 @@ This step is optional. The old rc branch may be left alive for a few weeks for p
git push origin --delete rc/$RELEASE
```

## 8. Bump the version on the new rc branch to $NEXT_RELEASE.
## 6. Bump the version on the new rc branch to $NEXT_RELEASE.

```
git checkout rc/$NEXT_RELEASE
Expand All @@ -127,19 +82,19 @@ Commit the changes to rc/$NEXT_RELEASE with the title:
Bump version to $NEXT_RELEASE
```

## 9. Push main.
## 7. Push main.

```
git push origin main
```

## 10. Push the new rc branch.
## 8. Push the new rc branch.

```
git push origin -u rc/$NEXT_RELEASE
```

## 11. Rebuild the GitHub release (if failed).
## 9. Rebuild the GitHub release (if failed).

Sometimes the GitHub release job will fail. In this case, you can manually re-run the release job.

Expand Down

0 comments on commit 673c110

Please sign in to comment.