Draft release 1.1 (#5)

* Fix typo in README

* Use date command to automatically generate date yyyymmdd

* Add badges and update ci

* Add FUNDING.yml

* Replace echo by sed for /boot/cmdline.txt

* Update base Docker image

* Replace inplace urls by definitions

* Add Usage title in README

Author: tschaffter

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: []
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: ['https://paypal.me/tschaffter/0usd']

.github/workflows/ci.yml

@@ -1,17 +1,56 @@
-name: CI
+name: ci
 
 on:
   push:
-    branches: [ master, develop ]
+    branches:
+      - master
+    tags:
+      - '*'
   pull_request:
-    branches: [ master, develop ]
 
 jobs:
-  test:
+  lint:
     runs-on: ubuntu-18.04
-
+    container: hadolint/hadolint:latest
     steps:
     - uses: actions/checkout@v2
+    - name: Run hadolint
+      run: hadolint Dockerfile
 
+  test:
+    needs: [lint]
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/checkout@v2
     - name: Run builder script with arguments `--help`
       run: ./build-kernel.sh --help
+
+  release:
+    needs: [test]
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set variables
+      id: vars
+      run: |
+        echo ::set-output \
+          name=repository::tschaffter/${{ github.event.repository.name }}
+        echo ::set-output name=user::tschaffter
+        if [[ ${GITHUB_REF} = refs/tags/* ]]
+        then
+          echo ::set-output name=version::${GITHUB_REF#refs/tags/}
+          echo ::set-output name=push::true
+        else
+          echo ::set-output name=version::test
+          echo ::set-output name=push::false
+        fi
+
+    - name: Build Dockerfile.base
+      uses: docker/build-push-action@v1
+      with:
+        username: ${{ secrets.DOCKER_USERNAME }}
+        password: ${{ secrets.DOCKER_PASSWORD }}
+        repository: ${{ steps.vars.outputs.repository }}
+        tags: latest, ${{ steps.vars.outputs.version }}
+        push: ${{ steps.vars.outputs.push }}

.github/workflows/publish-docker-image.yml

@@ -1,29 +1,32 @@
-FROM debian:buster-20200607-slim
+FROM debian:buster-20200803-slim
 
 LABEL maintainer="[email protected]"
 
+# Internal user who will build the kernel
 ARG user=builder
 
 # Install Git and the build dependencies
 # hadolint ignore=DL3008
 RUN apt-get update -qq -y && apt-get install --no-install-recommends -qq -y \
-    apt-transport-https \
-    bc \
-    bison \
-    build-essential \
-    ca-certificates \
-    cpio \
-    dpkg-dev \
-    fakeroot \
-    flex \
-    git \
-    kmod \
-    libssl-dev \
-    libc6-dev \
-    libncurses5-dev \
-    make \
-    rsync \
+        apt-transport-https \
+        bc \
+        bison \
+        build-essential \
+        ca-certificates \
+        cpio \
+        dpkg-dev \
+        fakeroot \
+        flex \
+        git \
+        kmod \
+        libssl-dev \
+        libc6-dev \
+        libncurses5-dev \
+        make \
+        rsync \
     && update-ca-certificates \
+    && apt-get -y autoclean \
+    && apt-get -y autoremove \
     && rm -rf /var/lib/apt/lists/*
 
 # Create user and set work directory

Dockerfile

@@ -1,20 +1,22 @@
 # Hardened Kernel Builder for Raspberry Pi
 
-[![Docker Image](https://github.com/tschaffter/raspberry-pi-kernel-hardened/workflows/Publish%20Docker%20Image/badge.svg)](https://hub.docker.com/repository/docker/tschaffter/raspberry-pi-kernel-hardened)
+[![GitHub Stars](https://img.shields.io/github/stars/tschaffter/raspberry-pi-kernel-hardened.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/tschaffter/raspberry-pi-kernel-hardened)
+[![GitHub Release](https://img.shields.io/github/release/tschaffter/raspberry-pi-kernel-hardened.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/tschaffter/raspberry-pi-kernel-hardened/releases)
+[![Docker Stars](https://img.shields.io/docker/stars/tschaffter/raspberry-pi-kernel-hardened.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/tschaffter/raspberry-pi-kernel-hardened)
+[![GitHub CI](https://img.shields.io/github/workflow/status/tschaffter/raspberry-pi-kernel-hardened/ci.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/tschaffter/raspberry-pi-kernel-hardened)
+[![GitHub License](https://img.shields.io/github/license/tschaffter/raspberry-pi-kernel-hardened.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/tschaffter/raspberry-pi-kernel-hardened)
 
-## Overview
-
-Cross-compile the [Linux kernel for Raspberry Pi](https://www.raspberrypi.org/documentation/linux/kernel/building.md)
-with enhanced security using a single command.
+Cross-compile the [Linux kernel for Raspberry Pi][raspberrypi_kernel_build] with
+enhanced security support using a single command.
 
 ## Features
 
-- Dockerized tool to cross-compile the kernel with a single command
+- Dockerized tool to cross-compile an hardened kernel for the Pi with a single command
 - Hardened kernel features
-  - Enable Audit
-  - Enable SELinux
+  - Add Audit support
+  - Add SELinux support
 
-## Builder options
+## Usage
 
 Run the folllowing command to see the options of the builder:
 
@@ -28,11 +30,11 @@ Usage: build-kernel.sh [--kernel-branch <arg>] [--kernel-defconfig <arg>] [--ker
     -h, --help: Prints help
 ```
 
-## Build the hardered kernel
+## Build the hardened kernel
 
 ### Identify the kernel version to build
 
-Go to the GitHub repository of the [Linux kernel of Raspberry Pi](https://github.com/raspberrypi/linux)
+Go to the GitHub repository of the [Linux kernel of Raspberry Pi][gh_raspberrypi/linux]
 and identify the name of the branch or tag that you want to build.
 
 Examples:
@@ -42,9 +44,8 @@ Examples:
 
 ### Identify the default configuration to use
 
-Go to the page [Kernel building](https://www.raspberrypi.org/documentation/linux/kernel/building.md)
-of the Raspberry Pi website to identify the default build configuration to use
-for the target Pi.
+Go to the page [Kernel building][raspberrypi_kernel_build] of the Raspberry Pi
+website to identify the default build configuration to use for the target Pi.
 
 Examples:
 
@@ -77,7 +78,7 @@ $ docker run \
     tschaffter/raspberry-pi-kernel-hardened \
         --kernel-branch rpi-5.4.y \
         --kernel-defconfig bcm2711_defconfig \
-        --kernel-localversion 5.4.y-20200804-hardened
+        --kernel-localversion 5.4.y-$(date '+%Y%m%d')-hardened
 Cloning into '/home/builder/tools'...
 Installing cross compiler toolchain
 Checking out files: 100% (19059/19059), done.
@@ -95,7 +96,7 @@ sudo reboot
 
 ENABLE SELinux
 sudo apt-get install selinux-basics selinux-policy-default auditd
-sudo sh -c "echo ' selinux=1 security=selinux' >> /boot/cmdline.txt"
+sudo sh -c "sed -i '$ s/$/ selinux=1 security=selinux/' /boot/cmdline.txt"
 sudo touch /.autorelabel
 sudo reboot
 sestatus
@@ -110,8 +111,7 @@ command.
 ## Customize your build
 
 - The builder uses all the CPU cores available to the Docker container. By default,
-that is all the CPU cores of the host. Use
-[Docker runtime options](https://docs.docker.com/config/containers/resource_constraints/#cpu)
+that is all the CPU cores of the host. Use [Docker runtime options][docker_runtime_options]
 to limit the usage of CPU cores by the builder.
 
 - The builder clones two GitHub repositories, the cross-compiler toolchain and
@@ -131,10 +131,16 @@ $ docker run \
     tschaffter/raspberry-pi-kernel-hardened \
         --kernel-branch rpi-5.4.y \
         --kernel-defconfig bcm2711_defconfig \
-        --kernel-localversion 5.4.y-20200804-hardened
+        --kernel-localversion 5.4.y-$(date '+%Y%m%d')-hardened
 ```
 
 ## Contributing change
 
 Please read the [`CONTRIBUTING.md`](CONTRIBUTING.md) for details on how to
 contribute to this project.
+
+<!-- Definitions -->
+
+[raspberrypi_kernel_build]: https://www.raspberrypi.org/documentation/linux/kernel/building.md
+[gh_raspberrypi/linux]: https://github.com/raspberrypi/linux
+[docker_runtime_options]: https://docs.docker.com/config/containers/resource_constraints/#cpu

README.md

@@ -234,7 +234,7 @@ echo "sudo reboot"
 echo ""
 echo "ENABLE SELinux"
 echo "sudo apt-get install selinux-basics selinux-policy-default auditd"
-echo "sudo sh -c \"echo ' selinux=1 security=selinux' >> /boot/cmdline.txt\""
+echo "sudo sh -c \"sed -i '$ s/$/ selinux=1 security=selinux/' /boot/cmdline.txt\""
 echo "sudo touch /.autorelabel"
 echo "sudo reboot"
 echo "sestatus"