Skip to content

Commit 5149818

Browse files
Update formatting in RELEASING.md:
Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>
1 parent f59e330 commit 5149818

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

RELEASING.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,36 @@ For version v0.x.y:
44

55
## Prerequisites
66

7-
1. Update the `VERSION`, `VERSION_ID`, and `PRETTY_NAME` values in the `hook.yaml` file under `files -> "- path: etc/os-release"` to use `0.x.y`. This can be done with:
7+
1. Update the `VERSION`, `VERSION_ID`, and `PRETTY_NAME` values in the `hook.yaml` file under `files -> "- path: etc/os-release"` to use `0.x.y`
88

9-
```bash
10-
make update-os-release NEW_VERSION=0.x.y
11-
```
9+
```bash
10+
make update-os-release NEW_VERSION=0.x.y
11+
```
1212

1313
1. Commit, push, PR, and merge the version changes
14-
- `git commit -sm "Update version to v0.x.y" hook.yaml`
14+
15+
```bash
16+
git commit -sm "Update version to v0.x.y" hook.yaml
17+
```
1518

1619
## Release Process
1720

1821
1. Create the annotated tag
22+
1923
> NOTE: To use your GPG signature when pushing the tag, use `SIGN_TAG=1 ./contrib/tag-release.sh v0.x.y` instead
20-
- `./contrib/tag-release.sh v0.x.y`
24+
25+
```bash
26+
./contrib/tag-release.sh v0.x.y
27+
```
28+
2129
1. Push the tag to the GitHub repository. This will automatically trigger a [Github Action](https://github.com/tinkerbell/hook/actions) to create a release.
30+
2231
> NOTE: `origin` should be the name of the remote pointing to `github.com/tinkerbell/boots`
23-
- `git push origin v0.x.y`
32+
33+
```bash
34+
git push origin v0.x.y
35+
```
36+
2437
1. Review the release on GitHub.
2538

2639
### Permissions

0 commit comments

Comments
 (0)