From 255195808b1f1059181b9cec4eb1c7848ec4ba69 Mon Sep 17 00:00:00 2001 From: Eduard Kerkhoven Date: Tue, 3 Nov 2026 17:49:17 +0100 Subject: [PATCH] Add the develop branch to the workflows The submodule update commits to develop, and the documentation build and the examples run on pushes to develop. CONTRIBUTING.md describes the branches. --- .github/workflows/docs-build.yml | 2 +- .github/workflows/examples.yml | 2 +- .github/workflows/update-submodules.yml | 7 ++++--- CONTRIBUTING.md | 4 ++++ DESIGN.md | 4 ++-- 5 files changed, 12 insertions(+), 7 deletions(-) diff --git a/.github/workflows/docs-build.yml b/.github/workflows/docs-build.yml index 5e7d083..7c9bf57 100644 --- a/.github/workflows/docs-build.yml +++ b/.github/workflows/docs-build.yml @@ -6,7 +6,7 @@ name: Docs build on: push: - branches: [main] + branches: [main, develop] pull_request: schedule: - cron: "0 6 * * 1" diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml index efc599c..02e73f1 100644 --- a/.github/workflows/examples.yml +++ b/.github/workflows/examples.yml @@ -10,7 +10,7 @@ name: Guide examples on: push: - branches: [main] + branches: [main, develop] paths: - "docs/guide/**" - "docs/data/**" diff --git a/.github/workflows/update-submodules.yml b/.github/workflows/update-submodules.yml index 369603b..1c3e6d8 100644 --- a/.github/workflows/update-submodules.yml +++ b/.github/workflows/update-submodules.yml @@ -1,7 +1,7 @@ name: Update submodules # Moves each submodule to the tip of the branch set in .gitmodules and commits -# the new pointers to main. +# the new pointers to develop. on: schedule: @@ -21,6 +21,7 @@ jobs: steps: - uses: actions/checkout@v7 with: + ref: develop submodules: true fetch-depth: 1 @@ -37,7 +38,7 @@ jobs: git checkout -B "$branch" FETCH_HEAD ' - - name: Commit to main + - name: Commit to develop run: | if git diff --quiet; then echo "No submodule updates." @@ -47,4 +48,4 @@ jobs: git config user.email "41898282+github-actions[bot]@users.noreply.github.com" git add -A git commit -m "chore: update submodules to latest tracked branches" - git push origin HEAD:main + git push origin HEAD:develop diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index efbcd8b..11a9341 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,6 +12,10 @@ The standard for this site is the `docs-site` plugin of [CompMetEng/skills](http 3. Established technical shorthand (a domain term, a standard abbreviation) stays. 4. No mention of AI tools or AI authorship in the repository: not in commits, pull requests, code comments or pages. Branch names do not contain a tool name. +## Branches + +`develop` is the default branch. It documents the `develop` branches of RAVEN and raven-toolbox, which the submodules track, and a daily workflow moves the submodule pointers to their tips. Pull requests target `develop`. `main` documents the released versions: a release of RAVEN and raven-toolbox is followed by a pull request from `develop` to `main` that is merged with a merge commit and pins the submodules to the released commits. + ## Building and checking ```bash diff --git a/DESIGN.md b/DESIGN.md index 9a110c7..5299988 100644 --- a/DESIGN.md +++ b/DESIGN.md @@ -3,7 +3,7 @@ > **This is a living document, and it is the source of intent.** It describes how > the RAVEN documentation site *should* be designed and what it *should* > contain; it is a set of instructions, not a description of the current state -> of `main`. When the site and this document disagree, treat this document as +> of `develop`. When the site and this document disagree, treat this document as > the target and bring the site in line (not the other way round). Keep it > updated as decisions are made; record new decisions in the decisions log and > move resolved items out of "open questions". @@ -15,7 +15,7 @@ > > ```bash > git fetch --all --prune -> git checkout main && git pull --ff-only +> git checkout develop && git pull --ff-only > git submodule sync --recursive > git submodule update --init --recursive > ```