ci/docs: update workflows with modern practices, and update master->main, etc.

Author: consideRatio

.github/workflows/publish.yaml

@@ -1,32 +1,40 @@
----
+# This is a GitHub workflow defining a set of jobs with a set of steps.
+# ref: https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions
+#
+# This workflow will publish the Helm chart to jupyterhub/helm-chart's gh-pages
+# branch, which acts like a Helm chart repository (a static website with
+# index.yaml following a certain syntax).
+#
 name: Publish
 
 on:
   push:
     branches:
       - "main"
-      - "master"
+    paths-ignore:
+      - "**.md"
+      - ".github/workflows/*"
+      - "!.github/workflows/publish.yaml"
     tags:
       - "**"
 
 jobs:
-
   publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           # chartpress requires the full history
           fetch-depth: 0
 
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v3
         with:
-          python-version: '3.8'
+          python-version: "3.10"
 
       - name: Install dependencies (chartpress, helm)
         run: |
-          pip install --no-cache-dir chartpress
-          curl -sf https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3 | bash
+          pip install chartpress
+          curl -sf https://raw.githubusercontent.com/helm/helm/HEAD/scripts/get-helm-3 | bash
 
       - name: Setup push rights to jupyterhub/helm-chart
         # This was setup by...
@@ -47,8 +55,6 @@ jobs:
       - name: Configure a git user
         # Having a user.email and user.name configured with git is required to
         # make commits, which is something chartpress does when publishing.
-        # While Travis CI had a dummy user by default, GitHub Actions doesn't
-        # and require this explicitly setup.
         run: |
           git config --global user.email "[email protected]"
           git config --global user.name "GitHub Actions user"

.github/workflows/test.yaml

@@ -1,43 +1,68 @@
----
+# This is a GitHub workflow defining a set of jobs with a set of steps.
+# ref: https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions
+#
+# This workflow test the Helm chart in the following ways:
+#
+#   1. runs `helm lint`
+#   2. runs `helm install` with the `--wait` flag to ensure that pods startup and
+#      enters a ready state.
+#   3. runs `helm test` that runs primitive tests defined as part of the Helm chart
+#      under pebble/templates/tests to verify things seem to work.
+#
 name: Test
 
 on:
   pull_request:
+    paths-ignore:
+      - "**.md"
+      - ".github/workflows/*"
+      - "!.github/workflows/test.yaml"
   push:
+    paths-ignore:
+      - "**.md"
+      - ".github/workflows/*"
+      - "!.github/workflows/test.yaml"
+    branches-ignore:
+      - "dependabot/**"
+      - "pre-commit-ci-update-config"
+  workflow_dispatch:
 
 jobs:
   test_pebble:
     runs-on: ubuntu-latest
     timeout-minutes: 10
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           # chartpress requires the full history
           fetch-depth: 0
-      - uses: jupyterhub/[email protected]
+
+      # ref: https://github.com/jupyterhub/action-k3s-helm
+      - uses: jupyterhub/action-k3s-helm@v2
         with:
           k3s-version: ""
           helm-version: ""
           metrics-enabled: false
           traefik-enabled: false
-      - uses: actions/setup-python@v2
+
+      - uses: actions/setup-python@v3
         with:
-          python-version: '3.8'
+          python-version: "3.10"
+
       - name: Run tests
         run: |
           helm lint pebble --values ci/ci-values.yaml
           helm lint pebble --strict --values ci/ci-values.yaml
           helm template pebble ./pebble --values ci/ci-values.yaml --validate
           helm install pebble ./pebble --values ci/ci-values.yaml --wait --timeout 60s
           helm test pebble
