Skip to content
This repository was archived by the owner on Apr 17, 2025. It is now read-only.

Commit c715d45

Browse files
authored
Merge pull request #95 from adrianludwin/release
Update releasing docs
2 parents 5eb827d + 46a89d0 commit c715d45

File tree

2 files changed

+7
-13
lines changed

2 files changed

+7
-13
lines changed

cloudbuild.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ steps:
1010
echo Cloning from https://github.com/$_HNC_REPO_OWNER/hierarchical-namespaces
1111
git clone https://github.com/$_HNC_REPO_OWNER/hierarchical-namespaces
1212
cd hierarchical-namespaces
13-
echo Checking out hnc-$_HNC_IMG_TAG
14-
git checkout hnc-$_HNC_IMG_TAG
13+
echo Checking out $_HNC_IMG_TAG
14+
git checkout _HNC_IMG_TAG
1515
# Build the manifests and the kubectl plugin
1616
- name: golang:1.17
1717
entrypoint: 'bash'

docs/releasing.md

+5-11
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,15 @@ release, and each release is tagged in Git. Usually, a release will be preceeded
55
by one or more release candidates. Therefore, at a high level, the flow to
66
release a new _minor_ version of HNC is:
77

8-
1. Create a release branch named `hnc-vMAJOR.MINOR`, such as `hnc-v0.5`. Note
9-
that while regular semantic versioning is just `vMAJOR.MINOR`, we need to use
10-
the `hnc-` prefix because this repo contains projects other than HNC.
8+
1. Create a release branch named `vMAJOR.MINOR`, such as `v0.9`.
119
2. Use the Github UI to tag the first commit on that branch as
12-
`hnc-vMAJOR.MINOR.0-rc1`, such as `hnc-v0.5.0-rc1`. Release and test
10+
`vMAJOR.MINOR.0-rc1`, such as `v0.9.0-rc1`. Release and test
1311
according to the instructions below.
1412
3. If more release candidates are needed, number them sequentially. When you're
1513
happy with it, create a new release without the `-rcX` suffix, like
16-
`hnc-v0.5.0`.
14+
`v0.9.0`.
1715

18-
To release a _patch_ version of HNC (e.g. `hnc-v0.5.1`), follow the same steps
16+
To release a _patch_ version of HNC (e.g. `v0.5.1`), follow the same steps
1917
but without creating a branch. Note that patches can have release candidates
2018
just like minor releases.
2119

@@ -78,13 +76,9 @@ export HNC_PAT=<your personal access token>
7876
export HNC_IMG_TAG=<the semantic version, eg v0.1.0-rc1>
7977
```
8078

81-
Note that `HNC_IMG_TAG` does _not_ include the `hnc-` prefix. That is because
82-
the image tag will only apply to HNC images, while the _Git_ tag (and branch)
83-
names apply to this repo, which includes non-HNC projects.
84-
8579
### Create a release in Github
8680

87-
1. Ensure that the Github tag name is `hnc-$HNC_IMG_TAG`, like `hnc-v0.1.0-rc1`.
81+
1. Ensure that the Github tag name is `$HNC_IMG_TAG`, like `v0.1.0-rc1`.
8882
2. Start by copying the text from earlier releases - e.g., include installation
8983
instructions, key new features, a detailed change log, known issues, and a
9084
test signoff grid. Modify it as appropriate for your new release. The test

0 commit comments

Comments
 (0)