Publish Docker image as a repository artifact

• I’ve read the contribution guidelines and agree with them
• … to my best knowledge, my idea wouldn’t break something for other users
• … the documentation does not mention anything about my idea
• … there are no open or closed issues that are related to my idea

Description

It will be great to publish a Docker image as a package of this repository.

Use Cases

It will be easier for sponsors to consume the insiders version since GitHub will require authentication in order to pull the image so only sponsors will be able to pull it.

Screenshots / Mockups

This action should work perfectly for both this repository and the insiders one thanks to ${{ github.event.repository.full_name }}:

name: Publish Docker image
on:
  release:
    types: [published]
jobs:
  push_to_registry:
    name: Push Docker image to GitHub Packages
    runs-on: ubuntu-latest
    steps:
      - name: Check out the repo
        uses: actions/checkout@v2
      - name: Push to GitHub Packages
        uses: docker/build-push-action@v1
        with:
          username: ${{ github.actor }}
          password: ${{ secrets.GITHUB_TOKEN }}
          registry: docker.pkg.github.com
          repository: ${{ github.event.repository.full_name }}/mkdocs
          tag_with_ref: true

[squidfunk]

I took the opportunity and refactored the whole build pipeline into multiple workflows. Futhermore, I decided to use GitHub Container Registry, as Docker support is going to be deprecated next year for GitHub Package Registry. Thus, to use it, it may be necessary that you opt-in to the public beta of GHCR. The official image is now dual-released on DockerHub and GHCR:

# Pull from DockerHub
docker pull squidfunk/mkdocs-material 
# Pull from GitHub Container Registry
docker pull ghcr.io/squidfunk/mkdocs-material 

Insiders is now also published as a private container image. You need to login to ghcr.io with a personal access token granting the packages:read scope. Afterwards you can pull the image:

docker login ghcr.io # Enter username and access token
docker pull ghcr.io/squidfunk/mkdocs-material-insiders

I’m marking this issue as resolved. Thank you for your help on this! If you have any trouble or feel that something is missing, don’t hesitate to comment. I hope this improves the Insiders experience. I’ll add some docs in a few minutes.

[squidfunk]

Awesome, thanks so looking into this! I’ll try to address it this weekend.