-      - name: Emit report on success
-        if: success()
-        run: |
-          kubectl get all --all-namespaces
-      - name: Emit report on failure
-        if: failure()
-        run: |
-          kubectl get all --all-namespaces
-          kubectl logs pebble-test --all-containers --prefix
-          kubectl logs pebble-coredns-test --all-containers --prefix
-          kubectl logs deploy/pebble-coredns --all-containers --prefix
+
+      # ref: https://github.com/jupyterhub/action-k8s-namespace-report
+      - name: Kubernetes namespace report
+        uses: jupyterhub/action-k8s-namespace-report@v1
+        if: always()
+        with:
+          # The pebble-test and pebble-coredns-test pods are created by `helm
+          # test`, and the other workloads are part of the helm chart itself.
+          #
+          important-workloads: pebble-test pebble-coredns-test deploy/pebble deploy/pebble-coredns

README.md

@@ -1,7 +1,8 @@
 # Pebble Helm chart - Let's Encrypt for unreachable CI environment with Kubernetes!
 
-[![TravisCI (.com) build status](https://img.shields.io/travis/com/jupyterhub/pebble-helm-chart/master?logo=travis)](https://travis-ci.com/jupyterhub/pebble-helm-chart)
-[![Latest stable release of the Helm chart](https://img.shields.io/badge/dynamic/json.svg?label=version&url=https://jupyterhub.github.io/helm-chart/info.json&query=$.pebble.stable&colorB=orange&logo=helm)](https://jupyterhub.github.io/helm-chart/#pebble)
+[![GitHub Workflow Status - Test](https://img.shields.io/github/workflow/status/jupyterhub/pebble-helm-chart/test?logo=github&label=tests)](https://github.com/jupyterhub/zero-to-jupyterhub-k8s/actions)
+[![Latest stable release of the Helm chart](https://img.shields.io/badge/dynamic/json.svg?label=stable&url=https://jupyterhub.github.io/helm-chart/info.json&query=$.pebble.stable&colorB=orange&logo=helm)](https://jupyterhub.github.io/helm-chart#pebble)
+[![Latest development release of the Helm chart](https://img.shields.io/badge/dynamic/json.svg?label=dev&url=https://jupyterhub.github.io/helm-chart/info.json&query=$.pebble.latest&colorB=orange&logo=helm)](https://jupyterhub.github.io/helm-chart#development-releases-pebble)
 [![GitHub](https://img.shields.io/badge/issue_tracking-github-blue?logo=github)](https://github.com/jupyterhub/pebble-helm-chart/issues)
 [![Discourse](https://img.shields.io/badge/help_forum-discourse-blue?logo=discourse)](https://discourse.jupyter.org/c/jupyterhub)
 [![Gitter](https://img.shields.io/badge/social_chat-gitter-blue?logo=gitter)](https://gitter.im/jupyterhub/jupyterhub)
@@ -34,9 +35,11 @@ This Helm chart deploys an ACME server (Pebble) and a DNS server ([CoreDNS](http
 ## Installation
 
 ```shell
-helm repo add jupyterhub https://jupyterhub.github.io/helm-chart/
-helm repo update
-helm install pebble jupyterhub/pebble
+# Note that pebble is written twice below, the first is the helm chart name as
+# found in the Helm chart repository while the second is the name of the
+# "helm release" which is the Helm official terminology for an installation
+# of a Helm chart.
+helm install pebble pebble --repo=https://jupyterhub.github.io/helm-chart/
 ```
 
 
@@ -283,7 +286,7 @@ kubectl logs deploy/pebble-coredns --all-containers --prefix
 
 ## Release
 
-No changelog or similar yet. Making a release is as easy as pushing a tagged commit on the master branch.
+No changelog or similar yet. Making a release is as easy as pushing a tagged commit on the main branch.
 
 ```
 git tag -a x.y.z -m x.y.z

chartpress.yaml

@@ -1,3 +1,13 @@
+# This is the configuration for chartpress, a CLI for Helm chart management.
+#
+# chartpress is used to:
+# - Build images - but this Helm chart doesn't have any
+# - Update Chart.yaml (version) and values.yaml (image tags)
+# - Package and publish Helm charts to a GitHub based Helm chart repository
+#
+# For more information, see the projects README.md file:
+# https://github.com/jupyterhub/chartpress
+#
 charts:
   - name: pebble
     repo:

ci/publish

@@ -1,18 +1,20 @@
 #!/bin/bash
-# This script publishes the Helm chart to the JupyterHub Helm chart repo and
-# pushes associated built docker images to Docker hub using chartpress.
+# This script publishes the Helm chart to the JupyterHub Helm chart repo (a
+# static website based on GitHub Pages), using chartpress.
 # --------------------------------------------------------------------------
 
 # Exit on errors, assert env vars, log commands
 set -eux
 
+PUBLISH_ARGS="\
+    --push \
+    --publish-chart
+"
+
 # chartpress use git to push to our Helm chart repository, which is the gh-pages
 # branch of jupyterhub/helm-chart. We have installed a private SSH key within
 # the ~/.ssh folder with permissions to push to jupyterhub/helm-chart.
 if [[ $GITHUB_REF != refs/tags/* ]]; then
-    # Using --long, we are ensured to get a build suffix, which ensures we don't
-    # build the same tag twice.
-    #
     # Using --extra-message, we help readers of merged PRs to know what version
     # they need to bump to in order to make use of the PR. This is enabled by a
     # GitHub notificaiton in the PR like "Github Action user pushed a commit to
@@ -22,19 +24,24 @@ if [[ $GITHUB_REF != refs/tags/* ]]; then
     #
     # NOTE: GitHub merge commits contain a PR reference like #123. `sed` looks
     #       to extract either a PR reference like #123 or fall back to create a
-    #       commit hash reference like @123abcd. Combined with TRAVIS_REPO_SLUG
+    #       commit hash reference like @123abcd. Combined with GITHUB_REPOSITORY
     #       we craft a commit message like jupyterhub/pebble-helm-chart#123 or
     #       jupyterhub/pebble-helm-chart@123abcd which will be understood as a
     #       reference by GitHub.
     PR_OR_HASH=$(git log -1 --pretty=%h-%B | head -n1 | sed 's/^.*\(#[0-9]*\).*/\1/' | sed 's/^\([0-9a-f]*\)-.*/@\1/')
-    EXTRA_MESSAGE="${GITHUB_REPOSITORY}${PR_OR_HASH}"
-    chartpress --push --publish-chart --long --extra-message "${EXTRA_MESSAGE}"
+    LATEST_COMMIT_TITLE=$(git log -1 --pretty=%B | head -n1)
+    EXTRA_MESSAGE="${GITHUB_REPOSITORY}${PR_OR_HASH} ${LATEST_COMMIT_TITLE}"
+
+    # shellcheck disable=SC2086
+    chartpress $PUBLISH_ARGS --extra-message "${EXTRA_MESSAGE}"
 else
     # Setting a tag explicitly enforces a rebuild if this tag had already been
     # built and we wanted to override it.
-    chartpress --push --publish-chart --tag "${GITHUB_REF:10}"
+
+    # shellcheck disable=SC2086
+    chartpress $PUBLISH_ARGS --tag "${GITHUB_REF:10}"
 fi
 
-# Let us log the changes chartpress did, it should include replacements for
-# fields in values.yaml, such as what tag for various images we are using.
-git --no-pager diff
+# Let us log the changes chartpress did, it should include replacements for the
+# version field in Chart.yaml.
+git --no-pager diff --color

pebble/templates/pebble-configmap.yaml

@@ -26,7 +26,7 @@ data:
   #       These temporary root certs are exposed through a REST API at /roots/0
   #       on the acme-mgmt port.
   #
-  # ref: https://github.com/letsencrypt/pebble/tree/master/test/certs
+  # ref: https://github.com/letsencrypt/pebble/tree/HEAD/test/certs
   {{- (.Files.Glob "files/root-cert.pem").AsConfig | nindent 2 }}
   {{- (.Files.Glob "files/root-key.pem").AsConfig | nindent 2 }}
 {{- end }}

pebble/values.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://json-schema.org/draft-07/schema#",
-  "$id": "https://github.com/jupyterhub/pebble-helm-chart/blob/master/pebble/values.schema.json",
+  "$id": "https://github.com/jupyterhub/pebble-helm-chart/blob/HEAD/pebble/values.schema.json",
 
   "definitions": {
     "image": {