diff --git a/hub-description.md b/README.md similarity index 90% rename from hub-description.md rename to README.md index 7bfcaa60e184b97b242f329602e73faa6b132c4f..fd4e51e10e42639ac40310efecd85111563bd146 100644 --- a/hub-description.md +++ b/README.md @@ -1,19 +1,19 @@ -- [Supported Tags](#org72d9999) - - [Simple Tags](#org5de60cd) - - [Shared Tags](#orgd20b71f) -- [Quick Reference](#org25efc82) -- [What is ABCL?](#org4109770) -- [What's in the image?](#orgfe6bbac) -- [License](#orgca9bdd0) +- [Supported Tags](#org4bcb36c) + - [Simple Tags](#org8ec3ab1) + - [Shared Tags](#orgfbf69a8) +- [Quick Reference](#org9955b16) +- [What is ABCL?](#org0191a6b) +- [What's in the image?](#orgb209317) +- [License](#org2b305be) -<a id="org72d9999"></a> +<a id="org4bcb36c"></a> # Supported Tags -<a id="org5de60cd"></a> +<a id="org8ec3ab1"></a> ## Simple Tags @@ -28,7 +28,7 @@ - `1.8.0-jdk8-windowsservercore-ltsc2016`, `jdk8-windowsservercore-ltsc2016` -<a id="orgd20b71f"></a> +<a id="orgfbf69a8"></a> ## Shared Tags @@ -55,7 +55,7 @@ - `1.8.0-jdk8-windowsservercore-ltsc2016` -<a id="org25efc82"></a> +<a id="org9955b16"></a> # Quick Reference @@ -66,7 +66,7 @@ - **Supported platforms:** `linux/amd64`, `linux/arm64/v8`, `windows/amd64` -<a id="org4109770"></a> +<a id="org0191a6b"></a> # What is ABCL? @@ -75,14 +75,14 @@ From [ABCL's Home Page](https://abcl.org) > Armed Bear Common Lisp (ABCL) is a full implementation of the Common Lisp language featuring both an interpreter and a compiler, running in the JVM. Originally started to be a scripting language for the J editor, it now supports JSR-223 (Java scripting API): it can be a scripting engine in any Java application. Additionally, it can be used to implement (parts of) the application using Java to Lisp integration APIs. -<a id="orgfe6bbac"></a> +<a id="orgb209317"></a> # What's in the image? This image contains ABCL binaries released by the upstream devs. -<a id="orgca9bdd0"></a> +<a id="org2b305be"></a> # License diff --git a/README.org b/README.org index 85a8ca67d35ef0ccbed0bf2d60f2a16c6060c48b..3ff08c8c2b76761f9ee7fd79c91d46ac73af651d 100644 --- a/README.org +++ b/README.org @@ -1,61 +1,80 @@ -#+TITLE: CCL Docker Images - -This project contains Dockerfiles for a variety of stock CCL images as well as -CI infrastructure to automatically build and push them. - -See [[file:hub-description.org]] for a more detailed description of the images. - -* Image Repos - - The end goal is to get these images accepted into Docker's official image - program. This drives the current layout of the repo as the official images - program does not allow images to be customized via build args. - - Again, similar to the official images program, images are pushed to an arch - specific organization and then pushed to a common organization using Docker - manifests. - -* CI - - We use a mixture of Travis CI and GitHub Actions to build the images. Travis - is responsible for building all Linux based images and GitHub Actions builds - the Windows based images. The reason for this split is primarily because - Travis provides hosted Arm instances, whereas GitHub currently does not. - - Building the images can take a *long* time and can occasionally fail due to - transient conditions outside our control. Given that there are a large number - of images, we want to cache images between builds so we can reuse as much - work as possible. Additionally, we don't want to waste time rebuilding images - that have already been released if the goal is to test changes to the nightly - images. Therefore, the CI jobs follow the following rules: - - For jobs run on master, all images are built and pushed to the arch specific - repos with tags ending in =-tmp-master=. Nightly images are then retagged - without the suffix and pushed to the common org using manifests. When a - manual release job is triggered, all non-nightly images are retagged without - the suffix and pushed to the common org using manifests. - - For jobs run on a branch starting with =nightly-= only the nightly images are - built and are pushed (if possible) to the arch specific repos with the tag - suffix =-tmp=. These tags are used as potential cache sources when building - on any branch (including master). - - For jobs run on any other branch, all images are built and pushed (if - possible) to the arch specific repos with the tag suffix =-tmp=. These tags - are used as potential cache sources when building on any branch (including - master). - - This tagging scheme means that multiple non-master branches being developed - on in parallel will stomp on each other's caches. However, for now, that - seems like an acceptable tradeoff when compared to coming up with a more - robust tagging scheme. - -** Rebuilding for new base images - - CCL does not release on a regular cadence. As such, it is desirable to - occasionally rebuild and re-release images to account for the base image - being updated. Currently, this rebuild happens monthly and only for the - Linux images. Due to Travis CI not allowing cron jobs to have extra - configuration, the only way to distinguish between nightly builds and - rebuilds is by branch name. The stable branch should generally track master - and is the branch which rebuilds happen on. +#+TITLE: ABCL Docker Images +#+AUTHOR: Eric Timmons + +* Supported Tags +** Simple Tags + + + =1.8.0-jdk15-buster=, =1.8.0-jdk-buster=, =1.8.0-buster=, =buster=, =jdk15-buster=, =jdk-buster= + + =1.8.0-jdk11-buster=, =jdk11-buster= + + =1.8.0-jdk8-buster=, =jdk8-buster= + + =1.8.0-jdk15-windowsservercore-1809=, =1.8.0-jdk-windowsservercore-1809=, =1.8.0-windowsservercore-1809=, =jdk15-windowsservercore-1809=, =jdk-windowsservercore-1809= + + =1.8.0-jdk11-windowsservercore-1809=, =jdk11-windowsservercore-1809= + + =1.8.0-jdk8-windowsservercore-1809=, =jdk8-windowsservercore-1809= + + =1.8.0-jdk15-windowsservercore-ltsc2016=, =1.8.0-jdk-windowsservercore-ltsc2016=, =1.8.0-windowsservercore-ltsc2016=, =jdk15-windowsservercore-ltsc2016=, =jdk-windowsservercore-ltsc2016= + + =1.8.0-jdk11-windowsservercore-ltsc2016=, =jdk11-windowsservercore-ltsc2016= + + =1.8.0-jdk8-windowsservercore-ltsc2016=, =jdk8-windowsservercore-ltsc2016= + +** Shared Tags + + + =latest=, =latest-jdk=, =latest-jdk15=, =1.8.0=, =1.8.0=jdk=, =1.8.0-jdk15= + + =1.8.0-jdk15-buster= + + =1.8.0-jdk15-windowsservercore-1809= + + =1.8.0-jdk15-windowsservercore-ltsc2016= + + =latest-jdk11=, =1.8.0-jdk11= + + =1.8.0-jdk11-buster= + + =1.8.0-jdk11-windowsservercore-1809= + + =1.8.0-jdk11-windowsservercore-ltsc2016= + + =latest-jdk8=, =1.8.0-jdk8= + + =1.8.0-jdk8-buster= + + =1.8.0-jdk8-windowsservercore-1809= + + =1.8.0-jdk8-windowsservercore-ltsc2016= + + =1.8.0-jdk15-windowsservercore=, =1.8.0-jdk-windowsservercore=, =jdk15-windowsservercore=, =jdk-windowsservercore=, =windowsserrvercore= + + =1.8.0-jdk15-windowsservercore-1809= + + =1.8.0-jdk15-windowsservercore-ltsc2016= + + =1.8.0-jdk11-windowsservercore=, =jdk11-windowsservercore= + + =1.8.0-jdk11-windowsservercore-1809= + + =1.8.0-jdk11-windowsservercore-ltsc2016= + + =1.8.0-jdk8-windowsservercore=, =jdk8-windowsservercore= + + =1.8.0-jdk8-windowsservercore-1809= + + =1.8.0-jdk8-windowsservercore-ltsc2016= + + +* Quick Reference + + + ABCL Home Page :: [[https://abcl.org/]] + + Where to file Docker image related issues :: [[https://github.com/cl-docker-images/abcl/]] + + Where to file issues for ABCL itself :: [[https://github.com/armedbear/abcl/issues]] + + Maintained by :: [[https://github.com/daewok][Eric Timmons]] and the [[https://mers.csail.mit.edu/][MIT MERS Group]] (i.e., this is not an official ABCL image) + + Supported platforms :: =linux/amd64=, =linux/arm64/v8=, =windows/amd64= + +* What is ABCL? + + From [[https://abcl.org][ABCL's Home Page]] + + #+begin_quote + Armed Bear Common Lisp (ABCL) is a full implementation of the Common Lisp + language featuring both an interpreter and a compiler, running in the + JVM. Originally started to be a scripting language for the J editor, it now + supports JSR-223 (Java scripting API): it can be a scripting engine in any + Java application. Additionally, it can be used to implement (parts of) the + application using Java to Lisp integration APIs. + #+end_quote + +* What's in the image? + + This image contains ABCL binaries released by the upstream devs. + +* License + + ABCL is licensed under the [[https://www.gnu.org/copyleft/gpl.html][GNU GPL]] with [[https://www.gnu.org/software/classpath/license.html][Classpath exception]]. + + The Dockerfiles used to build the images are licensed under BSD-2-Clause. + + As with all Docker images, these likely also contain other software which may + be under other licenses (such as Bash, etc from the base distribution, along + with any direct or indirect dependencies of the primary software being + contained). + + As for any pre-built image usage, it is the image user's responsibility to + ensure that any use of this image complies with any relevant licenses for all + software contained within. diff --git a/hub-description.org b/hub-description.org deleted file mode 100644 index 3ff08c8c2b76761f9ee7fd79c91d46ac73af651d..0000000000000000000000000000000000000000 --- a/hub-description.org +++ /dev/null @@ -1,80 +0,0 @@ -#+TITLE: ABCL Docker Images -#+AUTHOR: Eric Timmons - -* Supported Tags -** Simple Tags - - + =1.8.0-jdk15-buster=, =1.8.0-jdk-buster=, =1.8.0-buster=, =buster=, =jdk15-buster=, =jdk-buster= - + =1.8.0-jdk11-buster=, =jdk11-buster= - + =1.8.0-jdk8-buster=, =jdk8-buster= - + =1.8.0-jdk15-windowsservercore-1809=, =1.8.0-jdk-windowsservercore-1809=, =1.8.0-windowsservercore-1809=, =jdk15-windowsservercore-1809=, =jdk-windowsservercore-1809= - + =1.8.0-jdk11-windowsservercore-1809=, =jdk11-windowsservercore-1809= - + =1.8.0-jdk8-windowsservercore-1809=, =jdk8-windowsservercore-1809= - + =1.8.0-jdk15-windowsservercore-ltsc2016=, =1.8.0-jdk-windowsservercore-ltsc2016=, =1.8.0-windowsservercore-ltsc2016=, =jdk15-windowsservercore-ltsc2016=, =jdk-windowsservercore-ltsc2016= - + =1.8.0-jdk11-windowsservercore-ltsc2016=, =jdk11-windowsservercore-ltsc2016= - + =1.8.0-jdk8-windowsservercore-ltsc2016=, =jdk8-windowsservercore-ltsc2016= - -** Shared Tags - - + =latest=, =latest-jdk=, =latest-jdk15=, =1.8.0=, =1.8.0=jdk=, =1.8.0-jdk15= - + =1.8.0-jdk15-buster= - + =1.8.0-jdk15-windowsservercore-1809= - + =1.8.0-jdk15-windowsservercore-ltsc2016= - + =latest-jdk11=, =1.8.0-jdk11= - + =1.8.0-jdk11-buster= - + =1.8.0-jdk11-windowsservercore-1809= - + =1.8.0-jdk11-windowsservercore-ltsc2016= - + =latest-jdk8=, =1.8.0-jdk8= - + =1.8.0-jdk8-buster= - + =1.8.0-jdk8-windowsservercore-1809= - + =1.8.0-jdk8-windowsservercore-ltsc2016= - + =1.8.0-jdk15-windowsservercore=, =1.8.0-jdk-windowsservercore=, =jdk15-windowsservercore=, =jdk-windowsservercore=, =windowsserrvercore= - + =1.8.0-jdk15-windowsservercore-1809= - + =1.8.0-jdk15-windowsservercore-ltsc2016= - + =1.8.0-jdk11-windowsservercore=, =jdk11-windowsservercore= - + =1.8.0-jdk11-windowsservercore-1809= - + =1.8.0-jdk11-windowsservercore-ltsc2016= - + =1.8.0-jdk8-windowsservercore=, =jdk8-windowsservercore= - + =1.8.0-jdk8-windowsservercore-1809= - + =1.8.0-jdk8-windowsservercore-ltsc2016= - - -* Quick Reference - - + ABCL Home Page :: [[https://abcl.org/]] - + Where to file Docker image related issues :: [[https://github.com/cl-docker-images/abcl/]] - + Where to file issues for ABCL itself :: [[https://github.com/armedbear/abcl/issues]] - + Maintained by :: [[https://github.com/daewok][Eric Timmons]] and the [[https://mers.csail.mit.edu/][MIT MERS Group]] (i.e., this is not an official ABCL image) - + Supported platforms :: =linux/amd64=, =linux/arm64/v8=, =windows/amd64= - -* What is ABCL? - - From [[https://abcl.org][ABCL's Home Page]] - - #+begin_quote - Armed Bear Common Lisp (ABCL) is a full implementation of the Common Lisp - language featuring both an interpreter and a compiler, running in the - JVM. Originally started to be a scripting language for the J editor, it now - supports JSR-223 (Java scripting API): it can be a scripting engine in any - Java application. Additionally, it can be used to implement (parts of) the - application using Java to Lisp integration APIs. - #+end_quote - -* What's in the image? - - This image contains ABCL binaries released by the upstream devs. - -* License - - ABCL is licensed under the [[https://www.gnu.org/copyleft/gpl.html][GNU GPL]] with [[https://www.gnu.org/software/classpath/license.html][Classpath exception]]. - - The Dockerfiles used to build the images are licensed under BSD-2-Clause. - - As with all Docker images, these likely also contain other software which may - be under other licenses (such as Bash, etc from the base distribution, along - with any direct or indirect dependencies of the primary software being - contained). - - As for any pre-built image usage, it is the image user's responsibility to - ensure that any use of this image complies with any relevant licenses for all - software contained within.