Skip to content

Commit

Permalink
docs: README updated to reflect new paths and versions.
Browse files Browse the repository at this point in the history
  • Loading branch information
klardotsh committed Mar 28, 2023
1 parent 137f8e4 commit 6889479
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 29 deletions.
7 changes: 5 additions & 2 deletions .github/workflows/build-and-push-ghcr-common.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on:
inputs:
# N.B.: This behavior is not concurrency-safe and updates the mutable
# :latest image tag
push-latest:
allow-push-latest:
type: boolean
primary-registry-tag:
type: string
Expand All @@ -28,8 +28,11 @@ jobs:
registry: ghcr.io
username: ${{ github.repository_owner }}
password: ${{ github.token }}
- name: Calculate highest version number from Git tags
if: inputs.allow-push-latest
run: echo "MOST_RECENT_TAG=$(git tag | sort --version-sort | tail -n1)" >> $GITHUB_ENV
- name: Set PUSH_LATEST_TAG in environment
if: inputs.push-latest
if: inputs.allow-push-latest && github.ref_name == env.MOST_RECENT_TAG
run: echo "PUSH_LATEST_TAG=1" >> $GITHUB_ENV
- name: Set REGISTRY_TAG in environment
if: inputs.primary-registry-tag != ''
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/build-and-push-ghcr-latest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ name: Publish Docker Image to GHCR (versioned + :latest)

on:
push:
branches:
- main
tags:
- '*'

jobs:
multiarch-image:
uses: ./.github/workflows/build-and-push-ghcr-common.yml
secrets: inherit
with:
push-latest-tag: true
allow-push-latest-tag: true
15 changes: 0 additions & 15 deletions IMAGE_TAG

This file was deleted.

21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,22 @@

This is a container image for running [Zulip](https://zulip.com)
([GitHub](https://github.com/zulip/zulip)) in
[production][prod-overview]. Image available from:
[production][prod-overview].

- [**Docker Hub**](https://hub.docker.com/r/zulip/docker-zulip) (`docker pull zulip/docker-zulip:6.1-0`)

Current Zulip version: `6.1`
Current Docker image version: `6.1-0`
Current architectures supported: `amd64`
```sh
docker pull ghcr.io/zulip/zulip

<!-- Remove when https://github.com/zulip/docker-zulip/issues/357 resolved -->
> `arm64` support is experimental, and is not provided in the Docker Hub
> images. To build an `arm64` image yourself, see `make help` locally.
# Or, pin a version:
docker pull ghcr.io/zulip/zulip:6.1-1
```

- Current Zulip Server version: `6.1`
- Current Docker image version: `6.1-1`
- Current architectures supported: `amd64`, `arm64`

See all available image tags [in GitHub Container
Registry](https://github.com/orgs/zulip/packages/container/package/zulip).

Project status: **Alpha**. While these images work and are used by many sites
in production, configuring is substantially more error-prone than the [bare
Expand Down
8 changes: 7 additions & 1 deletion build_and_push_image.sh
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,13 @@
set -ex

REGISTRY="${REGISTRY:-ghcr.io/zulip/zulip}"
REGISTRY_TAG="${REGISTRY_TAG:-$(tail -n 1 < "$(git rev-parse --show-toplevel)/IMAGE_TAG")}"
REGISTRY_TAG="${REGISTRY_TAG:-${GITHUB_REF_NAME}}"

if [ -z "${REGISTRY_TAG}" ]; then
echo "REGISTRY_TAG must be set in environment (default is \$GITHUB_REF_NAME, also from environment)" > /dev/stderr
exit 1
fi

PRIMARY_IMAGE="${REGISTRY}:${REGISTRY_TAG}"

if [ "${SKIP_PULL_CHECK}" != "1" ]; then
Expand Down

0 comments on commit 6889479

Please sign in to comment.