Merge pull request #39 from keyboardio/tmp/releng

Releng work

.github/workflows/build.yml

@@ -3,8 +3,10 @@ name: Build & Publish
 on:
   push:
     branches:
-      - master
-
+      - '**'  # Runs on pushes to any branch
+  pull_request:
+    branches:
+      - '**'  # Runs on PRs targeting any branch
 env:
   LC_ALL: C
   EXTRA_VERSION: ${{ github.run_number }}
@@ -38,7 +40,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Cache arduino dep downloads
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: ${{ github.workspace}}/.arduino/downloads
           key: ${{ runner.os }}-arduino-downloads
@@ -54,6 +56,8 @@ jobs:
   publish:
     needs: [ metadata, build ]
     runs-on: ubuntu-latest
+    # Ensure this job only runs on pushes to master branch
+    if: github.ref == 'refs/heads/master'
 
     steps:
       - uses: actions/checkout@v3

Makefile

@@ -16,12 +16,9 @@ else
 endif
 
 BOARDS =                \
-	EZ/ErgoDox            \
 	Keyboardio/Atreus     \
 	Keyboardio/Model01    \
-  Keyboardio/Model100   \
-	SOFTHRUF/Splitography \
-	Technomancy/Atreus
+  	Keyboardio/Model100
 
 all: message output	$(foreach board,${BOARDS},${board}@build)
 	:
@@ -68,11 +65,25 @@ update:
 	git submodule update --init --recursive
 	(cd ${KALEIDOSCOPE_DIR} && make update)
 
+
+pull-kaleidoscope: setup
+	(cd ${KALEIDOSCOPE_DIR}  && git fetch origin && git pull origin master)
+	git commit -s -m "Updated Kaleidoscope to origin/master" lib/Kaleidoscope 
+
 .env:
 	echo "ARDUINO_DIRECTORIES_USER=\"${ARDUINO_DIRECTORIES_USER}\"" >.env
 	echo "ARDUINO_DIRECTORIES_DATA=\"${ARDUINO_DIRECTORIES_DATA}\"" >>.env
 	echo "HARDWARE_DIR=\"${HARDWARE_DIR}\"" >>.env
 	echo "KALEIDOSCOPE_DIR=\"${KALEIDOSCOPE_DIR}\"" >>.env
 
+
+create-snapshot:
+	./tools/release create-snapshot
+
+
+finalize-release:
+	./tools/release finalize
+
+
 .SILENT:
 .PHONY: ${BOARDS} clean all message version version-tag setup update .env

NEWS.md

@@ -2,17 +2,22 @@ Chrysalis-Firmware-Bundle 0.92.1
 ================================
 Unreleased
 
+
 Kaleidoscope has a new "ActiveLayerKeys" plugin from Evy Bongers
 <[email protected]>
 
-
 USB protocol Fixes for both AVR-based and GD32-based keyboards that
 may eliminate "communications timeout" issues when talking to
 Chrysalis from Taylor Yu <[email protected]>
 
 Remove the Focus Serial XON/XOFF flow-control that turns out to not
 help in the way we thought it did.
 
+Discontinued new firmware builds for non-Keyboardio keyboards. These
+builds were untested and unsupported. If you're an active user of
+one of these builds and are interested in providing ongoing support
+for them, please get in touch with [email protected]
+
 
 Chrysalis-Firmware-Bundle 0.92.0
 ================================

README.md

@@ -9,7 +9,7 @@ Chrysalis Firmware Bundle
  [badge:development]: https://img.shields.io/github/v/release/keyboardio/chrysalis-firmware-bundle?include_prereleases&label=Development&style=for-the-badge
  [badge:production]: https://img.shields.io/github/v/release/keyboardio/chrysalis-firmware-bundle?label=Production&style=for-the-badge
  [build:prod]: https://github.com/keyboardio/Chrysalis-Firmware-Bundle/releases/latest
- [build:dev]: https://github.com/keyboardio/Chrysalis-Firmware-Bundle/releases/tag/v0.91.2-snapshot
+ [build:dev]: https://github.com/keyboardio/Chrysalis-Firmware-Bundle/releases/tag/v0.92.1-snapshot
 
 ## About
 
@@ -32,5 +32,5 @@ To get a list of plugins used by each firmware, run the
 keyboard.
 
 For guidelines about how we build these sketches, which plugins we enable, and
