Merge branch 'release/3.0.1'

Dockershelf · Nov 21, 2022 · d9214bf · d9214bf
2 parents 1f153be + 4805b70
commit d9214bf
Show file tree

Hide file tree

Showing 18 changed files with 137 additions and 46 deletions.
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.0.0
+current_version = 3.0.1
 tag_name = {new_version}
 commit = True
 tag = True

diff --git a/.github/workflows/push-develop.yml b/.github/workflows/push-develop.yml
@@ -28,23 +28,41 @@ jobs:
           - docker-image-name: "dockershelf/latex:basic"
           - docker-image-name: "dockershelf/latex:full"
           - docker-image-name: "dockershelf/python:3.5-bullseye"
+            docker-image-extra-tags: "dockershelf/python:3.5-stable"
           - docker-image-name: "dockershelf/python:3.5-sid"
+            docker-image-extra-tags: "dockershelf/python:3.5-unstable dockershelf/python:3.5"
           - docker-image-name: "dockershelf/python:3.7-bullseye"
+            docker-image-extra-tags: "dockershelf/python:3.7-stable"
           - docker-image-name: "dockershelf/python:3.7-sid"
+            docker-image-extra-tags: "dockershelf/python:3.7-unstable dockershelf/python:3.7"
           - docker-image-name: "dockershelf/python:3.9-bullseye"
+            docker-image-extra-tags: "dockershelf/python:3.9-stable"
           - docker-image-name: "dockershelf/python:3.9-sid"
+            docker-image-extra-tags: "dockershelf/python:3.9-unstable dockershelf/python:3.9"
           - docker-image-name: "dockershelf/python:3.10-bullseye"
+            docker-image-extra-tags: "dockershelf/python:3.10-stable"
           - docker-image-name: "dockershelf/python:3.10-sid"
+            docker-image-extra-tags: "dockershelf/python:3.10-unstable dockershelf/python:3.10"
           - docker-image-name: "dockershelf/python:3.11-bullseye"
+            docker-image-extra-tags: "dockershelf/python:3.11-stable"
           - docker-image-name: "dockershelf/python:3.11-sid"
+            docker-image-extra-tags: "dockershelf/python:3.11-unstable dockershelf/python:3.11"
           - docker-image-name: "dockershelf/node:12-bullseye"
+            docker-image-extra-tags: "dockershelf/node:12-stable"
           - docker-image-name: "dockershelf/node:12-sid"
+            docker-image-extra-tags: "dockershelf/node:12-unstable dockershelf/node:12"
           - docker-image-name: "dockershelf/node:14-bullseye"
+            docker-image-extra-tags: "dockershelf/node:14-stable"
           - docker-image-name: "dockershelf/node:14-sid"
+            docker-image-extra-tags: "dockershelf/node:14-unstable dockershelf/node:14"
           - docker-image-name: "dockershelf/node:16-bullseye"
+            docker-image-extra-tags: "dockershelf/node:16-stable"
           - docker-image-name: "dockershelf/node:16-sid"
+            docker-image-extra-tags: "dockershelf/node:16-unstable dockershelf/node:16"
           - docker-image-name: "dockershelf/node:18-bullseye"
+            docker-image-extra-tags: "dockershelf/node:18-stable"
           - docker-image-name: "dockershelf/node:18-sid"
+            docker-image-extra-tags: "dockershelf/node:18-unstable dockershelf/node:18"
 
     steps:
       - name: Checkout repo

diff --git a/.github/workflows/push-master.yml b/.github/workflows/push-master.yml
@@ -28,23 +28,41 @@ jobs:
           - docker-image-name: "dockershelf/latex:basic"
           - docker-image-name: "dockershelf/latex:full"
           - docker-image-name: "dockershelf/python:3.5-bullseye"
+            docker-image-extra-tags: "dockershelf/python:3.5-stable"
           - docker-image-name: "dockershelf/python:3.5-sid"
+            docker-image-extra-tags: "dockershelf/python:3.5-unstable dockershelf/python:3.5"
           - docker-image-name: "dockershelf/python:3.7-bullseye"
+            docker-image-extra-tags: "dockershelf/python:3.7-stable"
           - docker-image-name: "dockershelf/python:3.7-sid"
+            docker-image-extra-tags: "dockershelf/python:3.7-unstable dockershelf/python:3.7"
           - docker-image-name: "dockershelf/python:3.9-bullseye"
+            docker-image-extra-tags: "dockershelf/python:3.9-stable"
           - docker-image-name: "dockershelf/python:3.9-sid"
