From be12339ce4d298259089d6f73834f43113f5d80f Mon Sep 17 00:00:00 2001 From: Kay Jan Date: Wed, 18 Oct 2023 10:29:36 +0800 Subject: [PATCH 01/12] Update docs.yml --- .github/workflows/docs.yml | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 45aec1d8..21a25266 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -37,15 +37,6 @@ jobs: publish_dir: docs/build/ force_orphan: true - name: Deploy to RTD - uses: actions/upload-artifact@v2 + uses: readthedocs/actions/preview@v1 with: - name: docs-${{ github.sha }} - path: docs/build/ - - name: Trigger RTDs build - uses: dfm/rtds-action@v1 - env: - GH_TOKEN: ${{ secrets.GH_TOKEN }} - with: - webhook_url: ${{ secrets.RTD_URL }} - webhook_token: ${{ secrets.RTD_TOKEN }} - commit_ref: ${{ github.ref }} + project-slug: bigtree From 68d55aa0dc1882408abf7ac7b4db3c5a0eca3a2b Mon Sep 17 00:00:00 2001 From: Kay Jan Date: Wed, 18 Oct 2023 10:32:15 +0800 Subject: [PATCH 02/12] Run docs on every push (temporarily) --- .github/workflows/docs.yml | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 21a25266..0e98b253 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,14 +1,6 @@ name: Docs -on: - push: - branches: - - master - workflow_run: - workflows: ["Upload Python Package"] - branches: [master] - types: - - completed +on: [push] jobs: setup: From 45c746e70558c2cbe0aff90ebfc3264ab684ad25 Mon Sep 17 00:00:00 2001 From: Kay Jan Date: Wed, 18 Oct 2023 10:44:07 +0800 Subject: [PATCH 03/12] Use another gha --- .github/workflows/docs.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 0e98b253..54bb6547 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -31,4 +31,6 @@ jobs: - name: Deploy to RTD uses: readthedocs/actions/preview@v1 with: - project-slug: bigtree + github-token: ${{ secrets.GH_TOKEN }} + rtd-token: ${{ secrets.RTD_TOKEN }} + rtd-project: bigtree From 26dd39853f6eff807bd2062f8a84e9832b5f8f20 Mon Sep 17 00:00:00 2001 From: Kay Jan Date: Wed, 18 Oct 2023 10:46:26 +0800 Subject: [PATCH 04/12] Update docs.yml --- .github/workflows/docs.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 54bb6547..3d3ecc96 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -2,6 +2,10 @@ name: Docs on: [push] +permissions: + pull-requests: write + checks: write + jobs: setup: runs-on: ubuntu-latest From 0fa09037482f88b63a4e6b408009716af819ebb8 Mon Sep 17 00:00:00 2001 From: Kay Jan Date: Wed, 18 Oct 2023 10:47:24 +0800 Subject: [PATCH 05/12] Update docs.yml --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 3d3ecc96..d13d5ce7 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -33,7 +33,7 @@ jobs: publish_dir: docs/build/ force_orphan: true - name: Deploy to RTD - uses: readthedocs/actions/preview@v1 + uses: KengoTODA/readthedocs-action@main with: github-token: ${{ secrets.GH_TOKEN }} rtd-token: ${{ secrets.RTD_TOKEN }} From 9d80fbe4a04f9b2f23469cb2fe73ceb3120a742d Mon Sep 17 00:00:00 2001 From: Kay Jan Date: Wed, 18 Oct 2023 11:04:02 +0800 Subject: [PATCH 06/12] Use rtd gha --- .github/workflows/docs.yml | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index d13d5ce7..4ab3011f 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -4,7 +4,6 @@ on: [push] permissions: pull-requests: write - checks: write jobs: setup: @@ -33,8 +32,6 @@ jobs: publish_dir: docs/build/ force_orphan: true - name: Deploy to RTD - uses: KengoTODA/readthedocs-action@main + uses: readthedocs/actions/preview@v1 with: - github-token: ${{ secrets.GH_TOKEN }} - rtd-token: ${{ secrets.RTD_TOKEN }} - rtd-project: bigtree + project-slug: bigtree From c3be28154b067adc26afb376ae545a1799624fa6 Mon Sep 17 00:00:00 2001 From: Kay Jan Date: Wed, 18 Oct 2023 11:52:36 +0800 Subject: [PATCH 07/12] Update docs.yml --- .github/workflows/docs.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 4ab3011f..a2149f38 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,6 +1,8 @@ name: Docs -on: [push] +on: + pull_request: + types: [opened, synchronize] permissions: pull-requests: write From adaccddfe5738c38f6dd3a36a442d71fd612b121 Mon Sep 17 00:00:00 2001 From: Kay Jan Date: Wed, 18 Oct 2023 12:11:43 +0800 Subject: [PATCH 08/12] Update docs.yml --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index a2149f38..6ec2597a 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,7 +1,7 @@ name: Docs on: - pull_request: + pull_request_target: types: [opened, synchronize] permissions: From ee437f7c1ce3f56c7b261bf2c360a84fc45d478f Mon Sep 17 00:00:00 2001 From: Kay Jan Date: Wed, 18 Oct 2023 12:45:02 +0800 Subject: [PATCH 09/12] Run on pull request --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 6ec2597a..a2149f38 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,7 +1,7 @@ name: Docs on: - pull_request_target: + pull_request: types: [opened, synchronize] permissions: From 861692a0bbf155ee9269bf0eaff8b197a283db3e Mon Sep 17 00:00:00 2001 From: Kay Date: Thu, 19 Oct 2023 02:22:46 +0800 Subject: [PATCH 10/12] Changed: Remove changes in docs --- docs/requirements.txt | 1 - docs/source/conf.py | 8 -------- 2 files changed, 9 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index a6865d91..2f1233ac 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,5 +2,4 @@ autodocsumm==0.2.9 karma-sphinx-theme==0.0.8 myst-parser==0.18.1 pandas==1.5.1 -rtds-action==1.1.0 sphinxemoji==0.2.0 diff --git a/docs/source/conf.py b/docs/source/conf.py index 80626a6e..272f83db 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -28,7 +28,6 @@ "myst_parser", "sphinxemoji.sphinxemoji", "sphinx.ext.mathjax", - "rtds_action", ] autodoc_default_options = {"autosummary": True} sphinxemoji_style = "twemoji" @@ -38,13 +37,6 @@ language = "Python" -# GitHub Action Integration -rtds_action_github_repo = "kayjan/bigtree" -rtds_action_path = "../build/" -rtds_action_artifact_prefix = "docs-" -rtds_action_github_token = os.getenv("GH_TOKEN", "") -rtds_action_error_if_missing = True - # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output From 9ca44e1a00d7dcc7390195dd8782db46f36d1800 Mon Sep 17 00:00:00 2001 From: Kay Jan Date: Thu, 19 Oct 2023 02:25:06 +0800 Subject: [PATCH 11/12] Update docs.yml --- .github/workflows/docs.yml | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index a2149f38..8fc2ac56 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,8 +1,14 @@ name: Docs on: - pull_request: - types: [opened, synchronize] + push: + branches: + - master + workflow_run: + workflows: ["Upload Python Package"] + branches: [master] + types: + - completed permissions: pull-requests: write From 603f28947c24c728c2fbf8301d6feedf4be0ff0d Mon Sep 17 00:00:00 2001 From: Kay Jan Date: Thu, 19 Oct 2023 02:28:19 +0800 Subject: [PATCH 12/12] Changed: Remove gha link to trigger rtd --- .github/workflows/docs.yml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 8fc2ac56..758d521e 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -39,7 +39,3 @@ jobs: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: docs/build/ force_orphan: true - - name: Deploy to RTD - uses: readthedocs/actions/preview@v1 - with: - project-slug: bigtree