Release: edge-apps-actions v26.10.2 (development → main)

.github/actions/apply-feed-app/action.yml

@@ -0,0 +1,103 @@
+---
+name: Apply feed app config
+description: >
+  Turns screenly.yml into the manifest for one feed app from deployed-apps.yml,
+  so the shared edge-apps-actions can deploy it like any other Edge App. The
+  code is the same for every feed app; only these manifest fields differ.
+
+inputs:
+  app_key:
+    description: Key of the app under `apps:` in deployed-apps.yml (e.g. bbc-news)
+    required: true
+  environment:
+    description: stage or production, to look up the app's id for it
+    required: true
+  override_description:
+    description: Use instead of the app's description (optional)
+    required: false
+    default: ''
+  override_icon_url:
+    description: Use instead of the app's icon_url (optional)
+    required: false
+    default: ''
+  override_rss_title:
+    description: Use instead of the app's rss_title (optional)
+    required: false
+    default: ''
+  override_rss_url:
+    description: Use instead of the app's rss_url (optional)
+    required: false
+    default: ''
+
+outputs:
+  app_name:
+    description: The app's app_name, used as the Edge App name and instance title
+    value: ${{ steps.apply.outputs.app_name }}
+  edge_app_id:
+    description: The app's id for this environment, or empty if it has none yet
+    value: ${{ steps.apply.outputs.edge_app_id }}
+
+runs:
+  using: composite
+  steps:
+    - name: Setup yq
+      uses: ./.github/actions/setup-yq
+
+    - name: Apply ${{ inputs.app_key }} to screenly.yml
+      id: apply
+      shell: bash
+      # Inputs arrive as environment variables, never pasted into the script,
+      # so quotes or $ in a description can't break the step
+      env:
+        APP_KEY: ${{ inputs.app_key }}
+        ENVIRONMENT: ${{ inputs.environment }}
+        OVERRIDE_DESCRIPTION: ${{ inputs.override_description }}
+        OVERRIDE_ICON_URL: ${{ inputs.override_icon_url }}
+        OVERRIDE_RSS_TITLE: ${{ inputs.override_rss_title }}
+        OVERRIDE_RSS_URL: ${{ inputs.override_rss_url }}
+      run: |
+        set -euo pipefail
+
+        APP_JSON=$(yq -o=json '.apps' deployed-apps.yml | jq -c --arg key "$APP_KEY" '.[$key] // empty')
+        if [ -z "$APP_JSON" ]; then
+          echo "::error::No app '$APP_KEY' in deployed-apps.yml."
+          exit 1
+        fi
+
+        field() {
+          jq -r --arg f "$1" '.[$f] // "" | tostring' <<<"$APP_JSON"
+        }
+
+        APP_NAME=$(field app_name)
+        DESCRIPTION="${OVERRIDE_DESCRIPTION:-$(field description)}"
+        ICON_URL="${OVERRIDE_ICON_URL:-$(field icon_url)}"
+        RSS_TITLE="${OVERRIDE_RSS_TITLE:-$(field rss_title)}"
+        RSS_URL="${OVERRIDE_RSS_URL:-$(field rss_url)}"
+        EDGE_APP_ID=$(jq -r --arg env "$ENVIRONMENT" '(.ids // {})[$env] // "" | tostring' <<<"$APP_JSON")
+
+        for name in APP_NAME DESCRIPTION ICON_URL RSS_TITLE RSS_URL; do
+          if [ -z "${!name}" ]; then
+            echo "::error::'$APP_KEY' in deployed-apps.yml is missing $(tr '[:upper:]' '[:lower:]' <<<"$name")."
+            exit 1
+          fi
+        done
+
+        # The shared actions take the id as an input, so the manifest must
+        # not carry one
+        export DESCRIPTION ICON_URL RSS_TITLE RSS_URL
+        yq -i '
+          del(.id) |
+          .description = strenv(DESCRIPTION) |
+          .icon = strenv(ICON_URL) |
+          .settings.rss_title.default_value = strenv(RSS_TITLE) |
+          .settings.rss_url.default_value = strenv(RSS_URL)
+        ' screenly.yml
+
+        {
+          echo "app_name=$APP_NAME"
+          echo "edge_app_id=$EDGE_APP_ID"
+        } >> "$GITHUB_OUTPUT"
+
+    - name: Show manifest for ${{ inputs.app_key }}
+      shell: bash
+      run: cat screenly.yml

.github/dependabot.yml

@@ -19,7 +19,8 @@ updates:
   - package-ecosystem: 'github-actions'
     directory: '/'
     schedule:
-      interval: 'monthly'
+      interval: 'weekly'
+    target-branch: 'development'
     groups:
       github-actions:
         patterns:

.github/workflows/checks.yml

@@ -1,16 +1,21 @@
+---
 name: Checks
 
 on:
   push:
     branches:
+      - development
       - main
+      - master
   pull_request:
     branches:
+      - development
       - main
+      - master
+
+permissions:
+  contents: read
 
 jobs:
   checks:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v7
-      - uses: Screenly/edge-apps-actions/checks@v1
+    uses: Screenly/edge-apps-actions/.github/workflows/checks.yml@v26.10.2

.github/workflows/initialize-edge-app.yml

@@ -21,20 +21,35 @@ on:
         required: true
         type: string
 
+permissions:
+  contents: read
+
 run-name: Initializing ${{ inputs.edge_app_name }} in ${{ inputs.environment }}
 
 jobs:
-  initialize:
-    name: Initializing ${{ inputs.edge_app_name }} in ${{ inputs.environment }}
+  # The reusable workflow builds whatever ref this run was started from, so
+  # refuse anything but the default branch rather than initializing an app
+  # (possibly in production) from unreleased code. This fails loudly instead
+  # of skipping, so a run from the wrong branch can't look like a success.
+  verify-ref:
+    name: Verify default branch
     runs-on: ubuntu-latest
-    environment: ${{ inputs.environment }}
     steps:
-      - uses: actions/checkout@v7
-        with:
-          ref: main
-      - uses: Screenly/edge-apps-actions/initialize@v1
-        with:
-          screenly_api_token: ${{ secrets.SCREENLY_API_TOKEN }}
-          edge_app_name: ${{ inputs.edge_app_name }}
-          edge_app_title: ${{ inputs.edge_app_title }}
-          environment: ${{ inputs.environment }}
+      - name: Require the default branch
+        env:
+          DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
+        run: |
+          if [ "$GITHUB_REF" != "refs/heads/$DEFAULT_BRANCH" ]; then
+            echo "::error::Initialize Edge App must be run from $DEFAULT_BRANCH, not $GITHUB_REF_NAME."
+            exit 1
+          fi
+
+  initialize:
+    needs: verify-ref
+    uses: Screenly/edge-apps-actions/.github/workflows/initialize.yml@v26.10.2
+    with:
+      environment: ${{ inputs.environment }}
+      edge_app_name: ${{ inputs.edge_app_name }}
+      edge_app_title: ${{ inputs.edge_app_title }}
+    secrets:
+      SCREENLY_API_TOKEN: ${{ secrets.SCREENLY_API_TOKEN }}

.github/workflows/initialize-rss-reader-app.yml

@@ -1,116 +1,94 @@
 ---
+# Creates a feed app (e.g. BBC News) in one environment. Add the app to
+# deployed-apps.yml first; this reads its name, description, icon and feed
+# from there, then runs the shared edge-apps-actions initialize. Afterwards,
+# put the new id in deployed-apps.yml so Update RSS Reader Apps deploys it.
 name: Initialize Custom RSS Reader App
 
 on:
   workflow_dispatch:
     inputs:
       environment:
-        description: 'Environment to initialize in (stage or production)'
+        description: 'Environment to initialize in'
         required: true
         default: 'stage'
         type: choice
         options:
           - stage
           - production
 
-      app_name:
-        description: 'App Name (used for instance title)'
+      app_key:
+        description: "App key in deployed-apps.yml (e.g. 'bbc-news')"
         required: true
         type: string
-        default: 'BBC News'
 
-      app_description:
-        description: 'App Description (used in manifest description)'
-        required: true
-        type: string
-        default: 'Latest news from BBC World Service'
-
-      rss_title:
-        description: 'RSS Title (title to display in the app)'
-        required: true
-        type: string
-        default: 'BBC News'
-
-      icon_url:
-        description: 'Icon URL (publicly accessible icon image)'
-        required: true
-        type: string
-        default: 'https://playground.srly.io/edge-apps/rss-reader/static/img/icon.svg'
-
-      rss_url:
-        description: 'RSS Feed URL'
-        required: true
-        type: string
-        default: 'http://feeds.bbci.co.uk/news/rss.xml'
+permissions:
+  contents: read
 
-run-name: Initialize RSS Reader - ${{ inputs.app_name }} in ${{ inputs.environment }}
+run-name: Initialize RSS Reader - ${{ inputs.app_key }} in ${{ inputs.environment }}
 
 jobs:
-  deploy:
-    name: Initializing ${{ inputs.app_name }} in ${{ inputs.environment }}
+  initialize:
+    name: Initialize ${{ inputs.app_key }} in ${{ inputs.environment }}
     runs-on: ubuntu-latest
     environment: ${{ inputs.environment }}
-    env:
-      API_BASE_URL: ${{ inputs.environment == 'stage' && 'https://api.screenlyappstage.com' || 'https://api.screenlyapp.com' }}
-      APP_NAME: ${{ inputs.app_name }}
-      SCREENLY_API_TOKEN: ${{ secrets.SCREENLY_API_TOKEN }}
-      MANIFEST_FILE_NAME: ${{ inputs.environment == 'stage' && 'screenly_qc.yml' || 'screenly.yml' }}
+    concurrency:
+      group: feed-app-${{ inputs.environment }}-${{ inputs.app_key }}
+      cancel-in-progress: false
 
     steps:
