Skip to content

Commit

Permalink
docs: add helm charts version docs
Browse files Browse the repository at this point in the history
Signed-off-by: Xinwei Xiong (cubxxw) <[email protected]>
  • Loading branch information
cubxxw committed Jan 8, 2024
1 parent 6e5448c commit 465679a
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 22 deletions.
34 changes: 17 additions & 17 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# name: Release Charts
name: Release Charts

# on:
# push:
# branches:
# - main
on:
push:
branches:
- main

# jobs:
# release:
# # depending on default permission settings for your org (contents being read-only or read-write for workloads), you will have to add permissions
# # see: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token
# permissions:
# contents: write # to push chart release and create a release (helm/chart-releaser-action)
# packages: write # needed for ghcr access
# id-token: write # needed for keyless signing
jobs:
release:
# depending on default permission settings for your org (contents being read-only or read-write for workloads), you will have to add permissions
# see: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token
permissions:
contents: write # to push chart release and create a release (helm/chart-releaser-action)
packages: write # needed for ghcr access
id-token: write # needed for keyless signing

# runs-on: ubuntu-latest
# steps:
# - name: Checkout Code
# uses: actions/checkout@v4
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@v4

# - name: Fetch history
# run: git fetch --prune --unshallow
Expand Down
2 changes: 1 addition & 1 deletion charts/openim-admin/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ 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.7
version: 0.1.8

# 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
Expand Down
2 changes: 1 addition & 1 deletion charts/openim-chat/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ 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.7
version: 0.1.8

# 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
Expand Down
2 changes: 1 addition & 1 deletion charts/openim-server/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ 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.7
version: 0.1.8

# 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
Expand Down
2 changes: 1 addition & 1 deletion charts/openim-web/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ 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.7
version: 0.1.8

# 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
Expand Down
2 changes: 1 addition & 1 deletion docs/version.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Unlike traditional software version control that often relies on branch concepts
- **Chart.yaml File**: Each chart contains a `Chart.yaml` file in its directory. This file is pivotal for managing the version of each individual chart. It holds the `version` key, which gets updated with every new release.

```yaml
version: 0.1.7
version: 0.1.8
```
- **Automated CICD**: Developers don't need to worry about managing branches, tags, or releases manually. These aspects are handled automatically through Continuous Integration and Continuous Deployment (CICD) systems. When a new chart version is pushed to the repository, the CICD pipeline is triggered.
Expand Down

0 comments on commit 465679a

Please sign in to comment.