Skip to content

Commit

Permalink
Create 0.3.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelsauter committed Apr 7, 2022
1 parent 712cbbe commit 542c7e2
Show file tree
Hide file tree
Showing 13 changed files with 42 additions and 39 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ listed in the changelog.

## [Unreleased]

## [0.3.0] - 2022-04-07

### Added

- Apply labels to pipelines allowing easier identification for cleanup ([#358](https://github.com/opendevstack/ods-pipeline/issues/358))
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ For OpenShift Pipelines releases and its relationship to Tekton and OpenShift ve

| ods-pipeline | OpenShift Pipelines | ODS Core/Quickstarters |
|---|---|---|
| [0.3](https://github.com/opendevstack/ods-pipeline/releases/tag/v0.3.0) | 1.5 | 4.0.0 |
| [0.2](https://github.com/opendevstack/ods-pipeline/releases/tag/v0.2.0) | 1.5 | 4.0.0 |
| [0.1](https://github.com/opendevstack/ods-pipeline/releases/tag/v0.1.1) | 1.5 | 4.0.0 |

Expand Down
2 changes: 1 addition & 1 deletion cmd/artifact-download/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ func main() {
flag.Parse()

if opts.version {
fmt.Println("0.2.0")
fmt.Println("0.3.0")
os.Exit(0)
}

Expand Down
10 changes: 5 additions & 5 deletions deploy/ods-pipeline/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,21 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.2.0
version: 0.3.0

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
# follow Semantic Versioning. They should reflect the version the application is using.
# It is recommended to use it with quotes.
appVersion: "0.2.0"
appVersion: "0.3.0"

dependencies:
- name: images
version: 0.2.0
version: 0.3.0
condition: images.enabled
- name: setup
version: 0.2.0
version: 0.3.0
condition: setup.enabled
- name: tasks
version: 0.2.0
version: 0.3.0
condition: tasks.enabled
4 changes: 2 additions & 2 deletions deploy/ods-pipeline/charts/images/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.2.0
version: 0.3.0

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
# follow Semantic Versioning. They should reflect the version the application is using.
appVersion: "0.2.0"
appVersion: "0.3.0"
4 changes: 2 additions & 2 deletions deploy/ods-pipeline/charts/setup/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.2.0
version: 0.3.0

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
# follow Semantic Versioning. They should reflect the version the application is using.
appVersion: "0.2.0"
appVersion: "0.3.0"
4 changes: 2 additions & 2 deletions deploy/ods-pipeline/charts/tasks/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.2.0
version: 0.3.0

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
# follow Semantic Versioning. They should reflect the version the application is using.
appVersion: "0.2.0"
appVersion: "0.3.0"
4 changes: 2 additions & 2 deletions deploy/ods-pipeline/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
# ####################################### #
global:
# Image tag to use for images referenced by tasks.
imageTag: 0.2.0
imageTag: 0.3.0
# Suffix to append to the task name.
taskSuffix: -v0-2-0
taskSuffix: -v0-3-0
# Custom task kind (defaults to "Task")
# taskKind: "ClusterTask"
enabledTasks:
Expand Down
14 changes: 7 additions & 7 deletions docs/example-project.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,14 @@ pipeline:
- name: build-go
taskRef:
kind: Task
name: ods-build-go-v0-2-0
name: ods-build-go-v0-3-0
workspaces:
- name: source
workspace: shared-workspace
- name: package-image
taskRef:
kind: Task
name: ods-package-image-v0-2-0
name: ods-package-image-v0-3-0
runAfter:
- build-go
workspaces:
Expand All @@ -49,7 +49,7 @@ pipeline:
- name: deploy-helm
taskRef:
kind: Task
name: ods-deploy-helm-v0-2-0
name: ods-deploy-helm-v0-3-0
runAfter:
- package-image
workspaces:
Expand All @@ -74,14 +74,14 @@ pipeline:
- name: build-typescript
taskRef:
kind: Task
name: ods-build-typescript-v0-2-0
name: ods-build-typescript-v0-3-0
workspaces:
- name: source
workspace: shared-workspace
- name: package-image
taskRef:
kind: Task
name: ods-package-image-v0-2-0
name: ods-package-image-v0-3-0
runAfter:
- build-typescript
workspaces:
Expand All @@ -90,7 +90,7 @@ pipeline:
- name: deploy-helm
taskRef:
kind: Task
name: ods-deploy-helm-v0-2-0
name: ods-deploy-helm-v0-3-0
runAfter:
- package-image
workspaces:
Expand Down Expand Up @@ -134,7 +134,7 @@ pipeline:
- name: deploy-helm
taskRef:
kind: ClusterTask
name: ods-deploy-helm-v0-2-0
name: ods-deploy-helm-v0-3-0
workspaces:
- name: source
workspace: shared-workspace
Expand Down
22 changes: 11 additions & 11 deletions docs/getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -107,14 +107,14 @@ pipeline:
- name: backend-build-go
taskRef:
kind: Task
name: ods-build-go-v0-2-0
name: ods-build-go-v0-3-0
workspaces:
- name: source
workspace: shared-workspace
- name: backend-package-image
taskRef:
kind: Task
name: ods-package-image-v0-2-0
name: ods-package-image-v0-3-0
runAfter:
- backend-build-go
workspaces:
Expand All @@ -123,19 +123,19 @@ pipeline:
- name: backend-deploy
taskRef:
kind: Task
name: ods-deploy-helm-v0-2-0
name: ods-deploy-helm-v0-3-0
runAfter:
- backend-package-image
workspaces:
- name: source
workspace: shared-workspace
----

What has been done in Jenkins in `stageCheckFormat`, `stageLint`, `stageUnitTest`, `stageBuild` and `odsComponentStageScanWithSonar` is now done by the `ods-build-go-v0-2-0` task. If you have modified how the application is tested and built, or added further steps, you will need to create your own Tekton tasks reflecting those changes. See the link:authoring-tasks.adoc[authoring tasks] guide.
What has been done in Jenkins in `stageCheckFormat`, `stageLint`, `stageUnitTest`, `stageBuild` and `odsComponentStageScanWithSonar` is now done by the `ods-build-go-v0-3-0` task. If you have modified how the application is tested and built, or added further steps, you will need to create your own Tekton tasks reflecting those changes. See the link:authoring-tasks.adoc[authoring tasks] guide.

Building the container image is now done in `ods-package-image-v0-2-0` instead of in `odsComponentStageBuildOpenShiftImage`. The task continues to use the existing `docker/Dockerfile` file, which does not need to change much if at all. Consult the task reference in question for more information. In the case of Go, the link:tasks/ods-build-go.adoc[`ods-build-go` task reference] states that the resulting Go binary is named `app` and placed into the `docker` directory. Make sure that your `docker/Dockerfile` copies `app`, not e.g. `app_linux_amd64` (as is the default for an ODS 4.x based Go quickstarter).
Building the container image is now done in `ods-package-image-v0-3-0` instead of in `odsComponentStageBuildOpenShiftImage`. The task continues to use the existing `docker/Dockerfile` file, which does not need to change much if at all. Consult the task reference in question for more information. In the case of Go, the link:tasks/ods-build-go.adoc[`ods-build-go` task reference] states that the resulting Go binary is named `app` and placed into the `docker` directory. Make sure that your `docker/Dockerfile` copies `app`, not e.g. `app_linux_amd64` (as is the default for an ODS 4.x based Go quickstarter).

Finally, the application is deployed in `ods-deploy-helm-v0-2-0` as opposed to `odsComponentStageRolloutOpenShiftDeployment`.
Finally, the application is deployed in `ods-deploy-helm-v0-3-0` as opposed to `odsComponentStageRolloutOpenShiftDeployment`.
Let's look at this deployment piece in detail. The new Tekton task makes use of Helm to define and deploy the Kubernetes resources to use. Your existing repository might not define Kubernetes resources at all (this is the default), or they might be expressed as OpenShift templates (in a folder named `openshift`) and applied with link:https://github.com/opendevstack/tailor[Tailor]. ODS pipeline only supports Helm at the moment, and requires the Kubernetes resources (the Helm "chart") to be under version control as described below in the <<helm-chart,Helm Chart>> section.

After the `ods.yaml` and the Helm `chart` are added to the repository, the final step is to create a Bitbucket webhook pointing to the ODS pipeline installation. Disable the existing Jenkins webhook setting before creating a new one as described below in the <<webhook-configuration,Webhook Configuration>> section.
Expand Down Expand Up @@ -163,14 +163,14 @@ pipeline:
- name: backend-build-go
taskRef:
kind: Task
name: ods-build-go-v0-2-0
name: ods-build-go-v0-3-0
workspaces:
- name: source
workspace: shared-workspace
- name: backend-package-image
taskRef:
kind: Task
name: ods-package-image-v0-2-0
name: ods-package-image-v0-3-0
runAfter:
- backend-build-go
workspaces:
Expand All @@ -179,15 +179,15 @@ pipeline:
- name: backend-deploy
taskRef:
kind: Task
name: ods-deploy-helm-v0-2-0
name: ods-deploy-helm-v0-3-0
runAfter:
- backend-package-image
workspaces:
- name: source
workspace: shared-workspace
----

The `ods-package-image-v0-2-0` task assumes the Docker context in `docker`, and the `Dockerfile` located inside that folder. Therefore, create a folder `docker` and create a `Dockerfile` inside like this one:
The `ods-package-image-v0-3-0` task assumes the Docker context in `docker`, and the `Dockerfile` located inside that folder. Therefore, create a folder `docker` and create a `Dockerfile` inside like this one:

.Dockerfile
[source]
Expand All @@ -201,7 +201,7 @@ EXPOSE 8080
CMD ["./app"]
----

The `ods-deploy-helm-v0-2-0` requires a Helm chart to be present to deploy the Kubernetes resources for the application. Add it as described below in the <<helm-chart,Helm Chart>> section.
The `ods-deploy-helm-v0-3-0` requires a Helm chart to be present to deploy the Kubernetes resources for the application. Add it as described below in the <<helm-chart,Helm Chart>> section.

Finally, setup a Bitbucket webhook pointing to the ODS pipeline installation as described below in the <<webhook-configuration,Webhook Configuration>> section.

Expand Down
6 changes: 3 additions & 3 deletions docs/installation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Then, use `git subtree` to get the required sources. The following commands may

[source]
----
pipelineGitRef=master # Pick the version you want to install
pipelineGitRef=v0.3.0 # Pick the version you want to install
git fetch --depth=1 https://github.com/opendevstack/ods-pipeline.git $pipelineGitRef:ods-pipeline-$pipelineGitRef && \
git checkout ods-pipeline-$pipelineGitRef && \
Expand Down Expand Up @@ -113,7 +113,7 @@ You may fetch updates (e.g. new versions) of `ods-pipeline` like this:

[source]
----
pipelineGitRef=v0.2.0 # Pick the version you want to install
pipelineGitRef=v0.3.0 # Pick the version you want to install
git fetch --depth=1 https://github.com/opendevstack/ods-pipeline.git $pipelineGitRef:ods-pipeline-$pipelineGitRef && \
git checkout ods-pipeline-$pipelineGitRef && \
Expand All @@ -126,4 +126,4 @@ Now, compare if any new values have been introduced and update the values and se

Afterwards you can update the resources via `./install.sh -n <your_cd_namespace> -f values.yaml,secrets.yaml`. You may also use `--dry-run` to see the changes first.

Once the resources in your namespace are updated, you can update the `ods.yaml` files in your repository and point to the new tasks, e.g. changing `ods-build-go-v0-1-1` to `ods-build-go-v0-2-0`.
Once the resources in your namespace are updated, you can update the `ods.yaml` files in your repository and point to the new tasks, e.g. changing `ods-build-go-v0-2-0` to `ods-build-go-v0-3-0`.
6 changes: 3 additions & 3 deletions docs/introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -80,14 +80,14 @@ pipeline:
- name: build-go
taskRef:
kind: Task
name: ods-build-go-v0-2-0
name: ods-build-go-v0-3-0
workspaces:
- name: source
workspace: shared-workspace
- name: package-image
taskRef:
kind: Task
name: ods-package-image-v0-2-0
name: ods-package-image-v0-3-0
runAfter:
- build-go
workspaces:
Expand All @@ -96,7 +96,7 @@ pipeline:
- name: deploy-helm
taskRef:
kind: Task
name: ods-deploy-helm-v0-2-0
name: ods-deploy-helm-v0-3-0
runAfter:
- package-image
workspaces:
Expand Down
2 changes: 1 addition & 1 deletion docs/ods-configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ pipeline:
- name: backend-build-go
taskRef:
kind: Task
name: ods-build-go-v0-2-0
name: ods-build-go-v0-3-0
workspaces:
- name: source
workspace: shared-workspace
Expand Down

0 comments on commit 542c7e2

Please sign in to comment.