feat(ci): add shellcheck for bash code (#10)

Author: mpsq

.env

@@ -0,0 +1,9 @@
+AUR_DNS=aur.archlinux.org
+AUR_IP=95.216.144.15
+AUR_PKG=emacs-gcc-wayland-devel-bin
+HOME=/home/pcr
+PKG_REL=1
+UPSTREAM_API=https://api.github.com/repos/flatwhatson/emacs
+UPSTREAM_BRANCH=pgtk-nativecomp
+UPSTREAM_REPO=https://github.com/flatwhatson/emacs
+UPSTREAM_SRC=https://raw.githubusercontent.com/flatwhatson/emacs/pgtk-nativecomp

.github/workflows/branches.yml

@@ -0,0 +1,15 @@
+name: check-branches
+
+on:
+  - pull_request
+
+jobs:
+  shellcheck:
+    name: Shellcheck
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: Run ShellCheck
+        uses: ludeeus/action-shellcheck@master
+        with:
+          scandir: "./ci"

.github/workflows/build.yml

@@ -10,22 +10,23 @@ on:
         required: true
 
 env:
-  UPSTREAM_API: https://api.github.com/repos/flatwhatson/emacs
-  UPSTREAM_BRANCH: pgtk-nativecomp
-  UPSTREAM_REPO: https://github.com/flatwhatson/emacs
-  UPSTREAM_SRC: https://raw.githubusercontent.com/flatwhatson/emacs/pgtk-nativecomp
+  OLD_COMMIT_N: ${{ github.event.inputs.old_commit_n }}
+  NEW_COMMIT_N: ${{ github.event.inputs.new_commit_n }}
 
 jobs:
   check:
     runs-on: ubuntu-20.04
-    env:
-      OLD_COMMIT_N: ${{ github.event.inputs.old_commit_n }}
-      NEW_COMMIT_N: ${{ github.event.inputs.new_commit_n }}
     steps:
       - name: Checkout the repo
         uses: actions/checkout@v2
       - name: Check last version
         run: bash ./ci/check-last-version.bash
+      - name: Import environment variables
+        shell: bash
+        run: |
+          while read line; do
+            echo "$line" >> $GITHUB_ENV
+          done < .env
       - name: Set env vars
         id: var
         run: . ./ci/set-env-vars.bash
@@ -39,12 +40,16 @@ jobs:
       image: mpsq/emacs-builder:latest
       options: --user root
     env:
-      OLD_COMMIT_N: ${{ github.event.inputs.old_commit_n }}
-      NEW_COMMIT_N: ${{ github.event.inputs.new_commit_n }}
       PKG_VERSION: ${{ needs.check.outputs.pkg_version }}
     steps:
       - name: Checkout the repo
         uses: actions/checkout@v2
+      - name: Import environment variables
+        shell: bash
+        run: |
+          while read line; do
+            echo "$line" >> $GITHUB_ENV
+          done < .env
       - name: Patch glibc
         run: bash ./ci/patch-glibc.bash
       - name: Build artifacts
@@ -57,7 +62,7 @@ jobs:
         with:
           tag_name: ${{ needs.check.outputs.pkg_version }}
           release_name: Release ${{ needs.check.outputs.pkg_version }}
-          body_path: /home/pcr/body.md
+          body_path: ${{ env.HOME }}/body.md
           draft: false
           prerelease: false
       - name: Upload release asset
@@ -67,7 +72,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           upload_url: ${{ steps.create_release.outputs.upload_url }}
-          asset_path: /home/pcr/${{ needs.check.outputs.pkg_version }}.tar.gz
+          asset_path: ${{ env.HOME }}/${{ needs.check.outputs.pkg_version }}.tar.gz
           asset_name: ${{ needs.check.outputs.pkg_version }}.tar.gz
           asset_content_type: application/gzip
       - name: Push to AUR

.github/workflows/manual.yml

@@ -10,22 +10,23 @@ on:
         required: true
 
 env:
-  UPSTREAM_API: https://api.github.com/repos/flatwhatson/emacs
-  UPSTREAM_BRANCH: pgtk-nativecomp
-  UPSTREAM_REPO: https://github.com/flatwhatson/emacs
-  UPSTREAM_SRC: https://raw.githubusercontent.com/flatwhatson/emacs/pgtk-nativecomp
+  OLD_COMMIT_N: ${{ github.event.inputs.old_commit_n }}
+  NEW_COMMIT_N: ${{ github.event.inputs.new_commit_n }}
 
 jobs:
   check:
     runs-on: ubuntu-20.04
-    env:
-      OLD_COMMIT_N: ${{ github.event.inputs.old_commit_n }}
-      NEW_COMMIT_N: ${{ github.event.inputs.new_commit_n }}
     steps:
       - name: Checkout the repo
         uses: actions/checkout@v2
       - name: Check last version
         run: bash ./ci/check-last-version.bash
+      - name: Import environment variables
+        shell: bash
+        run: |
+          while read line; do
+            echo "$line" >> $GITHUB_ENV
+          done < .env
       - name: Set env vars
         id: var
         run: . ./ci/set-env-vars.bash
@@ -39,12 +40,16 @@ jobs:
       image: mpsq/emacs-builder:latest
       options: --user root
     env:
-      OLD_COMMIT_N: ${{ github.event.inputs.old_commit_n }}
-      NEW_COMMIT_N: ${{ github.event.inputs.new_commit_n }}
       PKG_VERSION: ${{ needs.check.outputs.pkg_version }}
     steps:
       - name: Checkout the repo
         uses: actions/checkout@v2
+      - name: Import environment variables
+        shell: bash
+        run: |
+          while read line; do
+            echo "$line" >> $GITHUB_ENV
+          done < .env
       - name: Patch glibc
         run: bash ./ci/patch-glibc.bash
       - name: Build artifacts
@@ -53,5 +58,5 @@ jobs:
         uses: actions/upload-artifact@v2
         with:
           name: emacs-manual-build
-          path: /home/pcr/${{ needs.check.outputs.pkg_version }}.tar.gz
+          path: ${{ env.HOME }}/${{ needs.check.outputs.pkg_version }}.tar.gz
           retention-days: 5

.ignore

@@ -0,0 +1 @@
+!.github

Dockerfile

@@ -15,6 +15,18 @@
 FROM archlinux:base-devel
 
 COPY deps .
+COPY .env .
+
+ENV CC="/usr/bin/clang" \
+  CXX="/usr/bin/clang++" \
+  CPP="/usr/bin/clang -E" \
+  LD="/usr/bin/lld" \
+  AR="/usr/bin/llvm-ar" \
+  AS="/usr/bin/llvm-as" \
+  CFLAGS="-g -flto -fuse-ld=lld" \
+  CXXFLAGS="-g -flto -fuse-ld=lld"
+
+RUN /bin/bash -c "source .env"
 
 RUN pacman -Syu --noconfirm && \
   pacman -U --noconfirm libgccjit-10.2.0-2-x86_64.pkg.tar.zst && \
@@ -42,28 +54,19 @@ RUN pacman -Syu --noconfirm && \
   jq \
   openssh && \
   groupadd -r pcr && useradd --no-log-init -r -g pcr pcr && \
-  mkdir /home/pcr && \
-  chown -R pcr:pcr /home/pcr && \
+  mkdir "$HOME" && \
+  chown -R pcr:pcr "$HOME" && \
   echo "pcr ALL=(root) NOPASSWD:ALL" > /etc/sudoers.d/user && \
   chmod 0440 /etc/sudoers.d/user
 
-WORKDIR /home/pcr
+WORKDIR $HOME
 
 COPY PKGBUILD .
 COPY pull.bash .
 
-RUN chown -R pcr:pcr /home/pcr
+RUN chown -R pcr:pcr "$HOME"
 USER pcr
 
-ENV CC="/usr/bin/clang" \
-  CXX="/usr/bin/clang++" \
-  CPP="/usr/bin/clang -E" \
-  LD="/usr/bin/lld" \
-  AR="/usr/bin/llvm-ar" \
-  AS="/usr/bin/llvm-as" \
-  CFLAGS="-g -flto -fuse-ld=lld" \
-  CXXFLAGS="-g -flto -fuse-ld=lld"
-
 RUN ["./pull.bash"]
 RUN makepkg && \
   rm emacs-1-1-x86_64.pkg.tar.zst

PKGBUILD

@@ -10,7 +10,7 @@ source=()
 sha1sums=()
 
 build() {
-  cd /home/pcr/emacs
+  cd "$HOME"/emacs
 
   [[ -x configure ]] || ( ./autogen.sh git && ./autogen.sh autoconf )
 
@@ -42,7 +42,8 @@ build() {
 }
 
 package() {
-  cd /home/pcr/emacs
+  cd "$HOME"/emacs
+
   make DESTDIR="$pkgdir" install
 
   mv "$pkgdir"/usr/bin/{ctags,ctags.emacs}

ci/build-artifacts.bash

@@ -2,11 +2,11 @@
 
 set -euxo pipefail
 
-cd /home/pcr
+cd "$HOME"
 
 # Get sources
-cp /__w/emacs-gcc-wayland-devel-builder/emacs-gcc-wayland-devel-builder/pull.bash pull.bash
-cp /__w/emacs-gcc-wayland-devel-builder/emacs-gcc-wayland-devel-builder/PKGBUILD PKGBUILD
+cp "$GITHUB_WORKSPACE"/pull.bash pull.bash
+cp "$GITHUB_WORKSPACE"/PKGBUILD PKGBUILD
 ./pull.bash
 chown -R pcr:pcr emacs
 
@@ -23,7 +23,7 @@ tar czf "$PKG_VERSION".tar.gz -C out .
 # Get release body
 delta=$(echo "$NEW_COMMIT_N - $OLD_COMMIT_N" | bc)
 echo -en "# Commits since last release\n\n" > body.md
-echo -en "Check [upstream]("$UPSTREAM_REPO"/commits) for the full history.\n\n" >> body.md
+echo -en "Check [upstream]($UPSTREAM_REPO/commits) for the full history.\n\n" >> body.md
 
 # Get the list of commits since last release
 curl -s "$UPSTREAM_API"/commits?per_page="$delta" | \

ci/check-last-version.bash

@@ -3,4 +3,4 @@
 set -euxo pipefail
 
 # Check if a new release is needed
-if ["$OLD_COMMIT_N" == "$NEW_COMMIT_N" ]; then exit 1; else exit 0; fi
+if [ "$OLD_COMMIT_N" == "$NEW_COMMIT_N" ]; then exit 1; else exit 0; fi

ci/push-to-aur.bash

@@ -1,10 +1,11 @@
 #!/usr/bin/env bash
 
 set -euxo pipefail
+# Needed for "mygit" alias
 shopt -s expand_aliases
 
 # Checksum artifacts
-cd /home/pcr
+cd "$HOME"
 sum=$(sha512sum "$PKG_VERSION".tar.gz | sed -r 's/(.*)\s\s.*/\1/')
 
 # Setup SSH
@@ -13,22 +14,23 @@ mkdir .ssh
 echo "$PUB_KEY" | tr -d '\r' > .ssh/id_aur.pub
 echo "$PRIV_KEY" | base64 --decode > .ssh/id_aur
 chmod 600 .ssh/id_aur
-echo -en 'Host aur.archlinux.org\n  IdentityFile /root/.ssh/id_aur\n  User aur\n' > .ssh/config
-ssh-keyscan aur.archlinux.org > .ssh/known_hosts
-ssh-keyscan 95.216.144.15 >> .ssh/known_hosts
+echo -en 'Host '"$AUR_DNS"'\n  IdentityFile /root/.ssh/id_aur\n  User aur\n' > .ssh/config
+ssh-keyscan "$AUR_DNS" > .ssh/known_hosts
+ssh-keyscan "$AUR_IP" >> .ssh/known_hosts
 
 # Setup git
 alias mygit="git -c user.name=Méril\ Pilon -c user.email=me@mpsq.org"
-mygit clone ssh://aur.archlinux.org/emacs-gcc-wayland-devel-bin.git
-mv emacs-gcc-wayland-devel-bin /home/pcr
-chown -R pcr:pcr /home/pcr/emacs-gcc-wayland-devel-bin
-cd /home/pcr/emacs-gcc-wayland-devel-bin
+mygit clone ssh://"$AUR_DNS"/"$AUR_PKG".git
+mv "$AUR_PKG" "$HOME"
+chown -R pcr:pcr "$HOME"/"$AUR_PKG"
+cd "$HOME"/"$AUR_PKG"
 
 # Amend package, set pkgver, sha512 sum and pkgrel + fix permissions
-sed -i -r -e 's~pkgver=.*~pkgver='$PKG_VERSION'~' PKGBUILD
+sed -i -r -e 's~pkgver=.*~pkgver='"$PKG_VERSION"'~' PKGBUILD
 sed -i -r -e 's~sha512sums=.*~sha512sums=\("'"$sum"'"\)~' PKGBUILD
-sed -i -r -e 's/pkgrel=.*/pkgrel=1/' PKGBUILD
+sed -i -r -e 's~pkgrel=.*~pkgrel='"$PKG_REL"'~' PKGBUILD
 
+# Cleanup + fix permissions
 rm .SRCINFO
 su pcr -c "makepkg --printsrcinfo" > .SRCINFO
 chown -R pcr:pcr .SRCINFO