-so on, have a look at the [Chrysalis-enalbed
+so on, have a look at the [Chrysalis-enabled
 Firmware](docs/chrysalis-enabled-firmware.md) documentation.

docs/releng.md

@@ -0,0 +1,25 @@
+# Releasing Chrysalis Firmware Builds
+
+
+## Creating a new snapshot after a release
+
+`make create-snapshot`
+
+## Publishing a release
+
+### Make sure the Kaleidoscope submodule is pulled up to the version you expect
+
+#. `make pull-kaleidoscope` (If you want Kaleidoscope master)
+#. Update NEWS.md with any changes in this release
+#. 'git commit -a -s -m "A description of what you're changing"
+#. 'git push'
+#. Visit https://github.com/keyboardio/Chrysalis-Firmware-Bundle/actions to verify that the build succeeded
+#. Visit https://github.com/keyboardio/Chrysalis-Firmware-Bundle/releases to download your unpublished snapshot
+#. * TEST THE BUILT SNAPSHOT ON HARDWARE*
+#. `make finalize-release`
+#. Visit https://github.com/keyboardio/Chrysalis-Firmware-Bundle/actions to verify that the build succeeded
+#. Visit https://github.com/keyboardio/Chrysalis-Firmware-Bundle/releases to download your unpublished release
+#. Test it again
+#. Promote it to the latest release on GitHub.
+
+

tools/release

@@ -4,24 +4,21 @@ set -eE -o pipefail
 COMMAND="${1:-help}"
 COMMAND="${COMMAND//-/_}"
 
-cfb_news_version() {
-    head -n 1 NEWS.md | cut -d" " -f 2
-}
-
 cfb_make_version() {
     make version
 }
 
 cfb_push_changes() {
-    git push
+	git push
 }
 
 ## finalize
 
 cfb_verify_release_version() {
-    if [ "$(cfb_news_version)" != "$(cfb_make_version)" ]; then
+    news_version=`head -n 1 NEWS.md | cut -d" " -f 2`
+    if [ "${news_version}" != "$(cfb_make_version)" ]; then
         cat >&2 <<EOF
-Package version ($(cfb_make_version)) does not match the version in NEWS.md ($(cfb_news_version)).
+Package version ($(cfb_make_version)) does not match the version in NEWS.md (${news_version}).
 
 Please add NEWS items for the upcoming release, and make sure the versions
 align.
@@ -33,23 +30,25 @@ EOF
         ;;
         *)
             cat >&2 <<EOF
-Package version is not a snapshot version. This script requires the version to
-be a snapshot version of the upcoming release.
+It looks like you're trying to finalize a release when the labeled
+version in the Makefile isn't a -snapshot version.
+
+(The version in the Makefile is ($(cfb_make_version)).
+
+This script requires the version to be a snapshot version of the
+upcoming release.
 EOF
             exit 1
             ;;
     esac
 }
 
-cfb_get_release_version() {
-    make version | cut -d- -f1
-}
 
 cfb_update_release_version() {
-    VERSION="$(cfb_get_release_version)"
+    VERSION=$(make version | cut -d- -f1)
 
     ## Update the Makefile
-    sed -i "s,^VERSION=.*,VERSION=\"${VERSION}\"," Makefile
+    perl -i -pe "s/^VERSION=.*/VERSION=\"${VERSION}\"/" Makefile
 
     ## Update NEWS.md
     TMP=$(mktemp)
@@ -78,7 +77,7 @@ EOF
     rm -f "${TMP}"
 }
 
-cfb_create_and_push_release_tag() {
+cfb_create_and_push_version_tag() {
     VERSION=$(cfb_make_version)
     git tag -a -s -m "Chrysalis-Firmware-Bundle ${VERSION} release." v${VERSION}
     git push origin v${VERSION}
@@ -90,7 +89,7 @@ cfb_finalize() {
     cfb_update_release_date
     cfb_commit_release_preparations
     cfb_push_changes
-    cfb_create_and_push_release_tag
+    cfb_create_and_push_version_tag
 }
 
 ## create-snapshot
@@ -99,8 +98,15 @@ cfb_verify_snapshot_version() {
     case "$(cfb_make_version)" in
         *-snapshot)
             cat >&2 <<EOF
-Package version ($(cfb_make_version)) is not a tagged release. This script
-requires the version to be of a tagged release.
+It looks like this is *already* a snapshot.
+
+Package version ($(cfb_make_version)) is not a tagged release. 
+This script requires the version to be of a tagged release.
+
+The release flow is that there is only ever one -snapshot 
+before a given release. Snapshots are not themselves versioned, 
+but are updated on every push.
+
 EOF
             exit 1
         ;;
@@ -124,7 +130,8 @@ cfb_update_snapshot_version() {
     VERSION="$(cfb_new_snapshot_version)"
 
     ## Update the Makefile
-    sed -i "s,^VERSION=.*,VERSION=\"${VERSION}\"," Makefile
+    perl -i -pe "s/^VERSION=.*/VERSION=\"${VERSION}\"/" Makefile
+    git add Makefile
 
     ## Update NEWS.md
     TMP=$(mktemp)
@@ -137,16 +144,17 @@ cfb_update_snapshot_version() {
      echo ; \
      cat NEWS.md) >"${TMP}"
     mv "${TMP}" NEWS.md
+    git add NEWS.md
 }
 
 cfb_update_snapshot_readme() {
     VERSION="$(cfb_make_version)"
-    sed -i -e "s,\(\[build:dev\]: .*/releases/tag/\).*,\1v${VERSION}," README.md
+    perl -i -pe "s{(\[build:dev\]: .*/releases/tag/).*}{\${1}v${VERSION}}" README.md
+    git add README.md
 }
 
 cfb_commit_snapshot_changes() {
     VERSION="$(cfb_make_version)"
-    git add Makefile NEWS.md README.md
     git commit -s -m "Bump version to ${VERSION}"
 }