Skip to content

Commit

Permalink
Create 0.5.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelsauter committed Jun 9, 2022
1 parent 0d291f0 commit 49e0934
Show file tree
Hide file tree
Showing 12 changed files with 42 additions and 40 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ listed in the changelog.

## [Unreleased]


## [0.5.0] - 2022-06-09

### Added

- Automatically build images after Helm upgrade ([#525](https://github.com/opendevstack/ods-pipeline/issues/525))
Expand Down
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,9 @@ For OpenShift Pipelines releases and its relationship to Tekton and OpenShift ve

| ods-pipeline | OpenShift Pipelines | ODS Core/Quickstarters |
|---|---|---|
| [0.5](https://github.com/opendevstack/ods-pipeline/releases/tag/v0.5.0) | 1.5 | 4.0.0 |
| [0.4](https://github.com/opendevstack/ods-pipeline/releases/tag/v0.4.0) | 1.5 | 4.0.0 |
| [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 |

## Contributing

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.4.0
version: 0.5.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.4.0"
appVersion: "0.5.0"

dependencies:
- name: images
version: 0.4.0
version: 0.5.0
condition: images.enabled
- name: setup
version: 0.4.0
version: 0.5.0
condition: setup.enabled
- name: tasks
version: 0.4.0
version: 0.5.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.4.0
version: 0.5.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.4.0"
appVersion: "0.5.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.4.0
version: 0.5.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.4.0"
appVersion: "0.5.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.4.0
version: 0.5.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.4.0"
appVersion: "0.5.0"
14 changes: 7 additions & 7 deletions docs/add-to-repository.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@ pipeline:
- name: backend-build-go
taskRef:
kind: Task
name: ods-build-go-v0-4-0
name: ods-build-go-v0-5-0
workspaces:
- name: source
workspace: shared-workspace
- name: backend-package-image
taskRef:
kind: Task
name: ods-package-image-v0-4-0
name: ods-package-image-v0-5-0
runAfter:
- backend-build-go
workspaces:
Expand All @@ -47,17 +47,17 @@ pipeline:
- name: backend-deploy
taskRef:
kind: Task
name: ods-deploy-helm-v0-4-0
name: ods-deploy-helm-v0-5-0
runAfter:
- backend-package-image
workspaces:
- name: source
workspace: shared-workspace
----

The only Go specific task is `ods-build-go-v0-4-0`, if you use another technology, exchange the task for another one such as `ods-build-gradle-v0-4-0`.
The only Go specific task is `ods-build-go-v0-5-0`, if you use another technology, exchange the task for another one such as `ods-build-gradle-v0-5-0`.

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

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

NOTE: `ods-build-go-v0-4-0` produces a binary called `app` and places it at `docker/app` so that it can be referenced in the `Dockerfile` and copied into the image by the `ods-package-image-v0-4-0` task.
NOTE: `ods-build-go-v0-5-0` produces a binary called `app` and places it at `docker/app` so that it can be referenced in the `Dockerfile` and copied into the image by the `ods-package-image-v0-5-0` task.

== Create Helm Chart

The `ods-deploy-helm-v0-4-0` requires a Helm chart to be present to deploy the Kubernetes resources for the application. It is recommended to start with the link:https://github.com/opendevstack/ods-pipeline/tree/sample-helm-chart[sample chart provided in this repository].
The `ods-deploy-helm-v0-5-0` requires a Helm chart to be present to deploy the Kubernetes resources for the application. It is recommended to start with the link:https://github.com/opendevstack/ods-pipeline/tree/sample-helm-chart[sample chart provided in this repository].

== Configure Webhook

Expand Down
12 changes: 6 additions & 6 deletions docs/convert-quickstarter-component.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -101,14 +101,14 @@ pipeline:
- name: backend-build-go
taskRef:
kind: Task
name: ods-build-go-v0-4-0
name: ods-build-go-v0-5-0
workspaces:
- name: source
workspace: shared-workspace
- name: backend-package-image
taskRef:
kind: Task
name: ods-package-image-v0-4-0
name: ods-package-image-v0-5-0
runAfter:
- backend-build-go
workspaces:
Expand All @@ -117,21 +117,21 @@ pipeline:
- name: backend-deploy
taskRef:
kind: Task
name: ods-deploy-helm-v0-4-0
name: ods-deploy-helm-v0-5-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-4-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-5-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-4-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-5-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).

== Create Helm Chart

Finally, the application is deployed in `ods-deploy-helm-v0-4-0` as opposed to `odsComponentStageRolloutOpenShiftDeployment`.
Finally, the application is deployed in `ods-deploy-helm-v0-5-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. It is recommended to start with the link:https://github.com/opendevstack/ods-pipeline/tree/sample-helm-chart[sample chart provided in this repository]. If the existing component controlled resources via Tailor, please see the link:https://github.com/opendevstack/tailor/wiki/Migrating-from-Tailor-to-Helm#ods-quickstarter-migration[ODS Quickstarter Migration Guide] of Tailor as well.

== Configure Webhook
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
taskRef:
kind: Task
name: ods-build-go-v0-4-0
name: ods-build-go-v0-5-0
workspaces:
- name: source
workspace: shared-workspace
- name: package
taskRef:
kind: Task
name: ods-package-image-v0-4-0
name: ods-package-image-v0-5-0
runAfter:
- build
workspaces:
Expand All @@ -49,7 +49,7 @@ pipeline:
- name: deploy
taskRef:
kind: Task
name: ods-deploy-helm-v0-4-0
name: ods-deploy-helm-v0-5-0
runAfter:
- package
workspaces:
Expand All @@ -74,14 +74,14 @@ pipeline:
- name: build
taskRef:
kind: Task
name: ods-build-npm-v0-4-0
name: ods-build-npm-v0-5-0
workspaces:
- name: source
workspace: shared-workspace
- name: package
taskRef:
kind: Task
name: ods-package-image-v0-4-0
name: ods-package-image-v0-5-0
runAfter:
- build
workspaces:
Expand All @@ -90,7 +90,7 @@ pipeline:
- name: deploy
taskRef:
kind: Task
name: ods-deploy-helm-v0-4-0
name: ods-deploy-helm-v0-5-0
runAfter:
- package
workspaces:
Expand Down Expand Up @@ -134,7 +134,7 @@ pipeline:
- name: deploy
taskRef:
kind: ClusterTask
name: ods-deploy-helm-v0-4-0
name: ods-deploy-helm-v0-5-0
workspaces:
- name: source
workspace: shared-workspace
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=v0.4.0 # Pick the version you want to install
pipelineGitRef=v0.5.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 @@ -115,7 +115,7 @@ You may fetch updates (e.g. new versions) of `ods-pipeline` like this:

[source]
----
pipelineGitRef=v0.4.0 # Pick the version you want to install
pipelineGitRef=v0.5.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 @@ -130,4 +130,4 @@ Afterwards you can update the resources via `./install.sh -n <your_cd_namespace>

NOTE: After successful installation in OpenShift, builds for the container images used in the pipeline manager and Tekton tasks will be triggered automatically. It is recommended to check that all builds succeed before proceeding.

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-3-0` to `ods-build-go-v0-4-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-4-0` to `ods-build-go-v0-5-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-4-0
name: ods-build-go-v0-5-0
workspaces:
- name: source
workspace: shared-workspace
- name: package-image
taskRef:
kind: Task
name: ods-package-image-v0-4-0
name: ods-package-image-v0-5-0
runAfter:
- build-go
workspaces:
Expand All @@ -96,7 +96,7 @@ pipeline:
- name: deploy-helm
taskRef:
kind: Task
name: ods-deploy-helm-v0-4-0
name: ods-deploy-helm-v0-5-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-4-0
name: ods-build-go-v0-5-0
workspaces:
- name: source
workspace: shared-workspace
Expand Down

0 comments on commit 49e0934

Please sign in to comment.