Release enterprise 1.0.x CI workflow (#181) (#320)

* update github workflow to allow releasing older versions
* add release doc

---------

Signed-off-by: Brady Todhunter <[email protected]>

.github/workflows/deploy.yaml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - 'release-*'
     paths:
       - 'stable/**'
 
@@ -36,8 +37,20 @@ jobs:
           helm repo add anchore https://charts.anchore.io/stable
           helm repo add bitnami https://charts.bitnami.com/bitnami
 
+      - name: Run chart-releaser not latest
+        if: github.event.pull_request.base.ref != 'main'
+        uses: helm/chart-releaser-action@a917fd15b20e8b64b94d9158ad54cd6345335584 # v1.6.0
+        with:
+          charts_dir: stable
+          charts_repo_url: https://charts.anchore.io
+          mark_as_latest: false
+        env:
+          CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          CR_MAKE_RELEASE_LATEST: "false"
+
       - name: Run chart-releaser
-        uses: helm/chart-releaser-action@be16258da8010256c6e82849661221415f031968 # v1.5.0
+        if: github.event.pull_request.base.ref == 'main'
+        uses: helm/chart-releaser-action@a917fd15b20e8b64b94d9158ad54cd6345335584 # v1.6.0
         with:
           charts_dir: stable
           charts_repo_url: https://charts.anchore.io

.github/workflows/lint.yaml

@@ -37,4 +37,9 @@ jobs:
     - name: Run chart-testing (lint)
       id: lint
       run: ct lint --config 'ct-config.yaml'
-      if: steps.list-changed.outputs.CHANGED == 'true'
+      if: steps.list-changed.outputs.CHANGED == 'true' && github.event.pull_request.base.ref == 'main'
+
+    - name: Run chart-testing but skip version check (lint)
+      id: lintskipversion
+      run: ct lint --config 'ct-config.yaml' --check-version-increment=false
+      if: steps.list-changed.outputs.CHANGED == 'true' && github.event.pull_request.base.ref != 'main'

.github/workflows/test.yaml

@@ -48,7 +48,12 @@ jobs:
     - name: Run chart-testing (lint)
       id: lint
       run: ct lint --config 'ct-config.yaml'
-      if: steps.list-changed.outputs.CHANGED == 'true'
+      if: steps.list-changed.outputs.CHANGED == 'true' && github.event.pull_request.base.ref == 'main'
+
+    - name: Run chart-testing but skip version check (lint)
+      id: lintskipversion
+      run: ct lint --config 'ct-config.yaml' --check-version-increment=false
+      if: steps.list-changed.outputs.CHANGED == 'true' && github.event.pull_request.base.ref != 'main'
 
     - name: Install kind
       if: steps.list-changed.outputs.CHANGED == 'true'

RELEASE.md

@@ -0,0 +1,88 @@
+# Releasing Anchore Helm Charts
+
+In our Helm chart release strategy we have developed a pipeline to accommodate current and non-current versions of our enterprise software. To accomplish this, we are utilizing multiple release branches with distinct release pipelines. The `release-<chart_name>-<non-current_chart_version>` branching strategy involves a release process that is dedicated to the ongoing support of non-current, but still supported, Enterprise platform versions. The `main` branch is dedicated to the ongoing support of current & future Enterprise platform versions.
+
+All release processes are controlled via CI using GitHub actions. Charts are linted and released using the official Helm [chart-testing](https://github.com/helm/chart-testing) and [chart-releaser](https://github.com/helm/chart-releaser) tools.
+
+## Release Documentation
+
+*Note: Ensure that Helm and GitHub credentials are configured appropriately for successful execution of the release process.*
+
+### Release Process for Current Charts
+
+1. **Create a Branch:**
+   - Start by creating a new branch for your changes off of the `main` branch.
+
+     ```bash
+     git checkout main
+     git pull origin main
+     git checkout -b feature-update
+     ```
+
+2. **Make and Commit Changes:**
+   - Implement your changes in the branch.
+   - Ensure Helm unit tests are updated and passing.
+   - Commit your changes.
+   - Push your branch to GitHub
+
+     ```bash
+     git commit -sm "feat: implement updates"
+     helm unittest .
+     git push origin feature-update
+     ```
+
+3. **Create Pull Request:**
+   - Open a pull request against the `main` branch on GitHub.
+   - Provide a descriptive title and description for the changes.
+
+4. **GitHub Actions and Chart Releasing:**
+   - Once the pull request is merged, GitHub Actions will automatically trigger the `chart-releaser-action`.
+   - This action will create the Helm release for the updated chart.
+
+### Release Process for Non-Current Charts
+
+1. **Branching:**
+   - Create a new release branch off the latest v1.x.x tag named `release-enterprise-1.x.x`.
+   - Push the release branch to GitHub.
+   - Create a new branch off of the `release-enterprise-1.x.x` branch using a meaningful name for your changes.
+   - Example:
+
+     ```bash
+     git checkout v1.0.0
+     git checkout -b release-enterprise-1.x.x
+     git push origin release-enterprise-1.x.x
+     git checkout -b enterprise-1.x.x-feature-xyz
+     ```
+
+2. **Make and Commit Changes:**
+   - Make necessary changes in your branch.
+   - Ensure that any affected Helm unit tests are updated and passing.
+   - Commit your changes.
+   - Example:
+
+     ```bash
+     git commit -sm "feat: update something"
+     helm unittest .
+     git push origin enterprise-1.x.x-feature-xyz
+     ```
+
+3. **Create Pull Request:**
+   - Open a pull request against the `release-enterprise-1.x.x` branch on GitHub.
+   - Provide a concise and informative title and description for your changes.
+
+4. **GitHub Actions and Chart Releasing:**
+   - Upon merging the pull request, a GitHub Action (`chart-releaser-action`) will be triggered automatically.
+   - The action will create the Helm release for the updated chart.
+
+5. **Managing GitHub Releases Page:**
+   - Navigate to the GitHub Releases page.
+   - Locate the latest release associated with the `enterprise-1.x.x` branch and make sure its not marked as latest. If it is, manually mark the actual latest release as 'latest.'
+   - Note: This step is crucial to distinguish the actual latest release from patch updates.
+
+## Chart Distribution
+
+Our Helm charts are distributed via GitHub Pages and managed using the `gh-pages` branch in this repository. The chart repository is available at <https://charts.anchore.io>. The `chart-releaser-action` will automatically perform the following actions when a PR is merged to the `main` OR `release-*` branches:
+
+- Create a GitHub tag & release for all changed charts, using `<chart_name>-<chart_version>` as the tag name.
+- Package the chart and upload the created tarball to the corresponding GitHub release page.
+- Updates the `chart.yaml` file in the `gh-pages` branch with the latest chart version & package location.