feat: publish container image for cli (#11)

Signed-off-by: Mathew Wicks <[email protected]>

Author: thesuperzapper

.github/workflows/publish.yml

@@ -0,0 +1,71 @@
+name: Publish
+
+on:
+  release:
+    types:
+      - published
+
+permissions:
+  contents: write
+  packages: write
+
+env:
+  IMAGE_OWNER: ${{ github.repository_owner }}
+  IMAGE_TITLE: "cli"
+  IMAGE_DESCRIPTION: "the CLI for deployKF"
+  IMAGE_FOLDER: ""
+  IMAGE_PLATFORMS: |-
+    linux/amd64
+    linux/arm64
+
+jobs:
+  build_and_push_images:
+    runs-on: ubuntu-latest
+    ## only run if the tag looks like a semver
+    if: startsWith(github.ref_name, 'v')
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+
+      - name: Install QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Install Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Generate Image Tags/Labels
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: |
+            ghcr.io/${{ env.IMAGE_OWNER }}/${{ env.IMAGE_TITLE }}
+          flavor: |
+            latest=auto
+          tags: |
+            type=semver,priority=200,pattern={{major}}.{{minor}}
+            type=semver,priority=100,pattern={{version}}
+          labels: |
+            org.opencontainers.image.title=${{ env.IMAGE_TITLE }}
+            org.opencontainers.image.description=${{ env.IMAGE_DESCRIPTION }}
+            org.opencontainers.image.url=https://github.com/${{ github.repository }}/tree/main/${{ env.IMAGE_FOLDER }}
+            org.opencontainers.image.source=https://github.com/${{ github.repository }}/tree/main/${{ env.IMAGE_FOLDER }}
+
+      - name: Build and Push Image
+        uses: docker/build-push-action@v4
+        with:
+          context: ./${{ env.IMAGE_FOLDER }}
+          build-args: |
+            DKF_CLI_RELEASE_TAG=${{ github.ref_name }}
+          push: true
+          platforms: ${{ env.IMAGE_PLATFORMS }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=registry,ref=ghcr.io/${{ env.IMAGE_OWNER }}/ci/${{ env.IMAGE_TITLE }}
+          cache-to: type=registry,ref=ghcr.io/${{ env.IMAGE_OWNER }}/ci/${{ env.IMAGE_TITLE }},mode=max

Dockerfile

@@ -0,0 +1,33 @@
+FROM alpine:3.18.2
+
+ARG TARGETOS
+ARG TARGETARCH
+
+# args -- software versions
+ARG DKF_CLI_OS=${TARGETOS}
+ARG DKF_CLI_ARCH=${TARGETARCH}
+ARG DKF_CLI_RELEASE_TAG=v0.1.0
+
+# args -- uid/gid
+ARG DEPLOYKF_USER=deploykf
+ARG DEPLOYKF_GROUP=deploykf
+ARG DEPLOYKF_UID=1001
+ARG DEPLOYKF_GID=1001
+ARG DEPLOYKF_HOME=/home/${DEPLOYKF_USER}
+
+# install deploykf cli
+RUN wget -q -O /tmp/deploykf "https://github.com/deploykf/cli/releases/download/${DKF_CLI_RELEASE_TAG}/deploykf-${DKF_CLI_OS}-${DKF_CLI_ARCH}" \
+ && wget -q -O /tmp/deploykf.sha256 "https://github.com/deploykf/cli/releases/download/${DKF_CLI_RELEASE_TAG}/deploykf-${DKF_CLI_OS}-${DKF_CLI_ARCH}.sha256" \
+ && echo "$(cat /tmp/deploykf.sha256 | awk '{ print $1; }')  /tmp/deploykf" | sha256sum -c - \
+ && chmod +x /tmp/deploykf \
+ && mv /tmp/deploykf /usr/local/bin/deploykf \
+ && rm -rf /tmp/deploykf*
+
+# create non-root 'deploykf' user/group
+RUN addgroup -g ${DEPLOYKF_GID} "${DEPLOYKF_GROUP}" \
+ && adduser -D -h "${DEPLOYKF_HOME}" -u ${DEPLOYKF_UID} -G ${DEPLOYKF_GROUP} "${DEPLOYKF_USER}"
+
+USER ${DEPLOYKF_UID}:${DEPLOYKF_GID}
+WORKDIR ${DEPLOYKF_HOME}
+
+ENTRYPOINT ["/usr/local/bin/deploykf"]

README.md

@@ -30,6 +30,35 @@ deploykf \
 This command will generate deployKF manifests in the `./GENERATOR_OUTPUT` directory using the `v0.1.0` source version and the values specified in your `./custom-values.yaml` file. 
 Note that the `--source-version` flag must correspond to a tag from a [deployKF release](https://github.com/deployKF/deployKF/releases).
 
+> __TIP:__ 
+> 
+> The version of the CLI does NOT need to match the `--source-version` you are generating manifests for.
+> If a breaking change is ever needed, the CLI will fail to generate with newer source versions, and will print message telling you to upgrade the CLI.
+
+## Container Image
+
+We publish the `deploykf` CLI as a container image on the following registries:
+
+| Registry                  | Image                                                  | Pull Command                                |
+|---------------------------|--------------------------------------------------------|---------------------------------------------|
+| GitHub Container Registry | [`ghcr.io/deploykf/cli`](https://ghcr.io/deploykf/cli) | `docker pull ghcr.io/deploykf/cli:TAG_NAME` |
+
+To use the container image, you need to mount your local filesystem into the container:
+
+```bash
+CONTAINER_IMAGE="ghcr.io/deploykf/cli:0.1.1"
+
+docker run \
+  --rm \
+  --volume "$(pwd):/home/deploykf" \
+  --volume "${HOME}/.deploykf:/home/deploykf/.deploykf" \
+  "${CONTAINER_IMAGE}" \
+    generate \
+    --source-version "0.1.0" \
+    --values ./sample-values.yaml \
+    --output-dir ./GENERATOR_OUTPUT
+```
+
 ## Development
 
 Here are some helpful commands when developing the CLI:

RELEASING.md

@@ -18,4 +18,5 @@ This guide is intended for maintainers who want to make a new release of the dep
        - The release will include the binaries and corresponding SHA256 checksums for all supported platforms.
 3. Generate the changelog using the "generate release notes" feature of GitHub and set it as the release description.
 4. When ready to ship, manually publish the draft release.
+    - This will trigger a workflow to build and push the Docker images for the release.
 5. Update the changelog on the website using the [`update_changelogs.sh`](https://github.com/deployKF/website/blob/main/update_changelogs.sh) script.