Skip to content

Commit 2e2d174

Browse files
authored
Clarify create-functions release doc (#347)
* Clarify upreving package.json mustache file * Update CONTRIBUTING.md * Update CONTRIBUTING.md
1 parent 2e84b68 commit 2e2d174

File tree

1 file changed

+21
-8
lines changed

1 file changed

+21
-8
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -141,25 +141,38 @@ Before releasing major changes, you first want to create a `rc` release.
141141
1. In pristine git repo, make changes following this
142142
[Example](https://github.com/GoogleContainerTools/kpt-functions-sdk/pull/102/files)
143143
but specifying an rc suffix (e.g. `0.16.0-rc.1`)
144+
145+
You should uprev any dependencies in [package.json template](https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/master/ts/create-kpt-functions/templates/package.json.mustache). This includes the two 1st-party NPM packages as well as third-party dependencies.
144146
2. Create a PR and commit.
145147
3. Create a release in GitHub which pushes the package to NPM registry. But,
146148
because this is marked as an `rc` release, it will not be pulled by default
147149
form the NPM registry.
148150
[Example](https://github.com/GoogleContainerTools/kpt-functions-sdk/releases/tag/release-create-kpt-functions-v0.16.0)
149-
4. In a separate PR, update the dependant packages following this
151+
4. You can invoke the the released CLI locally:
152+
```console
153+
154+
```
155+
5. In a separate PR, update the dependant packages following this
150156
[Example](https://github.com/GoogleContainerTools/kpt-functions-sdk/pull/103/files)
151157
(Ignore workflow change)
152158

153-
5. Create a PR and commit. This PR ensures that dependant packages are tested
159+
6. Create a PR and commit. This PR ensures that dependant packages are tested
154160
against the `rc` release.
155161

156-
6. Once you are confident that the `rc` release is good, you can then repeat
162+
7. Once you are confident that the `rc` release is good, you can then repeat
157163
the process with out the `rc` suffix (e.g. `0.16.0`).
158-
7. You can test the CLI for creating a new package using this script:
159-
```console
160-
./scripts/init-package.sh
161-
```
162-
This will update the the `init-package` in the repo.
164+
8. You can manually the the released CLI locally:
165+
```console
166+
# This is equivilant to npx create-kpt-functions@latest
167+
npm init kpt-functions
168+
```
169+
170+
However, the following script automatically invokes the CLI,
171+
and updates the `init-package` in the repo:
172+
173+
```console
174+
./scripts/init-package.sh
175+
```
163176

164177
#### GitHub Release Workflows
165178

0 commit comments

Comments
 (0)