Skip to content

Submodule auto-bump GitHub Action for external/onflow-docs #300

Description

@Aliserag

Phase 6.2 F-016 manually bumped external/onflow-docs from a 75-day-old commit to current main. Without an automation, the pin will silently go stale again — the federated search results in /api/search (F-012) will drift behind developers.flow.com.

Goal

Open an auto-PR monthly when onflow/docs/main advances past the current pin. Reviewers approve/merge if compatible.

Implementation sketch

.github/workflows/bump-onflow-docs.yml:

on:
  schedule: [{ cron: '0 9 1 * *' }]   # 1st of each month, 09:00 UTC
  workflow_dispatch:

jobs:
  bump:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with: { submodules: recursive, token: ${{ secrets.GH_PAT }} }
      - run: |
          cd external/onflow-docs && git fetch origin main && git checkout origin/main
          cd ../.. && git submodule status > /tmp/status.txt
      - uses: peter-evans/create-pull-request@v6
        with:
          branch: auto/bump-onflow-docs
          title: 'chore: bump external/onflow-docs submodule'
          body: |
            Automated monthly submodule refresh.
            See pr285-evaluation/findings.md F-016 follow-up.

Risks

  • Breaking changes in upstream onflow-docs structure could break the federated search index
  • Mitigation: PR triggers Vercel preview; manual review checks search results before merge

Alternative

Quarterly manual bump documented in CLAUDE.md (lower-effort, higher-drift).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions