Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
qu1queee committed Feb 16, 2021
1 parent cf042ae commit 7fc15f0
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/development/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Unit tests are designed based on the following:
- Unit tests must pass in different OS distributions( e.g. linux, macOS ).
- Unit tests should be run in parallel.

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.
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.

When building unit-tests, try to follow:

Expand Down
2 changes: 1 addition & 1 deletion docs/proposals/buildstrategy-annotation-propagation.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ metadata:

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.

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.
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.

### Risks and Mitigations

Expand Down
2 changes: 1 addition & 1 deletion docs/proposals/runtime-image.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ As for `.spec.runtime.user.group`, it will take part of `USER` and `COPY --chown

### Tekton Tasks

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:
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:

```yml
---
Expand Down

0 comments on commit 7fc15f0

Please sign in to comment.