Add issue templates, contribution guidelines, and code of conduct; update CI/CD workflows and project metadata

Signed-off-by: Hans Kokx <hans.d.kokx@gmail.com>
2026-05-13 13:58:28 +02:00
parent db0c862e79
commit 2229c638f9
13 changed files with 441 additions and 7 deletions
@@ -0,0 +1,201 @@
+name: CI
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  format:
+    name: format
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Dart
+        uses: dart-lang/setup-dart@v1
+      - name: Install dependencies
+        run: dart pub get
+      - name: Check formatting
+        run: dart format --output=none --set-exit-if-changed .
+
+  analyze:
+    name: analyze
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Dart
+        uses: dart-lang/setup-dart@v1
+      - name: Install dependencies
+        run: dart pub get
+      - name: Run analyzer
+        run: dart analyze --fatal-infos
+
+  test:
+    name: test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Dart
+        uses: dart-lang/setup-dart@v1
+      - name: Install dependencies
+        run: dart pub get
+      - name: Run tests
+        run: dart test
+
+  pana:
+    name: pana
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Dart
+        uses: dart-lang/setup-dart@v1
+      - name: Install dependencies
+        run: dart pub get
+      - name: Run pana and enforce full score
+        run: |
+          set -euo pipefail
+          dart pub global activate pana
+          export PATH="$PATH:$HOME/.pub-cache/bin"
+
+          pana . | tee /tmp/pana.log
+
+          SCORE_LINE="$(grep -Eo 'Points: [0-9]+/[0-9]+' /tmp/pana.log | tail -n1 || true)"
+          if [ -z "$SCORE_LINE" ]; then
+            echo "Could not parse pana score output."
+            exit 1
+          fi
+
+          SCORE="${SCORE_LINE#Points: }"
+          GOT="${SCORE%/*}"
+          MAX="${SCORE#*/}"
+
+          if [ "$GOT" -ne "$MAX" ]; then
+            echo "Pana score must be full. Got $SCORE."
+            exit 1
+          fi
+
+          echo "Pana full score confirmed: $SCORE"
+
+  version_and_changelog:
+    name: version-and-changelog
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Validate release metadata for PRs into main
+        run: |
+          set -euo pipefail
+
+          if [ "${GITHUB_EVENT_NAME}" != "pull_request" ]; then
+            echo "Not a pull_request event; skipping version/changelog gate."
+            exit 0
+          fi
+
+          if [ -z "${GITHUB_BASE_REF:-}" ]; then
+            echo "GITHUB_BASE_REF is not set for pull_request event."
+            exit 1
+          fi
+
+          git fetch origin "${GITHUB_BASE_REF}" --depth=1
+
+          if git diff --quiet "origin/${GITHUB_BASE_REF}...HEAD" -- pubspec.yaml README.md ':(glob)**/*.dart'; then
+            echo "No release-relevant files changed (pubspec.yaml, README.md, *.dart); skipping version/changelog gate."
+            exit 0
+          fi
+
+          PACKAGE_NAME="$(sed -nE 's/^name:\s*([^[:space:]]+)\s*$/\1/p' pubspec.yaml | head -n1)"
+          PR_VERSION="$(sed -nE 's/^version:\s*([^[:space:]]+)\s*$/\1/p' pubspec.yaml | head -n1)"
+          BASE_HAS_PUBSPEC="false"
+          BASE_VERSION=""
+
+          if git cat-file -e "origin/${GITHUB_BASE_REF}:pubspec.yaml" 2>/dev/null; then
+            BASE_HAS_PUBSPEC="true"
+            BASE_VERSION="$(git show "origin/${GITHUB_BASE_REF}:pubspec.yaml" | sed -nE 's/^version:\s*([^[:space:]]+)\s*$/\1/p' | head -n1)"
+          fi
+
+          if [ -z "$PACKAGE_NAME" ] || [ -z "$PR_VERSION" ]; then
+            echo "Unable to read package name/version from PR pubspec.yaml."
+            exit 1
+          fi
+
+          if [ "$BASE_HAS_PUBSPEC" = "true" ]; then
+            if [ -z "$BASE_VERSION" ]; then
+              echo "Unable to read version from base branch pubspec.yaml."
+              exit 1
+            fi
+
+            parse_semver_core() {
+              printf '%s' "$1" | sed -E 's/^([0-9]+\.[0-9]+\.[0-9]+).*/\1/'
+            }
+
+            BASE_CORE="$(parse_semver_core "$BASE_VERSION")"
+            PR_CORE="$(parse_semver_core "$PR_VERSION")"
+
+            if ! printf '%s' "$BASE_CORE" | grep -Eq '^[0-9]+\.[0-9]+\.[0-9]+$'; then
+              echo "Base version is not valid semver: $BASE_VERSION"
+              exit 1
+            fi
+
+            if ! printf '%s' "$PR_CORE" | grep -Eq '^[0-9]+\.[0-9]+\.[0-9]+$'; then
+              echo "PR version is not valid semver: $PR_VERSION"
+              exit 1
+            fi
+
+            BASE_MAJOR="${BASE_CORE%%.*}"
+            BASE_REST="${BASE_CORE#*.}"
+            BASE_MINOR="${BASE_REST%%.*}"
+            BASE_PATCH="${BASE_REST#*.}"
+
+            PR_MAJOR="${PR_CORE%%.*}"
+            PR_REST="${PR_CORE#*.}"
+            PR_MINOR="${PR_REST%%.*}"
+            PR_PATCH="${PR_REST#*.}"
+
+            if [ "$PR_MAJOR" -lt "$BASE_MAJOR" ]; then
+              echo "pubspec.yaml version must be greater than base version ($BASE_VERSION -> $PR_VERSION)."
+              exit 1
+            fi
+
+            if [ "$PR_MAJOR" -eq "$BASE_MAJOR" ] && [ "$PR_MINOR" -lt "$BASE_MINOR" ]; then
+              echo "pubspec.yaml version must be greater than base version ($BASE_VERSION -> $PR_VERSION)."
+              exit 1
+            fi
+
+            if [ "$PR_MAJOR" -eq "$BASE_MAJOR" ] && [ "$PR_MINOR" -eq "$BASE_MINOR" ] && [ "$PR_PATCH" -lt "$BASE_PATCH" ]; then
+              echo "pubspec.yaml version must be greater than base version ($BASE_VERSION -> $PR_VERSION)."
+              exit 1
+            fi
+
+            if [ "$PR_MAJOR" -eq "$BASE_MAJOR" ] && [ "$PR_MINOR" -eq "$BASE_MINOR" ] && [ "$PR_PATCH" -eq "$BASE_PATCH" ]; then
+              if curl -fsSL "https://pub.dev/api/packages/${PACKAGE_NAME}" | grep -q "\"version\":\"${PR_VERSION}\""; then
+                echo "pubspec.yaml version must be at least 0.0.1 greater than base version ($BASE_VERSION -> $PR_VERSION)."
+                exit 1
+              fi
+
+              echo "Version unchanged ($PR_VERSION), but this version is not yet on pub.dev; allowing first publish."
+            fi
+          else
+            echo "Base branch has no pubspec.yaml; treating this as first release."
+          fi
+
+          if git diff --quiet "origin/${GITHUB_BASE_REF}...HEAD" -- CHANGELOG.md; then
+            echo "CHANGELOG.md must be updated in the PR."
+            exit 1
+          fi
+
+          if ! grep -Fq "## $PR_VERSION" CHANGELOG.md && ! grep -Fq "## [$PR_VERSION]" CHANGELOG.md; then
+            echo "CHANGELOG.md must include a heading for version $PR_VERSION."
+            exit 1
+          fi
+
+          if [ "$BASE_HAS_PUBSPEC" = "true" ]; then
+            echo "Version/changelog gate passed: $BASE_VERSION -> $PR_VERSION"
+          else
+            echo "Version/changelog gate passed for first release: $PR_VERSION"
+          fi
@@ -0,0 +1,95 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  create_tag_and_release:
+    name: create-tag-and-release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Create version tag and Gitea release
+        env:
+          GITEA_RELEASE_TOKEN: ${{ secrets.GITEA_RELEASE_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          set -euo pipefail
+
+          BASE_SHA="${GITHUB_EVENT_BEFORE:-}"
+          if [ -z "$BASE_SHA" ] || [ "$BASE_SHA" = "0000000000000000000000000000000000000000" ]; then
+            if git rev-parse --verify HEAD^ >/dev/null 2>&1; then
+              BASE_SHA="$(git rev-parse HEAD^)"
+            fi
+          fi
+
+          if [ -n "$BASE_SHA" ] && git diff --quiet "$BASE_SHA...$GITHUB_SHA" -- pubspec.yaml README.md ':(glob)**/*.dart'; then
+            echo "No release-relevant files changed (pubspec.yaml, README.md, *.dart); skipping tag/release creation."
+            exit 0
+          fi
+
+          PACKAGE_VERSION="$(sed -nE 's/^version:\s*([^[:space:]]+)\s*$/\1/p' pubspec.yaml | head -n1)"
+          if [ -z "$PACKAGE_VERSION" ]; then
+            echo "Failed to parse version from pubspec.yaml."
+            exit 1
+          fi
+
+          TAG="v${PACKAGE_VERSION}"
+          TOKEN="${GITEA_RELEASE_TOKEN:-}"
+          if [ -z "$TOKEN" ]; then
+            TOKEN="${GITHUB_TOKEN:-}"
+          fi
+
+          if [ -z "$TOKEN" ]; then
+            echo "Missing release token. Provide GITEA_RELEASE_TOKEN or a usable default workflow token."
+            exit 1
+          fi
+
+          SERVER_URL="${GITHUB_SERVER_URL:-${GITEA_SERVER_URL:-}}"
+          REPO_PATH="${GITHUB_REPOSITORY:-${GITEA_REPOSITORY:-}}"
+          SHA="${GITHUB_SHA:-}"
+
+          if [ -z "$SERVER_URL" ] || [ -z "$REPO_PATH" ] || [ -z "$SHA" ]; then
+            echo "Missing repository context required for Gitea API release creation."
+            exit 1
+          fi
+
+          RELEASE_BY_TAG_URL="${SERVER_URL}/api/v1/repos/${REPO_PATH}/releases/tags/${TAG}"
+          LOOKUP_HTTP_CODE="$(curl -sS -o /tmp/gitea-release-lookup.json -w '%{http_code}' \
+            -H "Authorization: token ${TOKEN}" \
+            "$RELEASE_BY_TAG_URL")"
+
+          if [ "$LOOKUP_HTTP_CODE" = "200" ]; then
+            echo "Release ${TAG} already exists; skipping release creation."
+            exit 0
+          fi
+
+          if [ "$LOOKUP_HTTP_CODE" != "404" ]; then
+            echo "Failed to query release-by-tag endpoint. HTTP ${LOOKUP_HTTP_CODE}."
+            cat /tmp/gitea-release-lookup.json
+            exit 1
+          fi
+
+          CREATE_RELEASE_URL="${SERVER_URL}/api/v1/repos/${REPO_PATH}/releases"
+          RELEASE_PAYLOAD="{\"tag_name\":\"${TAG}\",\"target\":\"${SHA}\",\"target_commitish\":\"${SHA}\",\"title\":\"${TAG}\",\"name\":\"${TAG}\",\"note\":\"Release ${TAG}\",\"body\":\"Release ${TAG}\",\"draft\":false,\"prerelease\":false}"
+
+          HTTP_CODE="$(curl -sS -o /tmp/gitea-release-response.json -w '%{http_code}' \
+            -X POST "$CREATE_RELEASE_URL" \
+            -H "Authorization: token ${TOKEN}" \
+            -H 'Content-Type: application/json' \
+            -d "$RELEASE_PAYLOAD")"
+
+          if [ "$HTTP_CODE" = "201" ]; then
+            echo "Created Gitea release for ${TAG}."
+          elif [ "$HTTP_CODE" = "409" ]; then
+            echo "Release or tag ${TAG} already exists; treating as success."
+          else
+            echo "Failed to create Gitea release. HTTP ${HTTP_CODE}."
+            cat /tmp/gitea-release-response.json
+            exit 1
+          fi