From 59b844435ded6c42ee19362b496bd8c15fd4b6a6 Mon Sep 17 00:00:00 2001 From: Angela Tran Date: Wed, 10 Jul 2024 22:15:05 +0000 Subject: [PATCH] docs: remove outdated docs about package tags as of c94a3665, we no longer tag the packages as `dev`, `test`, or `prod` since our CI config just pulls new packages based on Git commit. --- docs/releases.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/releases.md b/docs/releases.md index 3ea7fce8..ef17b24a 100644 --- a/docs/releases.md +++ b/docs/releases.md @@ -2,18 +2,14 @@ The `eligibility-server` is published as a Docker image on the GitHub Container Registry. It can be accessed from the [repository package page](https://github.com/cal-itp/eligibility-server/pkgs/container/eligibility-server). -Every push to the `main` (default) branch that changes files relevant to the application builds and updates the `dev` package, via the [`docker-publish`](https://github.com/cal-itp/eligibility-server/blob/main/.github/workflows/docker-publish.yml) GitHub Action. +Every push to the `main` (default) branch that changes files relevant to the application builds and pushes a new package tagged with the corresponding Git commit hash, via the [`docker-publish`](https://github.com/cal-itp/eligibility-server/blob/main/.github/workflows/docker-publish.yml) GitHub Action. -Commits that are tagged with our version number format for release candidates and releases will update the `test` and `prod` packages, respectively. +Commits that are tagged with our version number format for release candidates and releases will also push a new package. ## Versions All versions of the package may be viewed on the [package all versions page](https://github.com/cal-itp/eligibility-server/pkgs/container/eligibility-server/versions). -The `main` (default) branch is published at the `dev` tag. - -The official releases will be tagged with a version number. - ## Version number format `eligibility-server` uses the [CalVer](https://calver.org/) versioning scheme, where version numbers for releases look like: `YYYY.0M.R`