From d755cd06c99f00903811f5e8d0b75cdd167f7f94 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Markus=20K=C3=BCffner?= Date: Thu, 7 Dec 2023 17:19:13 +0100 Subject: [PATCH] ci: add image docs workflows --- .github/workflows/image-docs-klipper.yaml | 18 +++++++++++ .../workflows/image-docs-klipperscreen.yaml | 18 +++++++++++ .github/workflows/image-docs-moonraker.yaml | 18 +++++++++++ .github/workflows/image-docs-ustreamer.yaml | 18 +++++++++++ .../template-image-build-workflow.yaml | 2 +- .../template-image-docs-workflow.yaml | 32 +++++++++++++++++++ CHANGELOG.md | 1 + 7 files changed, 106 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/image-docs-klipper.yaml create mode 100644 .github/workflows/image-docs-klipperscreen.yaml create mode 100644 .github/workflows/image-docs-moonraker.yaml create mode 100644 .github/workflows/image-docs-ustreamer.yaml create mode 100644 .github/workflows/template-image-docs-workflow.yaml diff --git a/.github/workflows/image-docs-klipper.yaml b/.github/workflows/image-docs-klipper.yaml new file mode 100644 index 0000000..fff928d --- /dev/null +++ b/.github/workflows/image-docs-klipper.yaml @@ -0,0 +1,18 @@ +name: 'Docs: Klipper' +on: + push: + branches: + - main + paths: + - .github/workflows/template-image-docs-workflow.yaml + - docker/klipper/README.md + +jobs: + docs: + uses: ./.github/workflows/template-image-docs-workflow.yaml + with: + app: klipper + short-description: "Klipper is a 3d-Printer firmware." + secrets: + DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }} + DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/image-docs-klipperscreen.yaml b/.github/workflows/image-docs-klipperscreen.yaml new file mode 100644 index 0000000..3dc69f8 --- /dev/null +++ b/.github/workflows/image-docs-klipperscreen.yaml @@ -0,0 +1,18 @@ +name: 'Docs: KlipperScreen' +on: + push: + branches: + - main + paths: + - .github/workflows/template-image-docs-workflow.yaml + - docker/klipperscreen/README.md + +jobs: + docs: + uses: ./.github/workflows/template-image-docs-workflow.yaml + with: + app: klipperscreen + short-description: "KlipperScreen is a touchscreen GUI that interfaces with Klipper via Moonraker." + secrets: + DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }} + DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/image-docs-moonraker.yaml b/.github/workflows/image-docs-moonraker.yaml new file mode 100644 index 0000000..cfe2c51 --- /dev/null +++ b/.github/workflows/image-docs-moonraker.yaml @@ -0,0 +1,18 @@ +name: 'Docs: Moonraker' +on: + push: + branches: + - main + paths: + - .github/workflows/template-image-docs-workflow.yaml + - docker/moonraker/README.md + +jobs: + docs: + uses: ./.github/workflows/template-image-docs-workflow.yaml + with: + app: moonraker + short-description: "Web API used to interact with the 3D printing firmware Klipper." + secrets: + DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }} + DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/image-docs-ustreamer.yaml b/.github/workflows/image-docs-ustreamer.yaml new file mode 100644 index 0000000..ccff048 --- /dev/null +++ b/.github/workflows/image-docs-ustreamer.yaml @@ -0,0 +1,18 @@ +name: 'Docs: Ustreamer' +on: + push: + branches: + - main + paths: + - .github/workflows/template-image-docs-workflow.yaml + - docker/ustreamer/README.md + +jobs: + docs: + uses: ./.github/workflows/template-image-docs-workflow.yaml + with: + app: ustreamer + short-description: "µStreamer is a lightweight and very quick server to stream MJPEG video" + secrets: + DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }} + DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/template-image-build-workflow.yaml b/.github/workflows/template-image-build-workflow.yaml index 200a212..649384d 100644 --- a/.github/workflows/template-image-build-workflow.yaml +++ b/.github/workflows/template-image-build-workflow.yaml @@ -1,4 +1,4 @@ -name: image-build-workflow +name: "Template: image-build-workflow" on: workflow_call: inputs: diff --git a/.github/workflows/template-image-docs-workflow.yaml b/.github/workflows/template-image-docs-workflow.yaml new file mode 100644 index 0000000..d5752c8 --- /dev/null +++ b/.github/workflows/template-image-docs-workflow.yaml @@ -0,0 +1,32 @@ +name: "Template: image-docs-workflow" +on: + workflow_call: + inputs: + app: + required: true + type: string + description: 'app image to build' + short-description: + required: true + type: string + description: 'Docker Hub repository short description' + secrets: + DOCKERHUB_USERNAME: + required: true + DOCKERHUB_TOKEN: + required: true + +jobs: + image-docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: "Update Docker Hub Description" + uses: peter-evans/dockerhub-description@v3 + with: + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_TOKEN }} + repository: ${{ secrets.DOCKERHUB_USERNAME }}/${{ inputs.app }} + short-description: ${{ inputs.short-description }} + readme-filepath: ./docker/${{ inputs.app }}/README.md + enable-url-completion: true \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index a157caf..6348bb0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,6 +14,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). - docker: pin base images to python:3.11-(slim-)bookworm - extra: simplify moonraker-timelapse setup - ci: restructure image build workflows +- ci: add image docs workflow to update dockerhub descriptions automatically ### Removed -->