[Legacy] Sync legacy branch with stable

.github/workflows/firmware.yml

@@ -6,19 +6,27 @@ on:
     tags:
       - v*
   pull_request:
+    paths-ignore:
+      - '**.md'
+      - '**/CODEOWNERS'
+      - '.github/ISSUE_TEMPLATE'
+      - '.github/*.yml'
+      - 'contrib/sign.sh'
 
 jobs:
   generate_target_matrix:
     runs-on: ubuntu-latest
     outputs:
       target_json: ${{ steps.set_target.outputs.target }}
     steps:
-    - name: Set target matrix
-      id: set_target
-      shell: bash
-      run: |
-        target_list="[\"ar71xx-generic\", \"ar71xx-tiny\", \"ar71xx-nand\", \"ath79-generic\", \"brcm2708-bcm2708\", \"brcm2708-bcm2709\", \"ipq40xx-generic\", \"ipq806x-generic\", \"lantiq-xrx200\", \"lantiq-xway\", \"mpc85xx-generic\", \"mpc85xx-p1020\", \"ramips-mt7620\", \"ramips-mt7621\", \"ramips-mt76x8\", \"ramips-rt305x\", \"sunxi-cortexa7\", \"x86-generic\", \"x86-geode\", \"x86-legacy\", \"x86-64\", \"ar71xx-mikrotik\", \"brcm2708-bcm2710\", \"mvebu-cortexa9\"]"
-        echo ::set-output name=target::{\"target\": $(echo $target_list)}\"
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set target matrix
+        id: set_target
+        shell: bash
+        run: |
+          target_list=$(cat targets | jq -Rsc '.[:-1] | split("\n")')
+          echo "target={\"target\": $(echo $target_list)}" >> $GITHUB_OUTPUT
 
   build_firmware:
     needs: generate_target_matrix
@@ -27,19 +35,24 @@ jobs:
       matrix: ${{ fromJson(needs.generate_target_matrix.outputs.target_json) }}
     runs-on: ubuntu-latest
     steps:
+      - name: Maximize build space
+        run: |
+          sudo rm -rf /usr/share/dotnet
+          sudo rm -rf /usr/local/lib/android
+          sudo rm -rf /opt/ghc
       - name: Checkout
         uses: actions/checkout@master
         with:
           fetch-depth: 0
       - name: Install build dependencies
         run: |
-          sudo -E ./install_build_dependencies.sh
+          sudo -E ./scripts/install_build_dependencies.sh
       - name: build target ${{ matrix.target }}
         id: compile
         run: |
           git checkout -b patched ${GITHUB_SHA}
           make BROKEN=1 GLUON_TARGETS=${{ matrix.target }} V=s
-          echo "::set-output name=status::success"
+          echo "status=success" >> $GITHUB_OUTPUT
       - name: Upload firmware ${{ matrix.target }}
         uses: actions/upload-artifact@master
         if: steps.compile.outputs.status == 'success'
@@ -51,42 +64,26 @@ jobs:
     runs-on: ubuntu-latest
     needs: build_firmware
     if: github.event_name != 'pull_request'
-    outputs:
-          output1: ${{ steps.create_release.outputs.upload_url }}
     steps:
-      - name: Create Release
-        id: create_release
-        uses: actions/create-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Download all artifacts
+        uses: actions/download-artifact@v3
+      - name: Display structure of artifacts
+        run: ls -R
+      - name: Create tar.gz files
+        run: |
+          set -x
+          for output in *_output; do
+            tar zcvf "${output}.tar.gz" "${output}"
+          done
+      - name: Create Release & Upload Release Assets
+        uses: softprops/action-gh-release@v1
         with:
-          tag_name: ${{ github.ref }}
-          release_name: Release ${{ github.ref }}
+          # Note: If there is no release name specified, releases created in
+          # the GitHub UI do not trigger a failure and are modified instead.
           draft: false
           prerelease: false
-
-  upload_release:
-    strategy:
-      fail-fast: false
-      matrix: ${{ fromJson(needs.generate_target_matrix.outputs.target_json) }}
-    runs-on: ubuntu-latest
-    needs: [ create_release, generate_target_matrix ]
-    if: github.event_name != 'pull_request'
-    steps:
-      - name: Download Artifact ${{ matrix.target }}
-        uses: actions/download-artifact@v2
-        with:
-          name: ${{ matrix.target }}_output
-          path: ${{ matrix.target }}_output
-      - name: Create ${{ matrix.target }}_output.tar.gz
-        run: tar zcvf ${{ matrix.target }}_output.tar.gz ${{ matrix.target }}_output
-      - name: Upload Release Asset ${{ matrix.target }}
-        id: upload-release-asset
-        uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ needs.create_release.outputs.output1 }}
-          asset_path: ./${{ matrix.target }}_output.tar.gz
-          asset_name: ${{ matrix.target }}_output.tar.gz
-          asset_content_type: application/gzip
+          # Note: Release notes are only auto-generated if the release was
+          # created by the Github Action and was not created in the Github UI.
+          generate_release_notes: true
+          files: |
+            ./*_output.tar.gz

.github/workflows/shellcheck.yml

@@ -0,0 +1,28 @@
+---
+name: Shell Linting
+
+on:  # yamllint disable-line rule:truthy
+  workflow_dispatch:
+  push:
+    branches:
+      - stable
+      - next
+    paths:
+      - '**.sh'
+  pull_request:
+    paths:
+      - '**.sh'
+
+jobs:
+  shellcheck:
+    name: runner / shellcheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: shellcheck
+        # Make sure the action is pinned to a commit, as all reviewdog repos
+        # have hundreds of contributors with write access (breaks easy/often)
+        uses: reviewdog/action-shellcheck@50e5e1e2284575f23a1e409d9c0804cdfc4f6e31  # v1.18.1
+        with:
+          filter_mode: "file"
+          fail_on_error: true

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Freifunk München Firmware Changelog
 
+## Newer versions
+ Detailed changelog for versions v2022.5.1 and above can be found here:
+ https://github.com/freifunkMUC/site-ffm/releases
+
 ## v2022.2.1
  - Fix bug in wireguard package which was causing high CPU load if no WAN was available
 

Dockerfile_build

@@ -0,0 +1,4 @@
+FROM ubuntu:20.04
+
+ADD ./scripts/install_build_dependencies.sh /
+RUN /install_build_dependencies.sh

Makefile

@@ -2,35 +2,10 @@ GLUON_BUILD_DIR := gluon-build
 GLUON_GIT_URL := https://github.com/freifunk-gluon/gluon.git
 GLUON_GIT_REF := v2021.1.2
 
-PATCH_DIR := ${GLUON_BUILD_DIR}/site/patches
+PATCH_DIR := ./patches
 SECRET_KEY_FILE ?= ${HOME}/.gluon-secret-key
 
-GLUON_TARGETS ?= \
-	ar71xx-generic \
-	ar71xx-mikrotik \
-	ar71xx-nand \
-	ar71xx-tiny \
-	ath79-generic \
-	brcm2708-bcm2708 \
-	brcm2708-bcm2709 \
-	brcm2708-bcm2710 \
-	ipq40xx-generic \
-	ipq806x-generic \
-	lantiq-xrx200 \
-	lantiq-xway \
-	mpc85xx-generic \
-	mpc85cc-p1020 \
-	mvebu-cortexa9 \
-	ramips-mt7620 \
-	ramips-mt7621 \
-	ramips-mt76x8 \
-	ramips-rt305x \
-	sunxi-cortexa7 \
-	x86-64 \
-	x86-generic \
-	x86-geode \
-	x86-legacy
-
+GLUON_TARGETS ?= $(shell cat targets | tr '\n' ' ')
 GLUON_AUTOUPDATER_BRANCH := stable
 
 ifneq (,$(shell git describe --exact-match --tags 2>/dev/null))
@@ -60,7 +35,7 @@ info:
 	@echo '# Building release ${GLUON_RELEASE} for branch ${GLUON_AUTOUPDATER_BRANCH}'
 	@echo
 
-build: gluon-prepare
+build: gluon-prepare output-clean
 	for target in ${GLUON_TARGETS}; do \
 		echo ""Building target $$target""; \
 		${GLUON_MAKE} download all GLUON_TARGET="$$target"; \
@@ -76,36 +51,27 @@ sign: manifest
 	${GLUON_BUILD_DIR}/contrib/sign.sh ${SECRET_KEY_FILE} output/images/sysupgrade/${GLUON_AUTOUPDATER_BRANCH}.manifest
 
 ${GLUON_BUILD_DIR}:
-	git clone ${GLUON_GIT_URL} ${GLUON_BUILD_DIR}
-
-gluon-prepare: output-clean ${GLUON_BUILD_DIR}
-	cd ${GLUON_BUILD_DIR} \
-		&& git remote set-url origin ${GLUON_GIT_URL} \
-		&& git fetch origin \
-		&& rm -rf packages \
-		&& git checkout -q --force ${GLUON_GIT_REF} \
-		&& git clean -fd;
-	ln -sfT .. ${GLUON_BUILD_DIR}/site
+	mkdir -p ${GLUON_BUILD_DIR}
+
+# Note: "|" means "order only", e.g. "do not care about folder timestamps"
+# https://www.gnu.org/savannah-checkouts/gnu/make/manual/html_node/Prerequisite-Types.html
+${GLUON_BUILD_DIR}/.git: | ${GLUON_BUILD_DIR}
+	git init ${GLUON_BUILD_DIR}
+	cd ${GLUON_BUILD_DIR} && git remote add origin ${GLUON_GIT_URL}
+
+gluon-update: | ${GLUON_BUILD_DIR}/.git
+	cd ${GLUON_BUILD_DIR} && git fetch --tags origin ${GLUON_GIT_REF}
+	cd ${GLUON_BUILD_DIR} && git reset --hard FETCH_HEAD
+	cd ${GLUON_BUILD_DIR} && git clean -ffdx packages/ # double -f -f required to remove sub-repositories
+	cd ${GLUON_BUILD_DIR} && git clean -fd
+
+gluon-prepare: gluon-update
 	make gluon-patch
+	ln -sfT .. ${GLUON_BUILD_DIR}/site
 	${GLUON_MAKE} update
 
 gluon-patch:
-	echo "Applying Patches ..."
-	(cd ${GLUON_BUILD_DIR})
-			if [ `git branch --list patched` ]; then \
-				(git branch -D patched) \
-			fi
-	(cd ${GLUON_BUILD_DIR}; git checkout -B patching)
-	if [ -d "gluon-build/site/patches" -a "gluon-build/site/patches/*.patch" ]; then \
-		(cd ${GLUON_BUILD_DIR}; git apply --ignore-space-change --ignore-whitespace --whitespace=nowarn --verbose site/patches/*.patch) || ( \
-			cd ${GLUON_BUILD_DIR}; \
-			git clean -fd; \
-			git checkout -B patched; \
-			git branch -D patching; \
-			exit 1 \
-		) \
-	fi
-	(cd ${GLUON_BUILD_DIR}; git branch -M patched)
+	scripts/apply_patches.sh ${GLUON_BUILD_DIR} ${PATCH_DIR}
 
 gluon-clean:
 	rm -rf ${GLUON_BUILD_DIR}

README.md

@@ -1,5 +1,15 @@
 ![Build ffmuc firmware](https://github.com/freifunkMUC/site-ffm/workflows/Build%20ffmuc%20firmware/badge.svg)
 
+## Dependencies
+
+* git
+* GNU make
+* GNU patch
+* [Upstream Gluon dependencies](https://gluon.readthedocs.io/en/latest/user/getting_started.html#dependencies)
+
+For convenience, you can find a script to install those dependencies on an Ubuntu-based distribution:\
+ [install_build_dependencies.sh](scripts/install_build_dependencies.sh)
+
 ## Building
 
 Check out this repository and execute `make`, i.e. like this:
@@ -11,6 +21,27 @@ git checkout -b patched && git checkout stable
 make
 ```
 
+### Containerised building
+
+As the CI is using Ubuntu, only the Ubuntu dependencies are being tracked. To simplify building on other distros, containerised building is also possible:
+```sh
+docker build -t site-ffm-stable -f Dockerfile_build .
+```
+This will build the build Docker image. With the following export, the Makefile will then use the repo for building but will run inside an Ubuntu container.\
+**Note**: If the working directory is a git worktree, add a volume mount for the main git folder.
+```sh
+mkdir -p gluon-build output
+docker run --rm -v $(pwd):/site-ffm:ro -v $(pwd)/gluon-build:/site-ffm/gluon-build:rw -v $(pwd)/output:/site-ffm/output:rw -w /site-ffm -u $UID site-ffm-stable make
+```
+
+#### Example
+Full command for a [lantiq-xrx200](https://github.com/freifunk-gluon/gluon/blob/v2022.1/targets/lantiq-xrx200) build:
+
+```sh
+mkdir -p logs gluon-build output
+docker run --rm -v $(pwd):/site-ffm:ro -v $(pwd)/gluon-build:/site-ffm/gluon-build:rw -v $(pwd)/output:/site-ffm/output:rw -w /site-ffm -u $UID site-ffm-stable make V=s GLUON_TARGETS=lantiq-xrx200 |& tee logs/build_lantiq-xrx200_$(date --iso=s).log
+```
+
 ## Further Resources
 
 This firmware is based on [Gluon](https://gluon.readthedocs.io/en/v2021.1/).