-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add update GA workflow with dockerhub job
- Loading branch information
1 parent
3fd1a2b
commit dfbc338
Showing
2 changed files
with
215 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| name: Update | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - .github/workflows/update.yml | ||
| - DOCKERHUB.md | ||
| workflow_dispatch: | ||
|
|
||
| env: | ||
| SLACK_CHANNEL: ${{ secrets.SLACK_CHANNEL }} | ||
| SLACK_SIGNING_SECRET: ${{ secrets.SLACK_SIGNING_SECRET }} | ||
| SLACK_TOKEN: ${{ secrets.SLACK_TOKEN }} | ||
|
|
||
| jobs: | ||
| dockerhub: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Check out | ||
| uses: actions/checkout@v4 | ||
| - name: Send Slack notification | ||
| uses: codedsolar/slack-action@v1 | ||
| if: ${{ github.event_name != 'pull_request' }} | ||
| id: slack | ||
| with: | ||
| fields: | | ||
| {STATUS} | ||
| {REF} | ||
| Short description length: Checking... | ||
| Description length: Checking... | ||
| status: in-progress | ||
| - name: Output additional GitHub context | ||
| id: github | ||
| run: | | ||
| description=$(curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \ | ||
| "https://api.github.com/repos/${{ github.repository }}" | \ | ||
| jq -r '.description') | ||
| echo "description=$description" >> $GITHUB_OUTPUT | ||
| - name: Output lengths | ||
| id: lengths | ||
| run: | | ||
| description=$(cat ./DOCKERHUB.md | wc -c) | ||
| short_description=$(echo '${{ steps.github.outputs.description }}' | wc -c) | ||
| echo "description=$description" >> $GITHUB_OUTPUT | ||
| echo "short-description=$short_description" >> $GITHUB_OUTPUT | ||
| - name: Check results | ||
| run: | | ||
| description_length='${{ steps.lengths.outputs.description }}' | ||
| short_description='${{ steps.github.outputs.description }}' | ||
| short_description_length='${{ steps.lengths.outputs.short-description }}' | ||
| echo "Short description: $short_description" | ||
| echo "Short description length: $short_description_length" | ||
| echo "Description length: $description_length" | ||
| exit_code=1 | ||
| if [ "$description_length" -gt 0 ] && [ "$description_length" -lt 25000 ] && [ "$short_description_length" -gt 0 ]; then | ||
| exit_code=0 | ||
| fi | ||
| exit "$exit_code" | ||
| - name: Update Docker Hub repository overview | ||
| uses: peter-evans/dockerhub-description@v3 | ||
| if: ${{ !env.ACT }} | ||
| with: | ||
| username: ${{ secrets.DOCKERHUB_USERNAME }} | ||
| password: ${{ secrets.DOCKERHUB_TOKEN }} | ||
| repository: ${{ github.repository_owner }}/ktools | ||
| short-description: ${{ steps.github.outputs.description }} | ||
| readme-filepath: ./DOCKERHUB.md | ||
| - name: Update Slack notification | ||
| uses: codedsolar/slack-action@v1 | ||
| if: ${{ github.event_name != 'pull_request' && always() }} | ||
| with: | ||
| fields: | | ||
| {STATUS} | ||
| {REF} | ||
| Short description length: ${{ steps.lengths.outputs.short-description || 'Skipped' }} | ||
| Description length: ${{ steps.lengths.outputs.description || 'Skipped' }} | ||
| status: ${{ job.status }} | ||
| timestamp: ${{ steps.slack.outputs.slack-timestamp }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| ## Supported tags and respective `Dockerfile` links | ||
|
|
||
| - [`4.5.1-imagemagick-7.1.1-30-alpine`, `4.5.1`, `alpine`, `latest`](https://github.com/dstmodders/docker-ktools/blob/7ef33349f1b1be037c8f1757171ad82404cca97c/latest/alpine/Dockerfile) | ||
| - [`4.5.1-imagemagick-7.1.1-30-debian`, `debian`](https://github.com/dstmodders/docker-ktools/blob/7ef33349f1b1be037c8f1757171ad82404cca97c/latest/debian/Dockerfile) | ||
| - [`4.5.0-imagemagick-7.1.1-30-alpine`, `4.5.0`, `alpine`](https://github.com/dstmodders/docker-ktools/blob/7ef33349f1b1be037c8f1757171ad82404cca97c/latest/alpine/Dockerfile) | ||
| - [`4.5.0-imagemagick-7.1.1-30-debian`, `debian`](https://github.com/dstmodders/docker-ktools/blob/7ef33349f1b1be037c8f1757171ad82404cca97c/latest/debian/Dockerfile) | ||
| - [`4.5.0-imagemagick-7.1.0-5-alpine`](https://github.com/dstmodders/docker-ktools/blob/ef2d40c3fc2e675ca492371e0e539f13449a1846/latest/alpine/Dockerfile) | ||
| - [`4.5.0-imagemagick-7.1.0-5-debian`](https://github.com/dstmodders/docker-ktools/blob/ef2d40c3fc2e675ca492371e0e539f13449a1846/latest/debian/Dockerfile) | ||
| - [`4.4.1-imagemagick-6.9.13-8-alpine`, `4.4.1`, `alpine`](https://github.com/dstmodders/docker-ktools/blob/7ef33349f1b1be037c8f1757171ad82404cca97c/latest/alpine/Dockerfile) | ||
| - [`4.4.1-imagemagick-6.9.13-8-debian`, `debian`](https://github.com/dstmodders/docker-ktools/blob/7ef33349f1b1be037c8f1757171ad82404cca97c/latest/debian/Dockerfile) | ||
| - [`official-4.4.0-imagemagick-6.9.13-8-alpine`, `official-4.4.0`, `official-alpine`, `official-latest`](https://github.com/dstmodders/docker-ktools/blob/7ef33349f1b1be037c8f1757171ad82404cca97c/official/alpine/Dockerfile) | ||
| - [`official-4.4.0-imagemagick-6.9.13-8-debian`, `official-debian`](https://github.com/dstmodders/docker-ktools/blob/7ef33349f1b1be037c8f1757171ad82404cca97c/official/debian/Dockerfile) | ||
| - [`official-4.3.1-imagemagick-6.9.13-8-alpine`, `official-4.3.1`, `official-alpine`](https://github.com/dstmodders/docker-ktools/blob/7ef33349f1b1be037c8f1757171ad82404cca97c/official/alpine/Dockerfile) | ||
| - [`official-4.3.1-imagemagick-6.9.13-8-debian`, `official-debian`](https://github.com/dstmodders/docker-ktools/blob/7ef33349f1b1be037c8f1757171ad82404cca97c/official/debian/Dockerfile) | ||
| - [`official-4.3.0-imagemagick-6.9.13-8-alpine`, `official-4.3.0`, `official-alpine`](https://github.com/dstmodders/docker-ktools/blob/7ef33349f1b1be037c8f1757171ad82404cca97c/official/alpine/Dockerfile) | ||
| - [`official-4.3.0-imagemagick-6.9.13-8-debian`, `official-debian`](https://github.com/dstmodders/docker-ktools/blob/7ef33349f1b1be037c8f1757171ad82404cca97c/official/debian/Dockerfile) | ||
|
|
||
| ## Overview | ||
|
|
||
| [Docker] images for modding tools of Klei Entertainment's game | ||
| [Don't Starve]. | ||
|
|
||
| - [Environment variables](#environment-variables) | ||
| - [Usage](#usage) | ||
| - [Build](#build) | ||
|
|
||
| ## Environment variables | ||
|
|
||
| | Name | Value | Description | | ||
| | --------------------- | ---------------------- | --------------------- | | ||
| | `DS_KTOOLS_KRANE` | `/usr/local/bin/krane` | Path to [krane] | | ||
| | `DS_KTOOLS_KTECH` | `/usr/local/bin/ktech` | Path to [ktech] | | ||
| | `DS_KTOOLS_VERSION` | `4.5.1` | [ktools] version | | ||
| | `IMAGEMAGICK_VERSION` | `7.1.1-30` | [ImageMagick] version | | ||
|
|
||
| ## Usage | ||
|
|
||
| [Fork releases] (recommended): | ||
|
|
||
| ```shell | ||
| $ docker pull dstmodders/ktools:latest | ||
| # or | ||
| $ docker pull ghcr.io/dstmodders/ktools:latest | ||
| ``` | ||
|
|
||
| Or you can pick one of the [official releases]: | ||
|
|
||
| ```shell | ||
| $ docker pull dstmodders/ktools:official | ||
| # or | ||
| $ docker pull ghcr.io/dstmodders/ktools:official | ||
| ``` | ||
|
|
||
| See [tags] for a list of all available versions. | ||
|
|
||
| #### Shell/Bash (Linux & macOS) | ||
|
|
||
| ```shell | ||
| $ docker run --rm -v "$(pwd):/data/" dstmodders/ktools ktech --version | ||
| ``` | ||
|
|
||
| #### CMD (Windows) | ||
|
|
||
| ```cmd | ||
| > docker run --rm -v "%CD%:/data/" dstmodders/ktools ktech --version | ||
| ``` | ||
|
|
||
| #### PowerShell (Windows) | ||
|
|
||
| ```powershell | ||
| PS:\> docker run --rm -v "${PWD}:/data/" dstmodders/ktools ktech --version | ||
| ``` | ||
|
|
||
| ## Build | ||
|
|
||
| To build images locally: | ||
|
|
||
| ```shell | ||
| $ docker build ./latest/alpine/ --tag='dstmodders/ktools:alpine' | ||
| $ docker build ./latest/debian/ --tag='dstmodders/ktools:debian' | ||
| $ docker build ./official/alpine/ --tag='dstmodders/ktools:official-alpine' | ||
| $ docker build ./official/debian/ --tag='dstmodders/ktools:official-debian' | ||
| ``` | ||
|
|
||
| To build images locally using [buildx] to target multiple platforms, ensure that | ||
| your builder is running. If you are using [QEMU] emulation, you may also need to | ||
| enable [qemu-user-static]. | ||
|
|
||
| In overall, to create your builder and enable [QEMU] emulation: | ||
|
|
||
| ```shell | ||
| $ docker buildx create --name mybuilder --use --bootstrap | ||
| $ docker run --rm --privileged multiarch/qemu-user-static --reset -p yes | ||
| ``` | ||
|
|
||
| Respectively, to build multi-platform images locally: | ||
|
|
||
| ```shell | ||
| $ docker buildx build ./latest/alpine/ --platform='linux/amd64,linux/386' --tag='dstmodders/ktools:alpine' | ||
| $ docker buildx build ./latest/debian/ --platform='linux/amd64,linux/386' --tag='dstmodders/ktools:debian' | ||
| $ docker buildx build ./official/alpine/ --platform='linux/amd64,linux/386' --tag='dstmodders/ktools:official-alpine' | ||
| $ docker buildx build ./official/debian/ --platform='linux/amd64,linux/386' --tag='dstmodders/ktools:official-debian' | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| Released under the [MIT License](https://opensource.org/licenses/MIT). | ||
|
|
||
| [@nsimplex]: https://github.com/nsimplex | ||
| [alpine size]: https://img.shields.io/docker/image-size/dstmodders/ktools/alpine?label=alpine%20size&logo=docker | ||
| [build]: https://img.shields.io/github/actions/workflow/status/dstmodders/docker-ktools/build.yml?branch=main&label=build&logo=github | ||
| [buildx]: https://github.com/docker/buildx | ||
| [ci]: https://img.shields.io/github/actions/workflow/status/dstmodders/docker-ktools/ci.yml?branch=main&label=ci&logo=github | ||
| [debian size]: https://img.shields.io/docker/image-size/dstmodders/ktools/debian?label=debian%20size&logo=docker | ||
| [docker]: https://www.docker.com/ | ||
| [don't starve]: https://www.klei.com/games/dont-starve | ||
| [dstmodders/ktools]: https://github.com/dstmodders/ktools | ||
| [fork releases]: https://github.com/dstmodders/ktools/releases | ||
| [gcc]: https://gcc.gnu.org/ | ||
| [imagemagick]: https://imagemagick.org/index.php | ||
| [krane]: https://github.com/nsimplex/ktools#krane | ||
| [ktech]: https://github.com/nsimplex/ktools#ktech | ||
| [ktools]: https://github.com/nsimplex/ktools | ||
| [latest state]: https://github.com/nsimplex/ktools/tree/a1d1362bdb2b9aa9146d7177fbf0e351eab414ba | ||
| [nsimplex/ktools]: https://github.com/nsimplex/ktools | ||
| [official releases]: https://github.com/nsimplex/ktools/releases | ||
| [official]: https://github.com/nsimplex/ktools/releases | ||
| [qemu-user-static]: https://github.com/multiarch/qemu-user-static | ||
| [qemu]: https://www.qemu.org/ | ||
| [tags]: https://hub.docker.com/r/dstmodders/ktools/tags | ||
| [v4.4.0]: https://github.com/dstmodders/ktools/releases/tag/4.4.0 | ||
| [v4.4.1]: https://github.com/dstmodders/ktools/releases/tag/v4.4.1 |