Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ name: Docs build

on:
push:
branches: [main]
branches: [main, develop]
pull_request:
schedule:
- cron: "0 6 * * 1"
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/examples.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ name: Guide examples

on:
push:
branches: [main]
branches: [main, develop]
paths:
- "docs/guide/**"
- "docs/data/**"
Expand Down
7 changes: 4 additions & 3 deletions .github/workflows/update-submodules.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -21,6 +21,7 @@ jobs:
steps:
- uses: actions/checkout@v7
with:
ref: develop
submodules: true
fetch-depth: 1

Expand All @@ -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."
Expand All @@ -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
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions DESIGN.md
Original file line number Diff line number Diff line change
Expand Up @@ -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".
Expand All @@ -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
> ```
Expand Down
Loading