Skip to content

Commit

Permalink
docs(workflows): update workflow docs due to tag-based releases
Browse files Browse the repository at this point in the history
  • Loading branch information
lalver1 committed Aug 6, 2024
1 parent b891dd7 commit 739b5e6
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/deployment/workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,21 @@ The GitHub Actions deployment workflow configuration lives at [`.github/workflow

## Deployment steps

The workflow is [triggered][gh-actions-trigger] with a `push` to the corresponding branch. It also responds to the `workflow_dispatch` event to allow manually triggering via the GitHub Actions UI.
The workflow is [triggered][gh-actions-trigger] with a `push` to the `main` branch or when a release candidate or release tag is created on any branch. It also responds to the `workflow_dispatch` event to allow manually triggering via the GitHub Actions UI.

When a deployment workflow runs, the following steps are taken:

### 1. Checkout code

From the tip of the corresponding branch (e.g. `main`)
From the tip of the corresponding branch (e.g. `main`) or the tagged commit

### 2. Authenticate to GHCR

Using the `github.actor` and built-in `GITHUB_TOKEN` secret

### 3. Build and push image to GitHub Container Registry (GHCR)

Build the root [`Dockerfile`][dockerfile], tagging with the SHA from the HEAD commit.
Build the root [`Dockerfile`][dockerfile], tagging with the SHA from the HEAD commit or tagged commit.

Push this image:tag into [GHCR][ghcr].

Expand All @@ -32,6 +32,6 @@ Push this image:tag into [GHCR][ghcr].
Push the new image:tag to the Azure App Service instance.

[deploy]: https://github.com/cal-itp/benefits/blob/main/.github/workflows/deploy.yml
[dockerfile]: https://github.com/cal-itp/benefits/blob/main/Dockerfile
[dockerfile]: https://github.com/cal-itp/benefits/blob/main/appcontainer/Dockerfile
[ghcr]: https://github.com/features/packages
[gh-actions-trigger]: https://docs.github.com/en/actions/reference/events-that-trigger-workflows

0 comments on commit 739b5e6

Please sign in to comment.