+            docker-image-extra-tags: "dockershelf/python:3.9-unstable dockershelf/python:3.9"
           - docker-image-name: "dockershelf/python:3.10-bullseye"
+            docker-image-extra-tags: "dockershelf/python:3.10-stable"
           - docker-image-name: "dockershelf/python:3.10-sid"
+            docker-image-extra-tags: "dockershelf/python:3.10-unstable dockershelf/python:3.10"
           - docker-image-name: "dockershelf/python:3.11-bullseye"
+            docker-image-extra-tags: "dockershelf/python:3.11-stable"
           - docker-image-name: "dockershelf/python:3.11-sid"
+            docker-image-extra-tags: "dockershelf/python:3.11-unstable dockershelf/python:3.11"
           - docker-image-name: "dockershelf/node:12-bullseye"
+            docker-image-extra-tags: "dockershelf/node:12-stable"
           - docker-image-name: "dockershelf/node:12-sid"
+            docker-image-extra-tags: "dockershelf/node:12-unstable dockershelf/node:12"
           - docker-image-name: "dockershelf/node:14-bullseye"
+            docker-image-extra-tags: "dockershelf/node:14-stable"
           - docker-image-name: "dockershelf/node:14-sid"
+            docker-image-extra-tags: "dockershelf/node:14-unstable dockershelf/node:14"
           - docker-image-name: "dockershelf/node:16-bullseye"
+            docker-image-extra-tags: "dockershelf/node:16-stable"
           - docker-image-name: "dockershelf/node:16-sid"
+            docker-image-extra-tags: "dockershelf/node:16-unstable dockershelf/node:16"
           - docker-image-name: "dockershelf/node:18-bullseye"
+            docker-image-extra-tags: "dockershelf/node:18-stable"
           - docker-image-name: "dockershelf/node:18-sid"
+            docker-image-extra-tags: "dockershelf/node:18-unstable dockershelf/node:18"
 
     steps:
       - name: Checkout repo

diff --git a/.github/workflows/schedule-master.yml b/.github/workflows/schedule-master.yml
@@ -27,23 +27,41 @@ jobs:
           - docker-image-name: "dockershelf/latex:basic"
           - docker-image-name: "dockershelf/latex:full"
           - docker-image-name: "dockershelf/python:3.5-bullseye"
+            docker-image-extra-tags: "dockershelf/python:3.5-stable"
           - docker-image-name: "dockershelf/python:3.5-sid"
+            docker-image-extra-tags: "dockershelf/python:3.5-unstable dockershelf/python:3.5"
           - docker-image-name: "dockershelf/python:3.7-bullseye"
+            docker-image-extra-tags: "dockershelf/python:3.7-stable"
           - docker-image-name: "dockershelf/python:3.7-sid"
+            docker-image-extra-tags: "dockershelf/python:3.7-unstable dockershelf/python:3.7"
           - docker-image-name: "dockershelf/python:3.9-bullseye"
+            docker-image-extra-tags: "dockershelf/python:3.9-stable"
           - docker-image-name: "dockershelf/python:3.9-sid"
+            docker-image-extra-tags: "dockershelf/python:3.9-unstable dockershelf/python:3.9"
           - docker-image-name: "dockershelf/python:3.10-bullseye"
+            docker-image-extra-tags: "dockershelf/python:3.10-stable"
           - docker-image-name: "dockershelf/python:3.10-sid"
+            docker-image-extra-tags: "dockershelf/python:3.10-unstable dockershelf/python:3.10"
           - docker-image-name: "dockershelf/python:3.11-bullseye"
+            docker-image-extra-tags: "dockershelf/python:3.11-stable"
           - docker-image-name: "dockershelf/python:3.11-sid"
+            docker-image-extra-tags: "dockershelf/python:3.11-unstable dockershelf/python:3.11"
           - docker-image-name: "dockershelf/node:12-bullseye"
+            docker-image-extra-tags: "dockershelf/node:12-stable"
           - docker-image-name: "dockershelf/node:12-sid"
+            docker-image-extra-tags: "dockershelf/node:12-unstable dockershelf/node:12"
           - docker-image-name: "dockershelf/node:14-bullseye"
+            docker-image-extra-tags: "dockershelf/node:14-stable"
           - docker-image-name: "dockershelf/node:14-sid"
+            docker-image-extra-tags: "dockershelf/node:14-unstable dockershelf/node:14"
           - docker-image-name: "dockershelf/node:16-bullseye"
+            docker-image-extra-tags: "dockershelf/node:16-stable"
           - docker-image-name: "dockershelf/node:16-sid"
