feat(release-please): per-scope routing for fastlane changelogs

.github/workflows/release-please-fastlane-changelog.yml

@@ -0,0 +1,250 @@
+# Reusable Release Please + Fastlane Changelog Workflow
+#
+# Runs release-please, then if a PR was created/updated, generates a
+# fastlane changelog from CHANGELOG.md and amends it into the release
+# commit. The changelog is truncated to 500 chars (Play Store limit).
+#
+# Two complementary ways to configure output directories:
+#
+# 1. `fastlane-changelog-dirs` — newline-separated paths. These are
+#    "catch-all" dirs: every commit (regardless of scope) is written
+#    to them, unfiltered.
+#
+# 2. `scopes` — YAML map of `scope: dir(s)`. Dirs listed here are
+#    scope-filtered: they only receive commits whose scope either:
+#      - is not present anywhere in the map (treated as "applies
+#        to all"), or
+#      - is present and lists that dir among its targets.
+#
+#    Example:
+#      scopes: |
+#        ios: fastlane/metadata/ios/en-US/changelogs
+#        apple: |
+#          fastlane/metadata/ios/en-US/changelogs
+#          fastlane/metadata/macos/en-US/changelogs
+#        android: fastlane/metadata/android/en-US/changelogs
+#
+#    With this, `feat(ios): …` lands only in the iOS dir,
+#    `feat(apple): …` lands in iOS and macOS, `feat(android): …`
+#    lands only in the Android dir, and unscoped commits land in all.
+#
+# A dir present in both inputs is treated as a catch-all.
+#
+# Outputs are forwarded from release-please so downstream jobs can
+# use release_created, tag_name, and version.
+
+name: Release Please + Fastlane Changelog
+
+on:
+  workflow_call:
+    inputs:
+      release-type:
+        description: 'Release Please release type (e.g., dart, node, python, go)'
+        required: true
+        type: string
+      version-file:
+        description: 'File containing the version string'
+        required: false
+        type: string
+        default: 'pubspec.yaml'
+      changelog-file:
+        description: 'Path to the CHANGELOG.md file'
+        required: false
+        type: string
+        default: 'CHANGELOG.md'
+      fastlane-changelog-dirs:
+        description: |
+          Newline-separated list of catch-all directories. Every commit
+          is written here unfiltered, regardless of scope.
+        required: false
+        type: string
+        default: ''
+      scopes:
+        description: |
+          YAML mapping of commit scope to one-or-more output directories.
+          Dirs listed here are scope-filtered: they only receive commits
+          whose scope is unmapped or lists that dir among its targets.
+        required: false
+        type: string
+        default: ''
+      max-length:
+        description: 'Maximum changelog length (Play Store limit is 500)'
+        required: false
+        type: number
+        default: 500
+      truncation-trailer:
+        description: 'Text appended when changelog is truncated'
+        required: false
+        type: string
+        default: "\n\n… see full notes on GitHub."
+    secrets:
+      token:
+        description: 'GitHub token for release-please (defaults to GITHUB_TOKEN)'
+        required: false
+    outputs:
+      release_created:
+        description: 'Whether a release was created'
+        value: ${{ jobs.release-please.outputs.release_created }}
+      tag_name:
+        description: 'The release tag name'
+        value: ${{ jobs.release-please.outputs.tag_name }}
+      version:
+        description: 'The release version'
+        value: ${{ jobs.release-please.outputs.version }}
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+      tag_name: ${{ steps.release.outputs.tag_name }}
+      version: ${{ steps.release.outputs.version }}
+
+    steps:
+      - name: Release Please
+        id: release
+        uses: googleapis/release-please-action@v4
+        with:
+          release-type: ${{ inputs.release-type }}
+          token: ${{ secrets.token || github.token }}
+
+      - name: Update fastlane changelog on release PR
+        if: ${{ steps.release.outputs.pr && !steps.release.outputs.release_created }}
+        env:
+          PR_JSON: ${{ steps.release.outputs.pr }}
+          VERSION_FILE: ${{ inputs.version-file }}
+          CHANGELOG_FILE: ${{ inputs.changelog-file }}
+          OUT_DIRS: ${{ inputs.fastlane-changelog-dirs }}
+          SCOPES_INPUT: ${{ inputs.scopes }}
+          MAX_LENGTH: ${{ inputs.max-length }}
+          TRAILER: ${{ inputs.truncation-trailer }}
+        run: |
+          set -euo pipefail
+          PR_BRANCH=$(echo "$PR_JSON" | jq -r .headBranchName)
+          git clone --depth=5 --branch "$PR_BRANCH" \
+            https://x-access-token:${{ secrets.token || github.token }}@github.com/${{ github.repository }}.git _pr
+          cd _pr
+
+          # Extract version name and code
+          VERSION_LINE=$(grep '^version:' "$VERSION_FILE")
+          VERSION=$(echo "$VERSION_LINE" | sed 's/version: *//;s/+.*//')
+          CODE=$(echo "$VERSION_LINE" | sed 's/.*+//')
+
+          # Extract raw release notes from CHANGELOG.md (unfiltered, pre-cosmetics)
+          if [ ! -f "$CHANGELOG_FILE" ]; then
+            RAW_NOTES=""
+            echo "No $CHANGELOG_FILE found, will use fallback."
+          else
+            RAW_NOTES=$(awk "
+              /^## \\[${VERSION//./\\.}\\]/ { found=1; next }
+              /^## / { if (found) exit }
+              found { print }
+            " "$CHANGELOG_FILE")
+          fi
+
+          # Parse scopes map (if provided) → SCOPE_NAMES + SCOPE_DIRS
+          SCOPE_NAMES=()
+          declare -A SCOPE_DIRS=()
+          SCOPED_DIRS=""
+          if [ -n "${SCOPES_INPUT//[[:space:]]/}" ]; then
+            mapfile -t SCOPE_NAMES < <(printf '%s' "$SCOPES_INPUT" | yq 'keys | .[]')
+            for s in "${SCOPE_NAMES[@]}"; do
+              raw=$(printf '%s' "$SCOPES_INPUT" | yq ".\"$s\"")
+              [ "$raw" = "null" ] && raw=""
+              clean=$(printf '%s\n' "$raw" | sed 's/^[[:space:]]*//;s/[[:space:]]*$//' | awk 'NF')
+              SCOPE_DIRS["$s"]="$clean"
+              SCOPED_DIRS=$(printf '%s\n%s' "$SCOPED_DIRS" "$clean")
+            done
+          fi
+          SCOPED_DIRS=$(printf '%s\n' "$SCOPED_DIRS" | awk 'NF' | sort -u)
+
+          # Catch-all dirs from fastlane-changelog-dirs receive all commits unfiltered.
+          # A dir present in both inputs is treated as a catch-all.
+          CATCHALL_DIRS=$(printf '%s\n' "$OUT_DIRS" | sed 's/^[[:space:]]*//;s/[[:space:]]*$//' | awk 'NF' | sort -u)
+          ALL_DIRS=$(printf '%s\n%s\n' "$SCOPED_DIRS" "$CATCHALL_DIRS" | awk 'NF' | sort -u)
+
+          echo "Catch-all dirs:"
+          [ -n "$CATCHALL_DIRS" ] && printf '  %s\n' $CATCHALL_DIRS || echo "  (none)"
+          echo "Scope-filtered dirs:"
+          if [ ${#SCOPE_NAMES[@]} -gt 0 ]; then
+            for s in "${SCOPE_NAMES[@]}"; do
+              echo "  scope '$s':"
+              printf '    %s\n' ${SCOPE_DIRS[$s]}
+            done
+          else
+            echo "  (none)"
+          fi
+
+          format_notes() {
+            local input="$1"
+            local out
+            out=$(printf '%s\n' "$input" \
+              | sed -E 's/ *\(\[[0-9a-f]+\]\([^)]+\)\)//g' \
+              | sed -E 's/^\* \*\*[^*]+:\*\* */- /; s/^\* /- /' \
+              | sed 's/^### //' \
+              | sed '/^[[:space:]]*$/d')
+            # strip leading + trailing blank lines
+            out=$(printf '%s' "$out" | sed -e '/./,$!d' -e :a -e '/^\n*$/{$d;N;ba;}')
+            printf '%s' "$out"
+          }
+
+          truncate_notes() {
+            local notes="$1"
+            if [ ${#notes} -gt "$MAX_LENGTH" ]; then
+              local budget=$((MAX_LENGTH - ${#TRAILER}))
+              notes="${notes:0:$budget}"
+              notes=$(printf '%s' "$notes" | sed '$d')
+              notes="${notes}${TRAILER}"
+            fi
+            printf '%s' "$notes"
+          }
+
+          # Write per-directory
+          while IFS= read -r dir; do
+            [ -z "$dir" ] && continue
+
+            is_catchall=0
+            if printf '%s\n' "$CATCHALL_DIRS" | grep -Fxq "$dir"; then
+              is_catchall=1
+            fi
+
+            exclude_alt=""
+            if [ "$is_catchall" -eq 0 ] && [ ${#SCOPE_NAMES[@]} -gt 0 ]; then
+              for s in "${SCOPE_NAMES[@]}"; do
+                if ! printf '%s\n' "${SCOPE_DIRS[$s]}" | grep -Fxq "$dir"; then
+                  if [ -z "$exclude_alt" ]; then
+                    exclude_alt="$s"
+                  else
+                    exclude_alt="$exclude_alt|$s"
+                  fi
+                fi
+              done
+            fi
+
+            filtered="$RAW_NOTES"
+            if [ -n "$exclude_alt" ]; then
+              filtered=$(printf '%s\n' "$RAW_NOTES" | grep -vE "^\* \*\*($exclude_alt)[^*]*:\*\*" || true)
+            fi
+
+            notes=$(format_notes "$filtered")
+            [ -z "$notes" ] && notes="Release $VERSION"
+            notes=$(truncate_notes "$notes")
+
+            mkdir -p "$dir"
+            printf '%s\n' "$notes" > "$dir/$CODE.txt"
+            if [ "$is_catchall" -eq 1 ]; then
+              echo "Wrote $dir/$CODE.txt (${#notes} chars, catch-all)"
+            else
+              echo "Wrote $dir/$CODE.txt (${#notes} chars, excluded scopes: ${exclude_alt:-none})"
+            fi
+          done <<< "$ALL_DIRS"
+
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add .
+          if git diff --cached --quiet; then
+            echo "No changelog changes."
+          else
+            git commit --amend --no-edit
+            git push --force-with-lease
+          fi

README.md

@@ -7,6 +7,7 @@ A collection of reusable GitHub Actions workflows.
 - [Workflows](#workflows)
   - [Go Release](#go-release-go-releaseyml)
   - [Manual Homebrew Release](#manual-homebrew-release-manual-homebrew-releaseyml)
+  - [Release Please + Fastlane Changelog](#release-please--fastlane-changelog-release-please-fastlane-changelogyml)
 - [Nextcloud Workflows](#nextcloud-workflows)
   - [PHPUnit MySQL](#phpunit-mysql-nextcloud-phpunit-mysqlyml)
   - [PHPUnit PostgreSQL](#phpunit-postgresql-nextcloud-phpunit-pgsqlyml)
@@ -123,6 +124,85 @@ jobs:
 
 ---
 
+### Release Please + Fastlane Changelog (`release-please-fastlane-changelog.yml`)
+
+Runs [release-please](https://github.com/googleapis/release-please), then when a release PR is
+created or updated, extracts the changelog for the current version from `CHANGELOG.md`, formats it
+for the Play Store (stripped of markdown links, commit hashes, etc.), truncates to the 500-char
+limit, and writes it to one or more fastlane metadata directories. The changelog is amended into
+release-please's commit so the tagged release includes the file.
+
+#### Features
+
+- Runs release-please with configurable release type
+- Extracts version-specific notes from `CHANGELOG.md`
+- Strips commit links, reformats bullets, removes markdown headers
+- Truncates to Play Store's 500-char limit with a configurable trailer
+- Writes to multiple output directories (e.g. Android + iOS fastlane metadata)
+- Amends the release-please commit (no extra commits in the PR)
+- Forwards `release_created`, `tag_name`, and `version` outputs
+
+#### Usage
+
+```yaml
+name: CI/CD
+
+on:
+  push:
+    branches: [master]
+
+jobs:
+  release-please:
+    uses: chenasraf/workflows/.github/workflows/release-please-fastlane-changelog.yml@master
+    with:
+      release-type: dart
+```
+
+With multiple output directories (Android + iOS):
+
+```yaml
+jobs:
+  release-please:
+    uses: chenasraf/workflows/.github/workflows/release-please-fastlane-changelog.yml@master
+    with:
+      release-type: dart
+      fastlane-changelog-dirs: |
+        fastlane/metadata/android/en-US/changelogs
+        fastlane/metadata/ios/en-US/changelogs
+
+  build:
+    needs: release-please
+    if: ${{ needs.release-please.outputs.release_created }}
+    # ...
+```
+
+#### Inputs
+
+| Input                      | Description                                                        | Required | Default                                          |
+| -------------------------- | ------------------------------------------------------------------ | -------- | ------------------------------------------------ |
+| `release-type`             | Release Please release type (`dart`, `node`, `python`, `go`, etc.) | Yes      | -                                                |
+| `version-file`             | File containing the version string                                 | No       | `pubspec.yaml`                                   |
+| `changelog-file`           | Path to the CHANGELOG.md file                                      | No       | `CHANGELOG.md`                                   |
+| `fastlane-changelog-dirs`  | Newline-separated list of output directories                       | No       | `fastlane/metadata/android/en-US/changelogs`     |
+| `max-length`               | Maximum changelog length in characters                             | No       | `500`                                            |
+| `truncation-trailer`       | Text appended when the changelog is truncated                      | No       | `\n\n… see full notes on GitHub.`                |
+
+#### Secrets
+
+| Secret  | Description                                        | Required |
+| ------- | -------------------------------------------------- | -------- |
+| `token` | GitHub token for release-please (defaults to `GITHUB_TOKEN`) | No       |
+
+#### Outputs
+
+| Output            | Description                  |
+| ----------------- | ---------------------------- |
+| `release_created` | Whether a release was created |
+| `tag_name`        | The release tag name          |
+| `version`         | The release version           |
+
+---
+
 ## Nextcloud Workflows
 
 Reusable workflows for Nextcloud app development. These workflows include automatic path filtering to skip unnecessary runs when irrelevant files change.