From 014cb73ecdbbae36212405bf081be68db5a303ba Mon Sep 17 00:00:00 2001 From: Padraig Gleeson Date: Mon, 2 Mar 2026 19:22:28 +0000 Subject: [PATCH 1/3] Add link to page linking to active repos --- docs/releases.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/releases.md b/docs/releases.md index 24df2c6d..d7d2fbb8 100644 --- a/docs/releases.md +++ b/docs/releases.md @@ -3,6 +3,7 @@ Current releases The recent and planned releases for the Docker image which contains the assembled OpenWorm software stack can be found at the [OpenWorm Milestones](https://github.com/openworm/OpenWorm/milestones). +**An overview of the core repositories in the project, along with the current status of automated testing, can be found [here](https://github.com/openworm/.github/blob/main/testsheet/README.md).** Past Releases From 6b91e98391304103ed2bc385269998f875a6e16e Mon Sep 17 00:00:00 2001 From: Padraig Gleeson Date: Mon, 2 Mar 2026 19:24:07 +0000 Subject: [PATCH 2/3] Update: actions/upload-artifact@v4 --- .github/workflows/mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml index 53cec3c9..72217d3b 100644 --- a/.github/workflows/mkdocs.yml +++ b/.github/workflows/mkdocs.yml @@ -53,7 +53,7 @@ jobs: - name: Archive production artifacts if: github.ref == 'refs/heads/master' - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v4 with: name: built-site path: site From 6ea463e6fce3dda7cb77c78090a39825ae8ad5d1 Mon Sep 17 00:00:00 2001 From: Padraig Gleeson Date: Mon, 2 Mar 2026 19:30:34 +0000 Subject: [PATCH 3/3] Use workflow from integrate-design-documents branch --- .github/workflows/mkdocs.yml | 93 +++++++++++++++++++++++++++++++++++- 1 file changed, 92 insertions(+), 1 deletion(-) diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml index 72217d3b..31500c05 100644 --- a/.github/workflows/mkdocs.yml +++ b/.github/workflows/mkdocs.yml @@ -4,12 +4,18 @@ on: branches: [ master, development ] pull_request: branches: [ master, development ] + types: [ opened, synchronize, reopened, closed ] + +permissions: + contents: write + pull-requests: write env: REPO_METADATA_SHAS: repo-metadata-shas.txt jobs: build: + if: github.event.action != 'closed' runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 @@ -21,7 +27,7 @@ jobs: timeout_minutes: 15 command: | sudo apt-get update - sudo apt-get install -yqq build-essential libxml2-dev zlib1g-dev bison flex + sudo apt-get install -yqq build-essential libxml2-dev zlib1g-dev bison flex libcairo2-dev pkg-config - name: Set up Python install env run: | @@ -51,6 +57,68 @@ jobs: export GITHUB_TOKEN=${{ github.token }} make build + - name: Deploy branch preview + if: github.event_name == 'pull_request' + run: | + BRANCH_NAME="${{ github.head_ref }}" + SAFE_BRANCH=$(echo "$BRANCH_NAME" | sed 's/[^a-zA-Z0-9-]/-/g') + + . venv/bin/activate + + # Build with site_url set so navigation works in subdirectory + cat > mkdocs-preview.yml << EOF + INHERIT: mkdocs.yml + site_url: https://docs.openworm.org/preview/$SAFE_BRANCH/ + EOF + python -m mkdocs build -f mkdocs-preview.yml --site-dir /tmp/site_preview + + # Push to gh-pages under preview// + git fetch origin gh-pages:gh-pages + git config user.name github-actions + git config user.email github-actions@github.com + git checkout gh-pages + + mkdir -p preview/$SAFE_BRANCH + rm -rf preview/$SAFE_BRANCH/* + cp -r /tmp/site_preview/* preview/$SAFE_BRANCH/ + + git add preview/$SAFE_BRANCH + git commit -m "Deploy preview: $BRANCH_NAME @ ${GITHUB_SHA::7} [ci skip]" || echo "No changes to commit" + git remote set-url origin https://${{ github.token }}@github.com/${{ github.repository_owner }}/openworm_docs.git + git push origin gh-pages + + - name: Comment preview URL on PR + if: github.event_name == 'pull_request' + uses: actions/github-script@v7 + with: + script: | + const branch = '${{ github.head_ref }}'.replace(/[^a-zA-Z0-9-]/g, '-'); + const url = `https://docs.openworm.org/preview/${branch}/`; + const marker = ''; + const body = `${marker}\n**Preview:** ${url}`; + + const { data: comments } = await github.rest.issues.listComments({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: context.issue.number, + }); + const existing = comments.find(c => c.body.includes(marker)); + if (existing) { + await github.rest.issues.updateComment({ + owner: context.repo.owner, + repo: context.repo.repo, + comment_id: existing.id, + body, + }); + } else { + await github.rest.issues.createComment({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: context.issue.number, + body, + }); + } + - name: Archive production artifacts if: github.ref == 'refs/heads/master' uses: actions/upload-artifact@v4 @@ -87,3 +155,26 @@ jobs: git remote set-url origin https://${{ github.token }}@github.com/${{ github.repository_owner }}/openworm_docs.git git push -f origin gh-pages fi + + cleanup-preview: + if: github.event_name == 'pull_request' && github.event.action == 'closed' + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Remove preview from gh-pages + run: | + BRANCH_NAME="${{ github.head_ref }}" + SAFE_BRANCH=$(echo "$BRANCH_NAME" | sed 's/[^a-zA-Z0-9-]/-/g') + + git fetch origin gh-pages:gh-pages + git config user.name github-actions + git config user.email github-actions@github.com + git checkout gh-pages + + if [ -d "preview/$SAFE_BRANCH" ]; then + rm -rf preview/$SAFE_BRANCH + git add -A preview/ + git commit -m "Remove preview: $BRANCH_NAME [ci skip]" + git remote set-url origin https://${{ github.token }}@github.com/${{ github.repository_owner }}/openworm_docs.git + git push origin gh-pages + fi