Container registry- and engine-generic documentation (#213)

Author: LeoColomb

.gitattributes

@@ -1 +1,3 @@
-Dockerfile.template        linguist-language=Dockerfile
+* text=auto eol=lf
+
+Dockerfile.template linguist-language=Dockerfile

.github/workflows/ci.yml

@@ -19,7 +19,7 @@ jobs:
 
       - name: Extract current version
         id: version-step
-        run: echo "version=$(grep -oP '^ARG YOURLS_VERSION=\"\K[^\"]+' Dockerfile.template)" >> $GITHUB_OUTPUT
+        run: echo "version=$(grep -oP '^ARG YOURLS_VERSION=\"\K[^\"]+' images/yourls/Dockerfile.template)" >> $GITHUB_OUTPUT
 
   files:
     name: Files
@@ -28,22 +28,22 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Generate variants
-        run: ./bin/generate-variants.sh dist/
+        run: ./images/yourls/bin/generate-variants.sh dist/
 
       - name: Prepare scripts
         run: |
-          mkdir dist/bin
-          cp ./bin/* dist/bin
-          rm ./dist/bin/generate-variants.sh
+          mkdir ./images/yourls/dist/bin
+          cp ./images/yourls/bin/* ./images/yourls/dist/bin
+          rm ./images/yourls/dist/bin/generate-variants.sh
 
       - name: Copy version
-        run: grep -oP '^ARG YOURLS_VERSION="\K[^"]+' Dockerfile.template > ./dist/yourls_version
+        run: grep -oP '^ARG YOURLS_VERSION="\K[^"]+' ./images/yourls/Dockerfile.template > ./images/yourls/dist/yourls_version
 
       - name: Save files
         uses: actions/upload-artifact@v3
         with:
           name: context-files
-          path: dist
+          path: ./images/yourls/dist
 
   build:
     name: Build
@@ -60,7 +60,7 @@ jobs:
         with:
           name: context-files
 
-      - run: chmod +x ./*/docker-entrypoint.sh
+      - run: chmod +x ./*/container-entrypoint.sh
 
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2

.github/workflows/hub.yml

@@ -1,6 +1,6 @@
 # https://docs.github.com/actions
 
-name: Hub
+name: Docker Hub
 
 on:
   workflow_dispatch:

.github/workflows/lint.yml

@@ -15,4 +15,4 @@ jobs:
     name: Code Base
     uses: YOURLS/.github/.github/workflows/lint.yml@main
     with:
-      exclude: Dockerfile.template
+      exclude: images/yourls/Dockerfile.template

.github/workflows/release.yml

@@ -32,7 +32,7 @@ jobs:
         with:
           name: context-files
 
-      - run: chmod +x bin/* && chmod +x ./*/docker-entrypoint.sh
+      - run: chmod +x bin/* && chmod +x ./*/container-entrypoint.sh
 
       - name: Deploy
         uses: peaceiris/[email protected]
@@ -89,7 +89,7 @@ jobs:
         with:
           name: context-files
 
-      - run: chmod +x ./*/docker-entrypoint.sh
+      - run: chmod +x ./*/container-entrypoint.sh
 
       - name: Install Cosign
         uses: sigstore/[email protected]
@@ -149,6 +149,17 @@ jobs:
             org.opencontainers.image.created=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.created'] }}
             org.opencontainers.image.revision=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.revision'] }}
             org.opencontainers.image.source=https://github.com/${{ secrets.image }}
+            org.opencontainers.image.version=${{ inputs.version }}
+            org.opencontainers.image.title=YOURLS
+            org.opencontainers.image.description=Your Own URL Shortener
+            org.opencontainers.image.url=https://yourls.org
+            org.opencontainers.image.documentation=https://yourls.org
+            org.opencontainers.image.vendor=YOURLS Org
+            org.opencontainers.image.authors=YOURLS
+            org.opencontainers.image.licenses=MIT
+            io.artifacthub.package.readme-url=https://raw.githubusercontent.com/YOURLS/images/main/images/yourls/README.md
+            io.artifacthub.package.alternative-locations=docker.io/library/yourls
+            io.artifacthub.package.logo-url=https://yourls.org/images/yourls-logo.svg
           tags: ${{ steps.meta.outputs.tags }}
           cache-from: type=gha,scope=${{ matrix.variant }}
           # cache-to: type=gha,scope=${{ matrix.variant }},mode=max

README.md

@@ -1,44 +1,19 @@
-# YOURLS using Docker
+# YOURLS using Containers
 
-> Official [Docker](https://docker.com) images for [YOURLS](https://yourls.org).
+> Official [container](https://opencontainers.org) images for [YOURLS](https://yourls.org).
 
-[![Build Status](https://github.com/YOURLS/docker/workflows/Docker%20CI/badge.svg)](https://github.com/YOURLS/docker/actions)
-[![Docker Hub Pulls](https://img.shields.io/docker/pulls/_/yourls.svg)](https://hub.docker.com/_/yourls)
-[![Docker Hub Stars](https://img.shields.io/docker/stars/_/yourls.svg)](https://hub.docker.com/_/yourls)
+[![Build Status](https://github.com/YOURLS/images/actions/workflows/ci.yml/badge.svg)](https://github.com/YOURLS/images/actions/workflows/ci.yml)
+[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/yourls)](https://artifacthub.io/packages/search?repo=yourls-images)
 [![Listed in Awesome YOURLS](https://img.shields.io/badge/Awesome-YOURLS-C5A3BE)](https://github.com/YOURLS/awesome-yourls)
 
 ## About
 
-This is the Git repository of the [Docker "Official Image"](https://docs.docker.com/docker-hub/official_repos/) for [YOURLS](https://hub.docker.com/_/yourls).
+This is the Git repository of the official container images for YOURLS.
 
+| Image | Docker Hub | Version |
+|:-----:|:----------:|:-------:|
+| `ghcr.io/yourls/yourls` | `docker.io/library/yourls` (`yourls`) | [![Image Version](https://img.shields.io/docker/v/_/yourls?label=yourls&sort=semver)](https://artifacthub.io/packages/container/yourls-images/yourls) |
 
-## Usage
+## License
 
-See [the Docker Hub page](https://hub.docker.com/_/yourls) for the full readme on how to use this Docker image and for information regarding contributing and issues.
-
-
-## FAQ
-
-### How to change README page visible on Docker Hub?
-
-The [full description from Docker Hub](https://hub.docker.com/_/yourls) is generated over in [docker-library/docs](https://github.com/docker-library/docs), specifically in [docker-library/docs/yourls](https://github.com/docker-library/docs/tree/master/yourls).
-
-### See a change merged here that doesn't show up on Docker Hub yet?
-
-Check [the "library/yourls" manifest file in the docker-library/official-images repository](https://github.com/docker-library/official-images/blob/master/library/yourls), especially [PRs with the "library/yourls" label on that repository](https://github.com/docker-library/official-images/labels/library%2Fyourls).
-
-For more information about the official images process, see the [docker-library/official-images readme](https://github.com/docker-library/official-images/blob/master/README.md).
-
-### Is there an alternative Container Registry?
-
-Yes, YOURLS images are also [hosted on the GitHub Container Registry](https://github.com/YOURLS/YOURLS/pkgs/container/yourls).
-
----
-
-| Build | Status | Badges | (per-arch) |
-|:-:|:-:|:-:|:-:|
-| [![amd64 build status badge](https://img.shields.io/jenkins/s/https/doi-janky.infosiftr.net/job/multiarch/job/amd64/job/yourls.svg?label=amd64)](https://doi-janky.infosiftr.net/job/multiarch/job/amd64/job/yourls/) | [![arm32v5 build status badge](https://img.shields.io/jenkins/s/https/doi-janky.infosiftr.net/job/multiarch/job/arm32v5/job/yourls.svg?label=arm32v5)](https://doi-janky.infosiftr.net/job/multiarch/job/arm32v5/job/yourls/) | [![arm32v6 build status badge](https://img.shields.io/jenkins/s/https/doi-janky.infosiftr.net/job/multiarch/job/arm32v6/job/yourls.svg?label=arm32v6)](https://doi-janky.infosiftr.net/job/multiarch/job/arm32v6/job/yourls/) | [![arm32v7 build status badge](https://img.shields.io/jenkins/s/https/doi-janky.infosiftr.net/job/multiarch/job/arm32v7/job/yourls.svg?label=arm32v7)](https://doi-janky.infosiftr.net/job/multiarch/job/arm32v7/job/yourls/) |
-| [![arm64v8 build status badge](https://img.shields.io/jenkins/s/https/doi-janky.infosiftr.net/job/multiarch/job/arm64v8/job/yourls.svg?label=arm64v8)](https://doi-janky.infosiftr.net/job/multiarch/job/arm64v8/job/yourls/) | [![i386 build status badge](https://img.shields.io/jenkins/s/https/doi-janky.infosiftr.net/job/multiarch/job/i386/job/yourls.svg?label=i386)](https://doi-janky.infosiftr.net/job/multiarch/job/i386/job/yourls/) | [![mips64le build status badge](https://img.shields.io/jenkins/s/https/doi-janky.infosiftr.net/job/multiarch/job/mips64le/job/yourls.svg?label=mips64le)](https://doi-janky.infosiftr.net/job/multiarch/job/mips64le/job/yourls/) | [![ppc64le build status badge](https://img.shields.io/jenkins/s/https/doi-janky.infosiftr.net/job/multiarch/job/ppc64le/job/yourls.svg?label=ppc64le)](https://doi-janky.infosiftr.net/job/multiarch/job/ppc64le/job/yourls/) |
-| [![s390x build status badge](https://img.shields.io/jenkins/s/https/doi-janky.infosiftr.net/job/multiarch/job/s390x/job/yourls.svg?label=s390x)](https://doi-janky.infosiftr.net/job/multiarch/job/s390x/job/yourls/) | [![put-shared build status badge](https://img.shields.io/jenkins/s/https/doi-janky.infosiftr.net/job/put-shared/job/light/job/yourls.svg?label=put-shared)](https://doi-janky.infosiftr.net/job/put-shared/job/light/job/yourls/) |
-
-<!-- THIS FILE IS GENERATED BY https://github.com/docker-library/docs/blob/master/generate-repo-stub-readme.sh -->
+This project is licensed under [MIT License](LICENSE).

Dockerfile.template images/yourls/Dockerfile.template

@@ -7,7 +7,7 @@ LABEL org.opencontainers.image.documentation="https://yourls.org/"
 LABEL org.opencontainers.image.vendor="YOURLS Org"
 LABEL org.opencontainers.image.authors="YOURLS"
 LABEL org.opencontainers.image.licenses="MIT"
-LABEL io.artifacthub.package.readme-url="https://raw.githubusercontent.com/YOURLS/YOURLS/master/README.md"
+LABEL io.artifacthub.package.readme-url="https://raw.githubusercontent.com/YOURLS/images/main/images/yourls/README.md"
 
 # install the PHP extensions we need
 RUN set -eux; \
@@ -44,8 +44,8 @@ RUN set -eux; \
     rm yourls.tar.gz; \
     chown -R www-data:www-data /usr/src/yourls
 
-COPY --chown=www-data:www-data config-docker.php /usr/src/yourls/user/
-COPY docker-entrypoint.sh /usr/local/bin/
+COPY --chown=www-data:www-data config-container.php /usr/src/yourls/user/
+COPY container-entrypoint.sh /usr/local/bin/
 %%VARIANT_FILES%%
-ENTRYPOINT ["docker-entrypoint.sh"]
+ENTRYPOINT ["container-entrypoint.sh"]
 CMD ["%%CMD%%"]

images/yourls/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017-present YOURLS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.