From 14ca38a4d2759fc184c55a55fbcae5cb9d09309a Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Fri, 16 Jun 2023 10:16:11 +0000 Subject: [PATCH 1/2] restore gp-pages branch usage --- .github/workflows/docs.yml | 26 +++++++++----------------- 1 file changed, 9 insertions(+), 17 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 062a69e7f..8c98bfc03 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -8,12 +8,7 @@ jobs: docs: if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.repository runs-on: ubuntu-latest - permissions: - pages: write - id-token: write - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} + steps: - name: Avoid git conflicts when tag and branch pushed at same time if: startsWith(github.ref, 'refs/tags') @@ -48,15 +43,12 @@ jobs: - name: Write switcher.json run: python .github/pages/make_switcher.py --add $DOCS_VERSION ${{ github.repository }} .github/pages/switcher.json - - name: Setup Pages - uses: actions/configure-pages@v3 - - - name: Upload Pages artifact - uses: actions/upload-pages-artifact@v1.0.8 - with: - path: .github/pages - - - name: Publish docs to GitHub Pages + - name: Publish Docs to gh-pages if: github.event_name == 'push' && github.actor != 'dependabot[bot]' - id: deployment - uses: actions/deploy-pages@v2.0.1 + # We pin to the SHA, not the tag, for security reasons. + # https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions + uses: peaceiris/actions-gh-pages@373f7f263a76c20808c831209c920827a82a2847 # v3.9.3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: .github/pages + keep_files: true From 05f220557f264a646cc9466b4e8d1a7d275febd3 Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Fri, 16 Jun 2023 10:28:54 +0000 Subject: [PATCH 2/2] add a note on builder and template macro naming for args --- docs/user/reference/naming.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/user/reference/naming.rst b/docs/user/reference/naming.rst index 9ae87e9df..0c9384560 100644 --- a/docs/user/reference/naming.rst +++ b/docs/user/reference/naming.rst @@ -57,6 +57,17 @@ Args Every Arg also has a name and these should be snake_case as they represent class properties in Python. +HOWEVER: where these arguments refer to a database template macro, the original +name should be used. This means that no changes are required in the templates +in order to support the include_args feature. + +ADDITIONAL: because the above caveat breaks the naming convention. We will +maintain the historical naming from builder.py where support module has this +historical support. + +SUMMARY: only new modules will use the snake_case naming convention. Others +will use the historical adhoc naming conventions. + Functions ---------