+            docker-image-extra-tags: "dockershelf/node:16-unstable dockershelf/node:16"
           - docker-image-name: "dockershelf/node:18-bullseye"
+            docker-image-extra-tags: "dockershelf/node:18-stable"
           - docker-image-name: "dockershelf/node:18-sid"
+            docker-image-extra-tags: "dockershelf/node:18-unstable dockershelf/node:18"
 
     steps:
       - name: Checkout repo

diff --git a/HISTORY.md b/HISTORY.md
@@ -1,7 +1,14 @@
 # Changelog
 
 
-## 3.0.0 (2022-11-21)
+## 3.0.1 (2022-11-21)
+
+### Changed
+
+* Improving documentation. Adding stable/unstable tags. [Luis Alejandro Martínez Faneyth]
+
+
+## 3.0 (2022-11-21)
 
 ### Changed
 

diff --git a/README.md b/README.md
@@ -4,21 +4,25 @@
 
 [![](https://img.shields.io/github/release/Dockershelf/dockershelf.svg)](https://github.com/Dockershelf/dockershelf/releases) [![](https://img.shields.io/github/workflow/status/Dockershelf/dockershelf/Schedule%20(master%20branch))](https://github.com/Dockershelf/dockershelf/actions/workflows/schedule-master.yml) [![](https://img.shields.io/discord/809504357359157288)](https://discord.gg/4Wc7xphH5e) [![](https://cla-assistant.io/readme/badge/Dockershelf/dockershelf)](https://cla-assistant.io/Dockershelf/dockershelf)
 
-Current version: 3.0.0
+Current version: 3.0.1
 
 *Dockershelf* is a repository that serves as a collector for docker recipes that are universal, efficient and slim. We keep adding "shelves", which are holders for the different versions of a popular language or application.
 
 Images are updated, tested and published *weekly* via a [Github Actions workflow](https://github.com/Dockershelf/dockershelf/actions).
 
-## How to download
+## About stable/unstable images
+
+Excepting debian and latex images, all images have an stable/unstable version. Stable images are based on debian stable, which are ideal for production applications; Unstable images are based on debian sid, which are designed for development stages.
+
+## How to use
 
 Pull one of the available images and start hacking!
 
 ```bash
-docker pull [docker image name]
-docker run -it [docker image name] bash
+docker pull <image>
+docker run -it <image> bash
 ```
-<sup>[docker image name] is the desired image to download, for example <code>dockershelf/python:2.7</code>.</sup>
+<sup>&lt;image&gt; is the desired image to download, for example <code>dockershelf/python:2.7</code>.</sup>
 
 ## How to build locally
 
@@ -31,10 +35,10 @@ git clone https://github.com/Dockershelf/dockershelf
 Run the build script in the root folder of your local copy. Remember to have docker installed and make sure your user has proper privileges to execute `docker build`.
 
 ```bash
-bash build-image.sh [docker image name]
+bash build-image.sh <image>
 ```
 
-<sup>[docker image name] is the desired image to build, for example <code>dockershelf/debian:sid</code>.</sup>
+<sup>&lt;image&gt; is the desired image to build, for example <code>dockershelf/debian:sid</code>.</sup>
 
 ## Shelves
 

diff --git a/README.md.template b/README.md.template
@@ -4,21 +4,25 @@
 
 [![](https://img.shields.io/github/release/Dockershelf/dockershelf.svg)](https://github.com/Dockershelf/dockershelf/releases) [![](https://img.shields.io/github/workflow/status/Dockershelf/dockershelf/Schedule%20(master%20branch))](https://github.com/Dockershelf/dockershelf/actions/workflows/schedule-master.yml) [![](https://img.shields.io/discord/809504357359157288)](https://discord.gg/4Wc7xphH5e) [![](https://cla-assistant.io/readme/badge/Dockershelf/dockershelf)](https://cla-assistant.io/Dockershelf/dockershelf)
 
-Current version: 3.0.0
+Current version: 3.0.1
 
 *Dockershelf* is a repository that serves as a collector for docker recipes that are universal, efficient and slim. We keep adding "shelves", which are holders for the different versions of a popular language or application.
 
 Images are updated, tested and published *weekly* via a [Github Actions workflow](https://github.com/Dockershelf/dockershelf/actions).
 
-## How to download
+## About stable/unstable images
+
+Excepting debian and latex images, all images have an stable/unstable version. Stable images are based on debian stable, which are ideal for production applications; Unstable images are based on debian sid, which are designed for development stages.
+
+## How to use
 
 Pull one of the available images and start hacking!
 
 ```bash
-docker pull [docker image name]
-docker run -it [docker image name] bash
+docker pull <image>
+docker run -it <image> bash
 ```
-<sup>[docker image name] is the desired image to download, for example <code>dockershelf/python:2.7</code>.</sup>
+<sup>&lt;image&gt; is the desired image to download, for example <code>dockershelf/python:2.7</code>.</sup>
 
 ## How to build locally
 
@@ -31,10 +35,10 @@ git clone https://github.com/Dockershelf/dockershelf
 Run the build script in the root folder of your local copy. Remember to have docker installed and make sure your user has proper privileges to execute `docker build`.
 
 ```bash
-bash build-image.sh [docker image name]
+bash build-image.sh <image>
 ```
 
-<sup>[docker image name] is the desired image to build, for example <code>dockershelf/debian:sid</code>.</sup>
+<sup>&lt;image&gt; is the desired image to build, for example <code>dockershelf/debian:sid</code>.</sup>
 
 ## Shelves
 

diff --git a/debian/README.md b/debian/README.md
@@ -23,7 +23,7 @@ The base filesystem is created with [`debian/build-image.sh`](https://github.com
 However, we explain the overall process here:
 
 1. Built `FROM scratch`.
-2. Labelled according to [label-schema.org](http://label-schema.org).
+2. Labelled according to [label-schema.org](http://label-schema.org) and [opencontainers specification](https://github.com/opencontainers/image-spec/blob/main/annotations.md#pre-defined-annotation-keys).
 3. The base filesystem is built with `debootstrap` using the following command.
 
         debootstrap --verbose --variant minbase --arch amd64 --no-check-gpg --no-check-certificate <release> <dir> <mirror>
@@ -112,12 +112,12 @@ However, we explain the overall process here:
 
     * `/etc/bash.bashrc`: Configure bash-completion and colorful prompt.
 
-5. Install `iproute`, `inetutils-ping`, `locales`, `curl`, `ca-certificates` and `bash-completion` packages.
+5. Install `iproute2`, `inetutils-ping`, `locales`, `curl`, `ca-certificates` and `bash-completion` packages.
 6. Configure locales.
 7. Delete unnecessary files to shrink image.
 
-## Made with :heart: and :hamburger:
+## Made with 💖 and 🍔
 
-![Banner](https://github.com/Dockershelf/dockershelf/blob/develop/images/author-banner.svg)
+![Banner](https://raw.githubusercontent.com/Dockershelf/dockershelf/develop/images/author-banner.svg)
 
 > Web [luisalejandro.org](http://luisalejandro.org/) · GitHub [@LuisAlejandro](https://github.com/LuisAlejandro) · Twitter [@LuisAlejandro](https://twitter.com/LuisAlejandro)
diff --git a/debian/README.md.template b/debian/README.md.template
@@ -20,7 +20,7 @@ The base filesystem is created with [`debian/build-image.sh`](https://github.com
 However, we explain the overall process here:
 
 1. Built `FROM scratch`.
-2. Labelled according to [label-schema.org](http://label-schema.org).
+2. Labelled according to [label-schema.org](http://label-schema.org) and [opencontainers specification](https://github.com/opencontainers/image-spec/blob/main/annotations.md#pre-defined-annotation-keys).
 3. The base filesystem is built with `debootstrap` using the following command.
 
         debootstrap --verbose --variant minbase --arch amd64 --no-check-gpg --no-check-certificate <release> <dir> <mirror>
@@ -109,12 +109,12 @@ However, we explain the overall process here:
 
     * `/etc/bash.bashrc`: Configure bash-completion and colorful prompt.
 
-5. Install `iproute`, `inetutils-ping`, `locales`, `curl`, `ca-certificates` and `bash-completion` packages.
+5. Install `iproute2`, `inetutils-ping`, `locales`, `curl`, `ca-certificates` and `bash-completion` packages.
 6. Configure locales.
 7. Delete unnecessary files to shrink image.
 
-## Made with :heart: and :hamburger:
+## Made with 💖 and 🍔
 
-![Banner](https://github.com/Dockershelf/dockershelf/blob/develop/images/author-banner.svg)
+![Banner](https://raw.githubusercontent.com/Dockershelf/dockershelf/develop/images/author-banner.svg)
 
 > Web [luisalejandro.org](http://luisalejandro.org/) · GitHub [@LuisAlejandro](https://github.com/LuisAlejandro) · Twitter [@LuisAlejandro](https://twitter.com/LuisAlejandro)
diff --git a/debian/build-image.sh b/debian/build-image.sh
@@ -48,25 +48,19 @@ if [ "$( id -u )" != "0" ]; then
     exit 1
 fi
 
-if [ "${DEBIAN_SUITE}" == "oldstable" ] || [ "${DEBIAN_SUITE}" == "oldoldstable" ]; then
-    MERGED_USR="--no-merged-usr"
-else
-    MERGED_USR="--merged-usr"
-fi
-
 # Clean previous builds
 if [ -d "${TARGET}" ]; then
     rm -rf "${TARGET}"
 fi
 
 msginfo "Downloading packages for base filesystem ..."
 debootstrap --verbose --variant "${VARIANT}" --arch "${ARCH}" \
-    --download-only --no-check-gpg --no-check-certificate ${MERGED_USR} \
+    --download-only --no-check-gpg --no-check-certificate --merged-usr \
         "${DEBIAN_RELEASE}" "${TARGET}"
 
 msginfo "Building base filesystem ..."
 debootstrap --verbose --variant "${VARIANT}" --arch "${ARCH}" \
-    --no-check-gpg --no-check-certificate ${MERGED_USR} \
+    --no-check-gpg --no-check-certificate --merged-usr \
         "${DEBIAN_RELEASE}" "${TARGET}"
 
 msginfo "Configuring base filesystem ..."

diff --git a/latex/README.md b/latex/README.md
@@ -15,7 +15,9 @@
 
 ## Building process
 
-The Latex images are very simple, they're just debian images with `texlive-fonts-recommended`, `texlive-latex-base`, `texlive-latex-extra` and `latex-xcolor` debian packages installed. Check out the [Dockerfile](https://github.com/Dockershelf/dockershelf/blob/master/latex/sid/Dockerfile) for details.
+The Latex basic image is a debian unstable image with `texlive-fonts-recommended`, `texlive-latex-base`, `texlive-latex-extra` and `texlive-latex-recommended` packages installed. Check out the [Dockerfile](https://github.com/Dockershelf/dockershelf/blob/master/latex/basic/Dockerfile) for details.
+
+The Latex full image is a debian unstable image with `texlive-full` package installed. Check out the [Dockerfile](https://github.com/Dockershelf/dockershelf/blob/master/latex/full/Dockerfile) for details.
 
 ## Made with 💖 and 🍔
 

diff --git a/latex/README.md.template b/latex/README.md.template
@@ -14,7 +14,9 @@
 
 ## Building process
 
-The Latex images are very simple, they're just debian images with `texlive-fonts-recommended`, `texlive-latex-base`, `texlive-latex-extra` and `latex-xcolor` debian packages installed. Check out the [Dockerfile](https://github.com/Dockershelf/dockershelf/blob/master/latex/sid/Dockerfile) for details.
+The Latex basic image is a debian unstable image with `texlive-fonts-recommended`, `texlive-latex-base`, `texlive-latex-extra` and `texlive-latex-recommended` packages installed. Check out the [Dockerfile](https://github.com/Dockershelf/dockershelf/blob/master/latex/basic/Dockerfile) for details.
+
+The Latex full image is a debian unstable image with `texlive-full` package installed. Check out the [Dockerfile](https://github.com/Dockershelf/dockershelf/blob/master/latex/full/Dockerfile) for details.
 
 ## Made with 💖 and 🍔
 

diff --git a/node/README.md b/node/README.md
@@ -28,7 +28,7 @@ Each node release is installed using the [nodesource scripts](https://nodejs.org
 We'll explain the overall process here:
 
 1. Built `FROM dockershelf/debian:<release>`.
-2. Labelled according to [label-schema.org](http://label-schema.org).
+2. Labelled according to [label-schema.org](http://label-schema.org) and [opencontainers specification](https://github.com/opencontainers/image-spec/blob/main/annotations.md#pre-defined-annotation-keys).
 3. Install developer tools and build depends to handle the nodesource script install.
 4. Install Node.
 5. Shrink image by deleting unnecessary files.

diff --git a/node/README.md.template b/node/README.md.template
@@ -21,7 +21,7 @@ Each node release is installed using the [nodesource scripts](https://nodejs.org
 We'll explain the overall process here:
 
 1. Built `FROM dockershelf/debian:<release>`.
-2. Labelled according to [label-schema.org](http://label-schema.org).
+2. Labelled according to [label-schema.org](http://label-schema.org) and [opencontainers specification](https://github.com/opencontainers/image-spec/blob/main/annotations.md#pre-defined-annotation-keys).
 3. Install developer tools and build depends to handle the nodesource script install.
 4. Install Node.
 5. Shrink image by deleting unnecessary files.