From 1e123ca361baf918c6f4f2f3208f3285d5bc5b05 Mon Sep 17 00:00:00 2001 From: Michael Sauter Date: Thu, 28 Oct 2021 14:39:22 +0200 Subject: [PATCH] Prepare v0.1.1 release --- CHANGELOG.md | 2 ++ deploy/cd-namespace/chart/Chart.yaml | 4 ++-- deploy/cd-namespace/chart/values.yaml | 2 +- deploy/central/images-chart/Chart.yaml | 4 ++-- deploy/central/images-chart/values.yaml | 6 +++--- deploy/central/tasks-chart/Chart.yaml | 4 ++-- deploy/central/tasks-chart/values.docs.yaml | 2 +- deploy/central/tasks-chart/values.yaml | 4 ++-- docs/admin-installation.adoc | 4 ++-- docs/authoring-tasks.adoc | 2 +- docs/example-project.adoc | 14 ++++++------- docs/getting-started.adoc | 22 ++++++++++----------- docs/introduction.adoc | 6 +++--- docs/ods-configuration.adoc | 2 +- docs/user-installation.adoc | 4 ++-- 15 files changed, 42 insertions(+), 40 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2a52b5c4..a817df97 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,8 @@ Note that changes which ONLY affect documentation or the testsuite will not be listed in the changelog. ## [Unreleased] + +## [0.1.1] - 2021-10-28 ### Fixed - Incorrect ods-gradle-toolset base image in BuildConfig ([#250](https://github.com/opendevstack/ods-pipeline/issues/250)) diff --git a/deploy/cd-namespace/chart/Chart.yaml b/deploy/cd-namespace/chart/Chart.yaml index bcffcd97..93c78311 100644 --- a/deploy/cd-namespace/chart/Chart.yaml +++ b/deploy/cd-namespace/chart/Chart.yaml @@ -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.1.0 +version: 0.1.1 # 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.1.0" +appVersion: "0.1.1" diff --git a/deploy/cd-namespace/chart/values.yaml b/deploy/cd-namespace/chart/values.yaml index 03124b5e..5bf8a1de 100644 --- a/deploy/cd-namespace/chart/values.yaml +++ b/deploy/cd-namespace/chart/values.yaml @@ -67,7 +67,7 @@ interceptor: pullPolicy: Always # Image tag to pull. # If not given, defaults to the chart appVersion. - # tag: "0.1.0" + # tag: "0.1.1" # Deployment pod resources. Typically these settings should not need to change. resources: limits: diff --git a/deploy/central/images-chart/Chart.yaml b/deploy/central/images-chart/Chart.yaml index 7b04e423..d0230d22 100644 --- a/deploy/central/images-chart/Chart.yaml +++ b/deploy/central/images-chart/Chart.yaml @@ -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.1.0 +version: 0.1.1 # 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.1.0" +appVersion: "0.1.1" diff --git a/deploy/central/images-chart/values.yaml b/deploy/central/images-chart/values.yaml index 51b4b5a2..5b7dcb86 100644 --- a/deploy/central/images-chart/values.yaml +++ b/deploy/central/images-chart/values.yaml @@ -1,12 +1,12 @@ # Tasks # Image tag to use for images referenced by tasks. -imageTag: 0.1.0 +imageTag: 0.1.1 # Suffix to append to the task name. -taskSuffix: -v0-1-0 +taskSuffix: -v0-1-1 # Git odsPipelineGitRepoUri: https://github.com/opendevstack/ods-pipeline -odsPipelineGitRepoRef: v0.1.0 +odsPipelineGitRepoRef: v0.1.1 # Sonar # Edition of SonarQube server. One of "community", "developer", "enterprise" or "datacenter". diff --git a/deploy/central/tasks-chart/Chart.yaml b/deploy/central/tasks-chart/Chart.yaml index 184ff15a..56dc714f 100644 --- a/deploy/central/tasks-chart/Chart.yaml +++ b/deploy/central/tasks-chart/Chart.yaml @@ -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.1.0 +version: 0.1.1 # 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.1.0" +appVersion: "0.1.1" diff --git a/deploy/central/tasks-chart/values.docs.yaml b/deploy/central/tasks-chart/values.docs.yaml index b5c0d433..10f41ae6 100644 --- a/deploy/central/tasks-chart/values.docs.yaml +++ b/deploy/central/tasks-chart/values.docs.yaml @@ -4,6 +4,6 @@ registry: image-registry.openshift-image-registry.svc:5000 namespace: ods -imageTag: 0.1.0 +imageTag: 0.1.1 taskSuffix: '' pushRegistry: image-registry.openshift-image-registry.svc:5000 diff --git a/deploy/central/tasks-chart/values.yaml b/deploy/central/tasks-chart/values.yaml index 2d003572..66f36a64 100644 --- a/deploy/central/tasks-chart/values.yaml +++ b/deploy/central/tasks-chart/values.yaml @@ -4,6 +4,6 @@ registry: image-registry.openshift-image-registry.svc:5000 namespace: ods -imageTag: 0.1.0 -taskSuffix: -v0-1-0 +imageTag: 0.1.1 +taskSuffix: -v0-1-1 pushRegistry: image-registry.openshift-image-registry.svc:5000 diff --git a/docs/admin-installation.adoc b/docs/admin-installation.adoc index 60b4ba1a..c8d4d7db 100644 --- a/docs/admin-installation.adoc +++ b/docs/admin-installation.adoc @@ -20,7 +20,7 @@ First, create a repository in Bitbucket, e.g. `ods`. The name can be anything, b Then, use `git subtree` to get the required sources. The following commands may look a bit complicated, but in a nutshell, they are simply adding one folder (`deploy/central`) from the `opendestack/ods-pipeline` repository at the given revision (e.g. `master`) into your new local repository at the path `ods-pipeline`. ``` -pipelineGitRef=v0.1.0 # Pick the version you want to install +pipelineGitRef=v0.1.1 # 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 && \ @@ -57,7 +57,7 @@ Now your `ods` namespace is fully setup and users can start to utilize Tekton pi You may fetch updates (e.g. new versions) of `ods-pipeline` like this: ``` -pipelineGitRef=v0.1.0 # Pick the version you want to install +pipelineGitRef=v0.1.1 # 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 && \ diff --git a/docs/authoring-tasks.adoc b/docs/authoring-tasks.adoc index 629012e8..bb049728 100644 --- a/docs/authoring-tasks.adoc +++ b/docs/authoring-tasks.adoc @@ -131,7 +131,7 @@ spec: description: Custom Go (module) applications build task. steps: - name: build-go-binary - image: '{{.Values.registry}}/ods/ods-go-toolset:v0.1.0' + image: '{{.Values.registry}}/ods/ods-go-toolset:v0.1.1' env: - name: HOME value: '/tekton/home' diff --git a/docs/example-project.adoc b/docs/example-project.adoc index c96a46ce..c88e2843 100644 --- a/docs/example-project.adoc +++ b/docs/example-project.adoc @@ -33,14 +33,14 @@ pipeline: - name: build-go taskRef: kind: ClusterTask - name: ods-build-go-v0-1-0 + name: ods-build-go-v0-1-1 workspaces: - name: source workspace: shared-workspace - name: package-image taskRef: kind: ClusterTask - name: ods-package-image-v0-1-0 + name: ods-package-image-v0-1-1 runAfter: - build-go workspaces: @@ -49,7 +49,7 @@ pipeline: - name: deploy-helm taskRef: kind: ClusterTask - name: ods-deploy-helm-v0-1-0 + name: ods-deploy-helm-v0-1-1 runAfter: - package-image workspaces: @@ -74,14 +74,14 @@ pipeline: - name: build-typescript taskRef: kind: ClusterTask - name: ods-build-typescript-v0-1-0 + name: ods-build-typescript-v0-1-1 workspaces: - name: source workspace: shared-workspace - name: package-image taskRef: kind: ClusterTask - name: ods-package-image-v0-1-0 + name: ods-package-image-v0-1-1 runAfter: - build-typescript workspaces: @@ -90,7 +90,7 @@ pipeline: - name: deploy-helm taskRef: kind: ClusterTask - name: ods-deploy-helm-v0-1-0 + name: ods-deploy-helm-v0-1-1 runAfter: - package-image workspaces: @@ -132,7 +132,7 @@ pipeline: - name: deploy-helm taskRef: kind: ClusterTask - name: ods-deploy-helm-v0-1-0 + name: ods-deploy-helm-v0-1-1 workspaces: - name: source workspace: shared-workspace diff --git a/docs/getting-started.adoc b/docs/getting-started.adoc index 888381a1..472f9c3f 100644 --- a/docs/getting-started.adoc +++ b/docs/getting-started.adoc @@ -108,14 +108,14 @@ pipeline: - name: backend-build-go taskRef: kind: ClusterTask - name: ods-build-go-v0-1-0 + name: ods-build-go-v0-1-1 workspaces: - name: source workspace: shared-workspace - name: backend-package-image taskRef: kind: ClusterTask - name: ods-package-image-v0-1-0 + name: ods-package-image-v0-1-1 runAfter: - backend-build-go workspaces: @@ -124,7 +124,7 @@ pipeline: - name: backend-deploy taskRef: kind: ClusterTask - name: ods-deploy-helm-v0-1-0 + name: ods-deploy-helm-v0-1-1 runAfter: - backend-package-image workspaces: @@ -132,11 +132,11 @@ pipeline: 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-1-0` task. The task continues to use the existing `sonar-project.properties`, which does not need to be modified. 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-1-1` task. The task continues to use the existing `sonar-project.properties`, which does not need to be modified. 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-1-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-1-1` 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-1-0` as opposed to `odsComponentStageRolloutOpenShiftDeployment`. +Finally, the application is deployed in `ods-deploy-helm-v0-1-1` 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 Kuberenetes resources (the Helm "chart") to be under version control as described below in the <> 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 <> section. @@ -164,14 +164,14 @@ pipeline: - name: backend-build-go taskRef: kind: ClusterTask - name: ods-build-go-v0-1-0 + name: ods-build-go-v0-1-1 workspaces: - name: source workspace: shared-workspace - name: backend-package-image taskRef: kind: ClusterTask - name: ods-package-image-v0-1-0 + name: ods-package-image-v0-1-1 runAfter: - backend-build-go workspaces: @@ -180,7 +180,7 @@ pipeline: - name: backend-deploy taskRef: kind: ClusterTask - name: ods-deploy-helm-v0-1-0 + name: ods-deploy-helm-v0-1-1 runAfter: - backend-package-image workspaces: @@ -188,7 +188,7 @@ pipeline: workspace: shared-workspace ---- -The `ods-package-image-v0-1-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-1-1` 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] @@ -220,7 +220,7 @@ sonar.sourceEncoding=UTF-8 sonar.go.coverage.reportPaths=coverage.out ---- -The `ods-deploy-helm-v0-1-0` requires a Helm chart to be present to deploy the Kubernetes resources for the application. Add it as described below in the <> section. +The `ods-deploy-helm-v0-1-1` requires a Helm chart to be present to deploy the Kubernetes resources for the application. Add it as described below in the <> section. Finally, setup a Bitbucket webhook pointing to the ODS pipeline installation as described below in the <> section. diff --git a/docs/introduction.adoc b/docs/introduction.adoc index 50b2cf22..8d830798 100644 --- a/docs/introduction.adoc +++ b/docs/introduction.adoc @@ -85,14 +85,14 @@ pipeline: - name: build-go taskRef: kind: ClusterTask - name: ods-build-go-v0-1-0 + name: ods-build-go-v0-1-1 workspaces: - name: source workspace: shared-workspace - name: package-image taskRef: kind: ClusterTask - name: ods-package-image-v0-1-0 + name: ods-package-image-v0-1-1 runAfter: - build-go workspaces: @@ -101,7 +101,7 @@ pipeline: - name: deploy-helm taskRef: kind: ClusterTask - name: ods-deploy-helm-v0-1-0 + name: ods-deploy-helm-v0-1-1 runAfter: - package-image workspaces: diff --git a/docs/ods-configuration.adoc b/docs/ods-configuration.adoc index 7b4213e8..19bf613d 100644 --- a/docs/ods-configuration.adoc +++ b/docs/ods-configuration.adoc @@ -22,7 +22,7 @@ pipeline: - name: backend-build-go taskRef: kind: ClusterTask - name: ods-build-go-v0-1-0 + name: ods-build-go-v0-1-1 workspaces: - name: source workspace: shared-workspace diff --git a/docs/user-installation.adoc b/docs/user-installation.adoc index 604b5cc1..2f76ed9b 100644 --- a/docs/user-installation.adoc +++ b/docs/user-installation.adoc @@ -25,7 +25,7 @@ First, create a repository in Bitbucket, e.g. `foo-cd`. The name can be anything Then, use `git subtree` to get the required sources. The following commands may look a bit complicated, but in a nutshell, they are simply adding one folder (`deploy/cd-namespace`) from the `opendestack/ods-pipeline` repository at the given revision (e.g. `master`) into your new local repository at the path `ods-pipeline`. ``` -pipelineGitRef=v0.1.0 # Pick the version you want to install +pipelineGitRef=v0.1.1 # 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 && \ @@ -61,7 +61,7 @@ See the link:getting-started.adoc[Getting Started] guide for more information on You may fetch updates (e.g. new versions) of `ods-pipeline` like this: ``` -pipelineGitRef=v0.1.0 # Pick the version you want to install +pipelineGitRef=v0.1.1 # 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 && \