Skip to content

Commit 7fc15f0

Browse files
committed
updated docs
1 parent cf042ae commit 7fc15f0

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

docs/development/testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Unit tests are designed based on the following:
6767
- Unit tests must pass in different OS distributions( e.g. linux, macOS ).
6868
- Unit tests should be run in parallel.
6969

70-
Because we use Ginkgo for this, each controller [package](https://github.com/shipwright-io/build/tree/master/pkg/controller) requires a `suite_test.go` file and a relative controller test file. You can generate a suite by running `ginkgo bootstrap` under the package directory. For testing an specific controller class, you can generate the testing class by running `ginkgo generate` under the package directory.
70+
Because we use Ginkgo for this, each controller [package](https://github.com/shipwright-io/build/tree/master/pkg/reconciler) requires a `suite_test.go` file and a relative controller test file. You can generate a suite by running `ginkgo bootstrap` under the package directory. For testing an specific controller class, you can generate the testing class by running `ginkgo generate` under the package directory.
7171

7272
When building unit-tests, try to follow:
7373

docs/proposals/buildstrategy-annotation-propagation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ metadata:
113113

114114
The implementation requires the [BuilderStrategy interface](../../pkg/apis/build/v1alpha1/buildstrategy.go) to be extended with a `GetAnnotations` functions that is implemented in the [BuildStrategy](../../pkg/apis/build/v1alpha1/buildstrategy_types.go) and [ClusterBuildStrategy](../../pkg/apis/build/v1alpha1/clusterbuildstrategy_types.go) types by returning the object's annotations.
115115

116-
The assignment of the `TaskRun` annotations needs to be done in the [generate_taskrun.go](../../pkg/controller/buildrun/generate_taskrun.go) file in the `GenerateTaskRun` function. The annotations from the build strategy need to be copied to the `TaskRun` except those using one of the four Shipwright Build owned prefixes mentioned under [Proposal](#proposal), and except the `kubectl.kubernetes.io/last-applied-configuration` annotation.
116+
The assignment of the `TaskRun` annotations needs to be done in the [generate_taskrun.go](../../pkg/reconciler/buildrun/resources/taskrun.go) file in the `GenerateTaskRun` function. The annotations from the build strategy need to be copied to the `TaskRun` except those using one of the four Shipwright Build owned prefixes mentioned under [Proposal](#proposal), and except the `kubectl.kubernetes.io/last-applied-configuration` annotation.
117117

118118
### Risks and Mitigations
119119

docs/proposals/runtime-image.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ As for `.spec.runtime.user.group`, it will take part of `USER` and `COPY --chown
110110

111111
### Tekton Tasks
112112

113-
During the generation of [Tekton's `TaskRun`](https://github.com/shipwright-io/build/blob/17fa2792cc14288adea0bafa624e85b6db7232e0/pkg/controller/buildrun/generate_taskrun.go#L47), we have the opportunity to add extra steps. The first one to be added is the rendering of the `Dockerfile.runtime`, for instance:
113+
During the generation of [Tekton's `TaskRun`](https://github.com/shipwright-io/build/blob/master/pkg/reconciler/buildrun/resources/taskrun.go#L58), we have the opportunity to add extra steps. The first one to be added is the rendering of the `Dockerfile.runtime`, for instance:
114114

115115
```yml
116116
---

0 commit comments

Comments
 (0)