-      - name: Checkout Repository
-        uses: actions/checkout@v7
-        with:
-          ref: main
-
-      - name: Setup yq
-        uses: ./.github/actions/setup-yq
-
-      - name: Update manifest file with custom values
+      # The app is built from the ref this run starts on, so refuse anything
+      # but the default branch rather than creating it from unreleased code
+      - name: Require the default branch
+        env:
+          DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
         run: |
-          yq -i 'del(.id)' "$MANIFEST_FILE_NAME"
-          yq -i '.description = "${{ inputs.app_description }}"' "$MANIFEST_FILE_NAME"
-          yq -i '.icon = "${{ inputs.icon_url }}"' "$MANIFEST_FILE_NAME"
-          yq -i '.settings.rss_url.default_value = "${{ inputs.rss_url }}"' "$MANIFEST_FILE_NAME"
-          yq -i '.settings.rss_title.default_value = "${{ inputs.rss_title }}"' "$MANIFEST_FILE_NAME"
-
-      - name: Show updated manifest
-        run: cat "$MANIFEST_FILE_NAME"
-
-      - name: Set up Bun
-        uses: oven-sh/setup-bun@v2
-
-      - name: Install dependencies
-        run: bun install --frozen-lockfile
-
-      - name: Create Edge App
-        uses: screenly/cli@master
-        with:
-          screenly_api_token: ${{ env.SCREENLY_API_TOKEN }}
-          cli_commands: edge-app create --name="${{ env.APP_NAME }}" --in-place
-
-      - name: Build
-        run: bun run build
-
-      - name: Deploy Edge App
-        uses: screenly/cli@master
-        with:
-          screenly_api_token: ${{ env.SCREENLY_API_TOKEN }}
-          cli_commands: edge-app deploy --path="./dist"
+          if [ "$GITHUB_REF" != "refs/heads/$DEFAULT_BRANCH" ]; then
+            echo "::error::Run this from $DEFAULT_BRANCH, not $GITHUB_REF_NAME."
+            exit 1
+          fi
 
-      - name: Log manifest after creation
-        run: cat "dist/$MANIFEST_FILE_NAME"
+      - uses: actions/checkout@v7
 
-      - name: Create Instance
-        uses: screenly/cli@master
+      - name: Apply ${{ inputs.app_key }} config
+        id: config
+        uses: ./.github/actions/apply-feed-app
         with:
-          screenly_api_token: ${{ env.SCREENLY_API_TOKEN }}
-          cli_commands: edge-app instance create --name="${{ inputs.app_name }}"
+          app_key: ${{ inputs.app_key }}
+          environment: ${{ inputs.environment }}
 
-      - name: Update Instance
-        uses: screenly/cli@master
+      # Refuses to run if deployed-apps.yml already has an id for this
+      # environment, or if an app with this name already exists
+      - name: Initialize ${{ inputs.app_key }}
+        uses: Screenly/edge-apps-actions/initialize@v26.10.2
         with:
-          screenly_api_token: ${{ env.SCREENLY_API_TOKEN }}
-          cli_commands: edge-app instance update
-
-      - name: Log instance.yml
-        run: cat instance.yml
+          screenly_api_token: ${{ secrets.SCREENLY_API_TOKEN }}
+          environment: ${{ inputs.environment }}
+          edge_app_name: ${{ steps.config.outputs.app_name }}
+          edge_app_title: ${{ steps.config.outputs.app_name }}
+          edge_app_id: ${{ steps.config.outputs.edge_app_id }}
+
+      # The shared action's summary says to set a repo variable; feed apps
+      # keep their ids in deployed-apps.yml instead. Runs even if a later
+      # step failed, as long as the app was created.
+      - name: Report where the id goes
+        if: always()
+        env:
+          APP_KEY: ${{ inputs.app_key }}
+          ENVIRONMENT: ${{ inputs.environment }}
+        run: |
+          ID="$(grep -E '^id:[[:space:]]*' screenly.yml | head -1 | awk '{print $2}' | tr -d "\"'" || true)"
+          [ -n "$ID" ] || exit 0
+          echo "::notice::Feed app id: set apps.$APP_KEY.ids.$ENVIRONMENT to $ID in deployed-apps.yml (not a repo variable)."
+          {
+            echo "## Feed app id"
+            echo ""
+            echo "This is a feed app, so ignore the note above about repository variables. Set this in \`deployed-apps.yml\` and merge it:"
+            echo ""
+            echo '```yaml'
+            echo "apps:"
+            echo "  $APP_KEY:"
+            echo "    ids:"
+            echo "      $ENVIRONMENT: '$ID'"
+            echo '```'
+          } >> "$GITHUB_STEP_SUMMARY"