|
| 1 | +#!/bin/bash |
| 2 | +# SpojBoard Release Helper Script |
| 3 | +# Usage: ./release.sh <release_number> |
| 4 | +# Example: ./release.sh 3 |
| 5 | + |
| 6 | +set -e |
| 7 | + |
| 8 | +if [ -z "$1" ]; then |
| 9 | + echo "Usage: ./release.sh <release_number>" |
| 10 | + echo "Example: ./release.sh 3" |
| 11 | + exit 1 |
| 12 | +fi |
| 13 | + |
| 14 | +RELEASE_NUM=$1 |
| 15 | +TAG_NAME="r${RELEASE_NUM}" |
| 16 | + |
| 17 | +echo "=== SpojBoard Release Helper ===" |
| 18 | +echo "Release number: ${RELEASE_NUM}" |
| 19 | +echo "Tag name: ${TAG_NAME}" |
| 20 | +echo "" |
| 21 | + |
| 22 | +# Check if tag already exists |
| 23 | +if git rev-parse "$TAG_NAME" >/dev/null 2>&1; then |
| 24 | + echo "ERROR: Tag ${TAG_NAME} already exists!" |
| 25 | + echo "To delete it locally: git tag -d ${TAG_NAME}" |
| 26 | + echo "To delete it remotely: git push origin :refs/tags/${TAG_NAME}" |
| 27 | + exit 1 |
| 28 | +fi |
| 29 | + |
| 30 | +# Check if working directory is clean |
| 31 | +if [ -n "$(git status --porcelain)" ]; then |
| 32 | + echo "WARNING: Working directory is not clean!" |
| 33 | + echo "" |
| 34 | + git status --short |
| 35 | + echo "" |
| 36 | + read -p "Continue anyway? (y/N) " -n 1 -r |
| 37 | + echo |
| 38 | + if [[ ! $REPLY =~ ^[Yy]$ ]]; then |
| 39 | + echo "Aborted." |
| 40 | + exit 1 |
| 41 | + fi |
| 42 | +fi |
| 43 | + |
| 44 | +# Check if CHANGELOG.md has entry for this release |
| 45 | +if ! grep -q "## \[r${RELEASE_NUM}\]" CHANGELOG.md; then |
| 46 | + echo "WARNING: No changelog entry found for [r${RELEASE_NUM}] in CHANGELOG.md" |
| 47 | + echo "" |
| 48 | + read -p "Continue anyway? (y/N) " -n 1 -r |
| 49 | + echo |
| 50 | + if [[ ! $REPLY =~ ^[Yy]$ ]]; then |
| 51 | + echo "Aborted." |
| 52 | + echo "Please add a changelog entry for [r${RELEASE_NUM}] in CHANGELOG.md" |
| 53 | + exit 1 |
| 54 | + fi |
| 55 | +fi |
| 56 | + |
| 57 | +# Show what will be in the release |
| 58 | +echo "" |
| 59 | +echo "=== Commits since last release ===" |
| 60 | +LAST_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "") |
| 61 | +if [ -n "$LAST_TAG" ]; then |
| 62 | + git log --oneline ${LAST_TAG}..HEAD |
| 63 | +else |
| 64 | + echo "No previous tags found. This will be the first release." |
| 65 | + git log --oneline HEAD~10..HEAD |
| 66 | +fi |
| 67 | + |
| 68 | +echo "" |
| 69 | +echo "=== Changelog for r${RELEASE_NUM} ===" |
| 70 | +awk "/## \[r${RELEASE_NUM}\]/,/## \[r[0-9]/" CHANGELOG.md | sed '1d;$d' | head -20 |
| 71 | +echo "" |
| 72 | + |
| 73 | +read -p "Create and push tag ${TAG_NAME}? (y/N) " -n 1 -r |
| 74 | +echo |
| 75 | +if [[ ! $REPLY =~ ^[Yy]$ ]]; then |
| 76 | + echo "Aborted." |
| 77 | + exit 1 |
| 78 | +fi |
| 79 | + |
| 80 | +# Update CHANGELOG date if it says "Unreleased" |
| 81 | +if grep -q "## \[r${RELEASE_NUM}\] - Unreleased" CHANGELOG.md; then |
| 82 | + TODAY=$(date +%Y-%m-%d) |
| 83 | + sed -i.bak "s/## \[r${RELEASE_NUM}\] - Unreleased/## [r${RELEASE_NUM}] - ${TODAY}/" CHANGELOG.md |
| 84 | + rm CHANGELOG.md.bak |
| 85 | + git add CHANGELOG.md |
| 86 | + git commit -m "chore: update CHANGELOG for release r${RELEASE_NUM}" || true |
| 87 | + echo "Updated CHANGELOG.md with release date: ${TODAY}" |
| 88 | +fi |
| 89 | + |
| 90 | +# Create and push tag |
| 91 | +git tag -a "${TAG_NAME}" -m "Release ${RELEASE_NUM}" |
| 92 | +git push origin "${TAG_NAME}" |
| 93 | + |
| 94 | +echo "" |
| 95 | +echo "=== Success! ===" |
| 96 | +echo "Tag ${TAG_NAME} created and pushed." |
| 97 | +echo "GitHub Actions will now:" |
| 98 | +echo " 1. Build the firmware" |
| 99 | +echo " 2. Create a GitHub release" |
| 100 | +echo " 3. Upload the .bin file" |
| 101 | +echo " 4. Add changelog from CHANGELOG.md" |
| 102 | +echo "" |
| 103 | +echo "Monitor progress at:" |
| 104 | +echo "https://github.com/xbach/spojboard-firmware/actions" |
| 105 | +echo "" |
| 106 | +echo "Release will be available at:" |
| 107 | +echo "https://github.com/xbach/spojboard-firmware/releases/tag/${TAG_NAME}" |
0 commit comments