Skip to content

Commit f117b12

Browse files
committed
more edits from review feedback.
Signed-off-by: Jason Tang <[email protected]>
1 parent 1f3547a commit f117b12

File tree

5 files changed

+45
-25
lines changed

5 files changed

+45
-25
lines changed

content/master/guides/extensions-release-process.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,10 @@ YAML file that pushes to `xpkg.crossplane.io` without extra configuration.
104104
To build and push a new release to the registry:
105105

106106
1. Cut a release branch with the `release-` prefix in the name in the GitHub UI. For example, `release-0.1`.
107-
2. Tag the desired commit on release branch with a valid semver release tag.
108-
For example, `v0.1.0`. By default, this is the inferred reference pushed to the registry.
107+
2. Tag the desired commit on release branch with a valid semver release tag for a corresponding
108+
GitHub Release. For example, `v0.1.0`.
109109
3. Manually run the workflow in the GitHub UI, targeting the release branch from step 1.
110+
The workflow generates a default version string if user input isn't provided.
110111

111112
See [branching conventions](#branching-conventions) for more details on tagging
112113
practices and optionally overriding the inferred git tag version.
@@ -138,11 +139,14 @@ the job to `ghcr.io` using the workflow's ephemeral GitHub OIDC token.
138139
```
139140
140141
{{< hint "important" >}}
141-
By default, the job's OIDC token don't have permission to write packages
142+
By default, the job's OIDC token doesn't have permission to write packages
142143
to `ghcr.io`. Permissions are configurable in the GitHub repository's settings
143144
or declared
144145
[explicitly](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github_token)
145146
in the workflow definition YAML file.
147+
148+
Writing packages requires a `permissions` block with `packages: write` if it
149+
isn't configured elsewhere for the repository.
146150
{{< /hint >}}
147151

148152
For other registries, it's still best practice to reference credentials as
@@ -178,8 +182,8 @@ process is to cut a release branch `release-0.1` at the git commit
178182
where it builds from, and tag it as `v0.1.0`.
179183

180184
{{< hint "note" >}}
181-
Some custom workflows may accept an explicit input for the remote reference,
182-
which overrides inferring from a git ref or tag. The [`ci.yml`](https://github.com/crossplane-contrib/function-python/blob/main/.github/workflows/ci.yml)
185+
Some custom workflows may accept an explicit input for the remote reference instead of
186+
inferring it from a git ref. The [`ci.yml`](https://github.com/crossplane-contrib/function-python/blob/main/.github/workflows/ci.yml)
183187
file for `crossplane-contrib/function-python` is a good example.
184188
{{< /hint >}}
185189

content/v1.18/guides/extensions-release-process.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,10 @@ YAML file that pushes to `xpkg.crossplane.io` without extra configuration.
104104
To build and push a new release to the registry:
105105

106106
1. Cut a release branch with the `release-` prefix in the name in the GitHub UI. For example, `release-0.1`.
107-
2. Tag the desired commit on release branch with a valid semver release tag.
108-
For example, `v0.1.0`. By default, this is the inferred reference pushed to the registry.
107+
2. Tag the desired commit on release branch with a valid semver release tag for a corresponding
108+
GitHub Release. For example, `v0.1.0`.
109109
3. Manually run the workflow in the GitHub UI, targeting the release branch from step 1.
110+
The workflow generates a default version string if user input isn't provided.
110111

111112
See [branching conventions](#branching-conventions) for more details on tagging
112113
practices and optionally overriding the inferred git tag version.
@@ -138,11 +139,14 @@ the job to `ghcr.io` using the workflow's ephemeral GitHub OIDC token.
138139
```
139140
140141
{{< hint "important" >}}
141-
By default, the job's OIDC token don't have permission to write packages
142+
By default, the job's OIDC token doesn't have permission to write packages
142143
to `ghcr.io`. Permissions are configurable in the GitHub repository's settings
143144
or declared
144145
[explicitly](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github_token)
145146
in the workflow definition YAML file.
147+
148+
Writing packages requires a `permissions` block with `packages: write` if it
149+
isn't configured elsewhere for the repository.
146150
{{< /hint >}}
147151

148152
For other registries, it's still best practice to reference credentials as
@@ -178,8 +182,8 @@ process is to cut a release branch `release-0.1` at the git commit
178182
where it builds from, and tag it as `v0.1.0`.
179183

180184
{{< hint "note" >}}
181-
Some custom workflows may accept an explicit input for the remote reference,
182-
which overrides inferring from a git ref or tag. The [`ci.yml`](https://github.com/crossplane-contrib/function-python/blob/main/.github/workflows/ci.yml)
185+
Some custom workflows may accept an explicit input for the remote reference instead of
186+
inferring it from a git ref. The [`ci.yml`](https://github.com/crossplane-contrib/function-python/blob/main/.github/workflows/ci.yml)
183187
file for `crossplane-contrib/function-python` is a good example.
184188
{{< /hint >}}
185189

content/v1.19/guides/extensions-release-process.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,10 @@ YAML file that pushes to `xpkg.crossplane.io` without extra configuration.
104104
To build and push a new release to the registry:
105105

106106
1. Cut a release branch with the `release-` prefix in the name in the GitHub UI. For example, `release-0.1`.
107-
2. Tag the desired commit on release branch with a valid semver release tag.
108-
For example, `v0.1.0`. By default, this is the inferred reference pushed to the registry.
107+
2. Tag the desired commit on release branch with a valid semver release tag for a corresponding
108+
GitHub Release. For example, `v0.1.0`.
109109
3. Manually run the workflow in the GitHub UI, targeting the release branch from step 1.
110+
The workflow generates a default version string if user input isn't provided.
110111

111112
See [branching conventions](#branching-conventions) for more details on tagging
112113
practices and optionally overriding the inferred git tag version.
@@ -138,11 +139,14 @@ the job to `ghcr.io` using the workflow's ephemeral GitHub OIDC token.
138139
```
139140
140141
{{< hint "important" >}}
141-
By default, the job's OIDC token don't have permission to write packages
142+
By default, the job's OIDC token doesn't have permission to write packages
142143
to `ghcr.io`. Permissions are configurable in the GitHub repository's settings
143144
or declared
144145
[explicitly](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github_token)
145146
in the workflow definition YAML file.
147+
148+
Writing packages requires a `permissions` block with `packages: write` if it
149+
isn't configured elsewhere for the repository.
146150
{{< /hint >}}
147151

148152
For other registries, it's still best practice to reference credentials as
@@ -178,8 +182,8 @@ process is to cut a release branch `release-0.1` at the git commit
178182
where it builds from, and tag it as `v0.1.0`.
179183

180184
{{< hint "note" >}}
181-
Some custom workflows may accept an explicit input for the remote reference,
182-
which overrides inferring from a git ref or tag. The [`ci.yml`](https://github.com/crossplane-contrib/function-python/blob/main/.github/workflows/ci.yml)
185+
Some custom workflows may accept an explicit input for the remote reference instead of
186+
inferring it from a git ref. The [`ci.yml`](https://github.com/crossplane-contrib/function-python/blob/main/.github/workflows/ci.yml)
183187
file for `crossplane-contrib/function-python` is a good example.
184188
{{< /hint >}}
185189

content/v1.20/guides/extensions-release-process.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,10 @@ YAML file that pushes to `xpkg.crossplane.io` without extra configuration.
104104
To build and push a new release to the registry:
105105

106106
1. Cut a release branch with the `release-` prefix in the name in the GitHub UI. For example, `release-0.1`.
107-
2. Tag the desired commit on release branch with a valid semver release tag.
108-
For example, `v0.1.0`. By default, this is the inferred reference pushed to the registry.
107+
2. Tag the desired commit on release branch with a valid semver release tag for a corresponding
108+
GitHub Release. For example, `v0.1.0`.
109109
3. Manually run the workflow in the GitHub UI, targeting the release branch from step 1.
110+
The workflow generates a default version string if user input isn't provided.
110111

111112
See [branching conventions](#branching-conventions) for more details on tagging
112113
practices and optionally overriding the inferred git tag version.
@@ -138,11 +139,14 @@ the job to `ghcr.io` using the workflow's ephemeral GitHub OIDC token.
138139
```
139140
140141
{{< hint "important" >}}
141-
By default, the job's OIDC token don't have permission to write packages
142+
By default, the job's OIDC token doesn't have permission to write packages
142143
to `ghcr.io`. Permissions are configurable in the GitHub repository's settings
143144
or declared
144145
[explicitly](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github_token)
145146
in the workflow definition YAML file.
147+
148+
Writing packages requires a `permissions` block with `packages: write` if it
149+
isn't configured elsewhere for the repository.
146150
{{< /hint >}}
147151

148152
For other registries, it's still best practice to reference credentials as
@@ -178,8 +182,8 @@ process is to cut a release branch `release-0.1` at the git commit
178182
where it builds from, and tag it as `v0.1.0`.
179183

180184
{{< hint "note" >}}
181-
Some custom workflows may accept an explicit input for the remote reference,
182-
which overrides inferring from a git ref or tag. The [`ci.yml`](https://github.com/crossplane-contrib/function-python/blob/main/.github/workflows/ci.yml)
185+
Some custom workflows may accept an explicit input for the remote reference instead of
186+
inferring it from a git ref. The [`ci.yml`](https://github.com/crossplane-contrib/function-python/blob/main/.github/workflows/ci.yml)
183187
file for `crossplane-contrib/function-python` is a good example.
184188
{{< /hint >}}
185189

content/v2.0-preview/guides/extensions-release-process.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,10 @@ YAML file that pushes to `xpkg.crossplane.io` without extra configuration.
104104
To build and push a new release to the registry:
105105

106106
1. Cut a release branch with the `release-` prefix in the name in the GitHub UI. For example, `release-0.1`.
107-
2. Tag the desired commit on release branch with a valid semver release tag.
108-
For example, `v0.1.0`. By default, this is the inferred reference pushed to the registry.
107+
2. Tag the desired commit on release branch with a valid semver release tag for a corresponding
108+
GitHub Release. For example, `v0.1.0`.
109109
3. Manually run the workflow in the GitHub UI, targeting the release branch from step 1.
110+
The workflow generates a default version string if user input isn't provided.
110111

111112
See [branching conventions](#branching-conventions) for more details on tagging
112113
practices and optionally overriding the inferred git tag version.
@@ -138,11 +139,14 @@ the job to `ghcr.io` using the workflow's ephemeral GitHub OIDC token.
138139
```
139140
140141
{{< hint "important" >}}
141-
By default, the job's OIDC token don't have permission to write packages
142+
By default, the job's OIDC token doesn't have permission to write packages
142143
to `ghcr.io`. Permissions are configurable in the GitHub repository's settings
143144
or declared
144145
[explicitly](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github_token)
145146
in the workflow definition YAML file.
147+
148+
Writing packages requires a `permissions` block with `packages: write` if it
149+
isn't configured elsewhere for the repository.
146150
{{< /hint >}}
147151

148152
For other registries, it's still best practice to reference credentials as
@@ -178,8 +182,8 @@ process is to cut a release branch `release-0.1` at the git commit
178182
where it builds from, and tag it as `v0.1.0`.
179183

180184
{{< hint "note" >}}
181-
Some custom workflows may accept an explicit input for the remote reference,
182-
which overrides inferring from a git ref or tag. The [`ci.yml`](https://github.com/crossplane-contrib/function-python/blob/main/.github/workflows/ci.yml)
185+
Some custom workflows may accept an explicit input for the remote reference instead of
186+
inferring it from a git ref. The [`ci.yml`](https://github.com/crossplane-contrib/function-python/blob/main/.github/workflows/ci.yml)
183187
file for `crossplane-contrib/function-python` is a good example.
184188
{{< /hint >}}
185189

0 commit comments

Comments
 (0)