Skip to content

Commit

Permalink
Prepare documentation for 1.1 release (#21)
Browse files Browse the repository at this point in the history
* Prepare documentation for new release

* Updated numbering

* Removed extra docker tag

* Updated release checklist
  • Loading branch information
ilyakooo0 committed Jan 25, 2021
1 parent 4d8a6a4 commit f1c4e49
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
18 changes: 9 additions & 9 deletions Release_checklist.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Release checklist

1. Merge the `develop` branch into `master`.
2. CI will automatically create a new release in GitHub with _octo CLI_ and update the `latest` tag for both `octo` and `octopod`. Wait for CI to complete.
3. Edit the created release in GitHub to match the version you are releasing.
1. Change the release name to the version being released.
2. Uncheck "This is a pre-release"
4. Push the new release of `octo` and `octopod`. To do this run `./release.sh <version>`.
5. Update the referenced tags in documentation
6. If there were changes to the examples:
1. Update the referenced tags in the documentation
2. If there were changes to the examples:
1. Build and push the new containers:
1. octopod-web-app-example
2. octopod-helm-example
2. Create a new tag incrementing the integer version number of the tag:
1. Pull the image (`docker pull`)
1. Build the updated images
2. Tag it with the new `<integer>` (`docker tag`)
3. Push the new tag (`docker push`)
3. Update docs where the tags are referenced.
3. Merge the `develop` branch into `master`.
4. CI will automatically create a new release in GitHub with _octo CLI_ and update the `latest` tag for both `octo` and `octopod`. Wait for CI to complete.
5. Edit the created release in GitHub to match the version you are releasing.
1. Change the release name to the version being released.
2. Uncheck "This is a pre-release"
6. Push the new release of `octo` and `octopod`. To do this run `./release.sh <version>`.
2 changes: 1 addition & 1 deletion docs/en/Octopod_deployment_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ cd /tmp/octopod/charts
#################################################

registry="typeable"
tag="1.0"
tag="1.1"
image="octopod"
octo_image="octo"

Expand Down
2 changes: 1 addition & 1 deletion docs/ru/Octopod_deployment_with_K8S.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@
registry="typeable"
# tag Octopod Server
tag="1.0"
tag="1.1"
# название docker образа Octopod Server
image="octopod"
Expand Down
2 changes: 1 addition & 1 deletion examples/helm-based-control-scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ An Example of Helm-based control scripts.
## Build Docker image

```bash
docker build -f docker/Dockerfile -t typeable/octopod-helm-example:1.0 .
docker build -f docker/Dockerfile -t typeable/octopod-helm-example .
```

0 comments on commit f1c4e49

Please sign in to comment.