Skip to content

Commit b70681c

Browse files
Apply suggestions from code review
Co-authored-by: Heitor Tashiro Sergent <[email protected]>
1 parent 654af82 commit b70681c

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

docs/maintenance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Maintenance of k6 Operator
22

3-
Just as with any project, k6 Operator requires regular maintenance updates to stay up-to-date with the changes and patches. There are several types of maintenance updates in this project, and they need to be addressed at different frequencies. Let's take a closer look at each of them.
3+
Just as with any project, k6 Operator requires regular maintenance updates to stay up-to-date with any changes and patches. There are several types of maintenance updates in this project, and they need to be addressed at different frequencies. Let's take a closer look at each of them.
44

55
## Update of dependencies
66

docs/release-workflow.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## Release workflow
22

3-
Current release process is rather heavy on manual interventions:
3+
The current release process is rather heavy on manual interventions:
44

55
1. _manual_ Create a Github release.
66
2. "Release" workflow is triggered:
7-
- build of new Docker images from `main`
7+
- Build new Docker images from `main`
88
- PR to update bundle
99
3. _manual_ Review and merge PR with bundle update.
1010
4. _manual_ Commit and push the following changes:
@@ -24,4 +24,4 @@ Current release process is rather heavy on manual interventions:
2424

2525
### Errors on release
2626

27-
Currently, if Helm JSON schema is not up-to-date, the Helm release will fail. [`helm-release.yaml` workflow](https://github.com/grafana/k6-operator/blob/main/.github/workflows/helm-release.yaml) will create a PR with the necessary changes and `exit 1` to force the maintainer to review the changes and re-run the release workflow.
27+
Currently, if the Helm JSON schema is not up-to-date, the Helm release will fail. [`helm-release.yaml` workflow](https://github.com/grafana/k6-operator/blob/main/.github/workflows/helm-release.yaml) will create a PR with the necessary changes and `exit 1` to force the maintainer to review the changes and re-run the release workflow.

docs/releases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ The `main` branch of the k6 Operator should be seen as a development branch. It
8080

8181
We do not commit to any stability guarantees of Golang interfaces at this point in time. However, in practice, the [Golang package for CRD types](https://github.com/grafana/k6-operator/tree/main/api/v1alpha1) is closely tied to changes in CRD and follows the same guidelines as the corresponding CRD type.
8282

83-
### How release is done
83+
### Release process
8484

8585
Release procedure is fully described in the [internal docs](https://github.com/grafana/k6-operator/blob/main/docs/release-workflow.md).
8686

0 commit comments

Comments
 (0)