Cleanup and working release action. (#17)

* Cleanup and working release action.

Using a community GitHub action to get the docker push to ghcr to work.
Fancying-up the README

* fixing syntax error

Author: thirtytwobits

.github/workflows/c_cpp.yml

@@ -1,27 +1,36 @@
 name: ghcr.io/opencyphal/c_cpp container build and publish.
 
 on:
-  push:
-    branches: [ "main" ]
+  release:
+    types: [ published ]
+    
   pull_request:
     branches: [ "main" ]
-defaults:
-  run:
-    working-directory: ./c_cpp
+
+env:
+  ORG_NAMESPACE: opencyphal
+  IMAGE_NAME: c_cpp
+  LATEST_TAG: ubuntu-20.04
 
 jobs:
 
-  build:
+  build_and_publish:
 
     runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v3
 
-    - name: pull
-      run: docker pull ghcr.io/opencyphal/c_cpp:ubuntu-20.04
-    - name: build
-      run: docker build . --tag ghcr.io/opencyphal/c_cpp:ubuntu-20.04
-    - name: push
-      if: ${{ github.event_name != 'pull_request' }}
-      run: docker push ghcr.io/opencyphal/c_cpp:ubuntu-20.04
+    - name: dryrun-build
+      if: ${{ github.event_name == 'pull_request' }}
+      run: docker build ./c_cpp
+    - name: build-and-push
+      if: ${{ github.event_name == 'release' && contains(github.ref, '20.04-c_cpp') }}
+      uses: macbre/push-to-ghcr@master
+      with:
+        context: ./${{ env.IMAGE_NAME }}
+        dockerfile: ./${{ env.IMAGE_NAME }}/Dockerfile
+        image_name: ${{ env.ORG_NAMESPACE }}/${{ env.IMAGE_NAME }}
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        image_tag: ${{ env.LATEST_TAG }}
+        repository: ghcr.io

README.md

@@ -1,8 +1,45 @@
 ![OpenCyphal](opencyphal_logo.svg) OpenCyphal Containerized Toolchains
 ===================
 
-This repository contains the Dockerfiles, instructions, and some utilities for building containers to be used as common
-toolchains for OpenCyphal projects. These containers are published to the
-[opencyphal organization on Github](https://github.com/orgs/OpenCyphal/packages) and are used by the build automation
-for OpenCyphal projects. You can use these same containers to get consistent build results in your local development
-environment.
+This repository contains the Dockerfiles, instructions, and some utilities for
+building containers to be used as common toolchains and development environments
+for OpenCyphal projects. These containers are published to the [opencyphal
+organization on Github](https://github.com/orgs/OpenCyphal/packages) and are used
+by the build automation for OpenCyphal projects. You can use these same
+containers to get consistent build results in your local development environment.
+
+### opencyphal/c_cpp
+
+[![ghcr.io/opencyphal/c_cpp container build and publish.](https://github.com/OpenCyphal/docker_toolchains/actions/workflows/c_cpp.yml/badge.svg)](https://github.com/OpenCyphal/docker_toolchains/actions/workflows/c_cpp.yml)
+
+The [Open Cyphal c_cpp
+container](https://github.com/OpenCyphal/docker_toolchains/pkgs/container/c_cpp)
+is based on various Ubuntu releases with the container tag being the latest build
+of our c_cpp container based on a given release. This container provides the
+necessary compilers and utilities to build and run OpenCyphal C or C++ projects
+like [libcanard](https://github.com/OpenCyphal/libcanard) and
+[Nunavut](https://github.com/OpenCyphal/nunavut).
+
+#### Supported Versions
+
+| tag      | Python | Gcc | Clang | Cmake | Other Utilities |
+|----------|--------|-----|-------|-------|-------|
+| [ubuntu-20.04](https://github.com/OpenCyphal/docker_toolchains/pkgs/container/c_cpp/69896735?tag=ubuntu-20.04) | 3.10 | 9.3.0 | 10.0.0 | 3.16.3 | <ul><li>qemu</li><li>can-utils</li><li>sonar-scanner</li></ul> |
+
+You can use this in your workflow yaml like this:
+
+```none
+jobs:
+  my-job:
+    runs-on: ubuntu-latest
+    container: ghcr.io/opencyphal/c_cpp:ubuntu-20.04
+```
+
+
+### opencyphal/texer
+
+ [LaTeX](https://www.latex-project.org/) toolchain. Will be migrated to github actions soon, stay tuned!
+
+ ### opencyphal/toxic
+
+ Python toolchain. Will be migrated to github actions soon. Stay tuned!

c_cpp/Dockerfile

@@ -3,6 +3,8 @@
 #
 FROM ubuntu:20.04
 
+LABEL org.opencontainers.image.description "Provides a consistent build and test environment for development, continuous-integration, and test automation of OpenCyphal C and C++ based projects."
+
 VOLUME /repo
 
 WORKDIR /repo

c_cpp/README.md

@@ -3,6 +3,12 @@
 The `opencyphal/c_cpp` docker image provides a consistent build and test environment
 for development, continuous-integration, and test automation of C and C++ based projects.
 
+## Official Release
+
+To release a new build of this container simply create a [new github release](https://github.com/OpenCyphal/docker_toolchains/releases/new)
+that starts with the ubuntu version container you want to release and ends with "-c_cpp". For example `v20.04-c_cpp`
+will cause the github workflow to rebuild and push the `opencyphal/c_cpp:ubuntu-20.04` container.
+
 ## Manual Build and Push
 
 These instructions are for maintainers with permissions to push to the
@@ -63,14 +69,3 @@ sonar-scanner \
 ```
 
 A [CMake example on github](https://github.com/SonarSource/sonarcloud_example_cpp-cmake-linux-otherci)
-
-## Github Actions
-
-You can use this in your workflow yaml like this:
-
-```none
-jobs:
-  my-job:
-    runs-on: ubuntu-latest
-    container: ghcr.io/opencyphal/c_cpp:ubuntu-20.04
-```