From 6b606ef434e79d84c8f5fc329fefdc78d434d5ce Mon Sep 17 00:00:00 2001 From: Mirko Hanke Date: Wed, 8 Sep 2021 15:43:20 -0500 Subject: [PATCH 01/14] define mkdocs publish workflow --- .github/workflows/main.yml | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 .github/workflows/main.yml diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 000000000..b86b9248c --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,31 @@ +name: Build Documentation using MkDocs + +# Controls when the action will run. Triggers the workflow on push +# events but only for the main branch +on: + push: + branches: [main] + + +jobs: + build: + name: Build and Deploy Documentation + runs-on: ubuntu-latest + steps: + - name: Checkout Main + uses: actions/checkout@v2 + + - name: Set up Python 3.7 + uses: actions/setup-python@v2 + with: + python-version: '3.x' + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install mkdocs-material + + - name: Deploy + run: | + git pull + mkdocs gh-deploy From 9e54e6b5ea7002380970837b66be91154bb65649 Mon Sep 17 00:00:00 2001 From: Mirko Hanke Date: Wed, 8 Sep 2021 15:47:00 -0500 Subject: [PATCH 02/14] install another plugin --- .github/workflows/main.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index b86b9248c..af71bdd7c 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -24,6 +24,7 @@ jobs: run: | python -m pip install --upgrade pip pip install mkdocs-material + pip install mkdocs-git-revision-date-localized-plugin - name: Deploy run: | From c98a1d57ccc3adc8720509796b18860248ee5509 Mon Sep 17 00:00:00 2001 From: Mirko Hanke Date: Wed, 8 Sep 2021 16:00:43 -0500 Subject: [PATCH 03/14] versioning with mike --- .github/workflows/main.yml | 4 +++- mkdocs.yml | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index af71bdd7c..2ea7d6152 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -25,8 +25,10 @@ jobs: python -m pip install --upgrade pip pip install mkdocs-material pip install mkdocs-git-revision-date-localized-plugin + pip install mike - name: Deploy run: | git pull - mkdocs gh-deploy +# mkdocs gh-deploy + mike deploy 2.0.0 latest diff --git a/mkdocs.yml b/mkdocs.yml index f2f2fccc7..e5aba4042 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -40,6 +40,8 @@ extra: social: - icon: fontawesome/brands/twitter link: 'https://twitter.com/islandora' + version: + provider: mike copyright: This documentation is user-sourced! Suggestions and comments are welcome in our issue queue. From 48e2f40309b9d07a48e8d6085fbc999dff763d6e Mon Sep 17 00:00:00 2001 From: Mirko Hanke Date: Wed, 8 Sep 2021 16:02:15 -0500 Subject: [PATCH 04/14] update --- .github/workflows/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 2ea7d6152..089ceee85 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -30,5 +30,5 @@ jobs: - name: Deploy run: | git pull -# mkdocs gh-deploy + # mkdocs gh-deploy mike deploy 2.0.0 latest From 8d19cce65bc5e9b9f586922735addeeebb304569 Mon Sep 17 00:00:00 2001 From: Mirko Hanke Date: Wed, 8 Sep 2021 16:07:02 -0500 Subject: [PATCH 05/14] update --- .github/workflows/main.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 089ceee85..3fa5bef50 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -29,6 +29,5 @@ jobs: - name: Deploy run: | - git pull - # mkdocs gh-deploy + git fetch origin gh-pages --depth=1 mike deploy 2.0.0 latest From 384ab0e8f77538034d570989b3415a1430483a5c Mon Sep 17 00:00:00 2001 From: Mirko Hanke Date: Wed, 8 Sep 2021 16:13:43 -0500 Subject: [PATCH 06/14] update --- .github/workflows/main.yml | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 3fa5bef50..b46bdb96d 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -14,7 +14,9 @@ jobs: steps: - name: Checkout Main uses: actions/checkout@v2 - + with: + fetch-depth: 0 # fetch all commits/branches + - name: Set up Python 3.7 uses: actions/setup-python@v2 with: @@ -27,6 +29,16 @@ jobs: pip install mkdocs-git-revision-date-localized-plugin pip install mike + - name: Set up git author + run: | + remote_repo="https://${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" + git config --global user.name "${GITHUB_ACTOR}" + git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com" + git remote rm origin + git remote add origin "${remote_repo}" + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + - name: Deploy run: | git fetch origin gh-pages --depth=1 From 61dccdfd88900686ac784d4e6fcef995c1b52379 Mon Sep 17 00:00:00 2001 From: Mirko Hanke Date: Wed, 8 Sep 2021 16:21:38 -0500 Subject: [PATCH 07/14] update --- .github/workflows/main.yml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index b46bdb96d..af228e5f4 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -34,12 +34,9 @@ jobs: remote_repo="https://${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" git config --global user.name "${GITHUB_ACTOR}" git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com" - git remote rm origin - git remote add origin "${remote_repo}" env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - name: Deploy run: | - git fetch origin gh-pages --depth=1 - mike deploy 2.0.0 latest + mike deploy --push main 2.0.0 latest From 8ded6c4e753fbba705d1fba244a8f754194637a9 Mon Sep 17 00:00:00 2001 From: Mirko Hanke Date: Wed, 8 Sep 2021 16:25:06 -0500 Subject: [PATCH 08/14] update --- .github/workflows/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index af228e5f4..c453e6e0b 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -39,4 +39,4 @@ jobs: - name: Deploy run: | - mike deploy --push main 2.0.0 latest + mike deploy --push --update-aliases 2.0.1 latest From c53e1045dddd6ef3b0ebbe93d9b87e2f58edbdca Mon Sep 17 00:00:00 2001 From: Mirko Hanke Date: Wed, 8 Sep 2021 16:27:52 -0500 Subject: [PATCH 09/14] update --- .github/workflows/main.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index c453e6e0b..0613b1bf1 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -39,4 +39,5 @@ jobs: - name: Deploy run: | - mike deploy --push --update-aliases 2.0.1 latest + mike deploy --push --update-aliases 2.0.0 latest + mike set-default latest From e19eb2b41732ee1c7ce905f72589dee385d60b9e Mon Sep 17 00:00:00 2001 From: Mirko Hanke Date: Wed, 8 Sep 2021 16:32:12 -0500 Subject: [PATCH 10/14] update --- .github/workflows/main.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 0613b1bf1..d29fa35a8 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -39,5 +39,6 @@ jobs: - name: Deploy run: | + mike delete --all mike deploy --push --update-aliases 2.0.0 latest mike set-default latest From aefda7eb8c094335518b794638e6e0f762b3bcdf Mon Sep 17 00:00:00 2001 From: Mirko Hanke Date: Wed, 8 Sep 2021 16:38:00 -0500 Subject: [PATCH 11/14] update --- .github/workflows/main.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index d29fa35a8..372ecd99f 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -39,6 +39,5 @@ jobs: - name: Deploy run: | - mike delete --all mike deploy --push --update-aliases 2.0.0 latest - mike set-default latest + mike set-default --push latest From 04fe34c8fe4bcaada18b994383ad53ddb60a2c7c Mon Sep 17 00:00:00 2001 From: Mirko Hanke Date: Wed, 8 Sep 2021 16:46:30 -0500 Subject: [PATCH 12/14] update --- .github/workflows/main.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 372ecd99f..4ff155899 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -1,4 +1,4 @@ -name: Build Documentation using MkDocs +name: Build Documentation using mike/MkDocs # Controls when the action will run. Triggers the workflow on push # events but only for the main branch @@ -39,5 +39,5 @@ jobs: - name: Deploy run: | - mike deploy --push --update-aliases 2.0.0 latest + mike deploy -b versioning-test --push --update-aliases 2.0.0 latest mike set-default --push latest From 196e9f2683a80f8d4cc67b978998b2b70c6fe8a4 Mon Sep 17 00:00:00 2001 From: Mirko Hanke Date: Wed, 8 Sep 2021 16:48:20 -0500 Subject: [PATCH 13/14] update --- .github/workflows/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 4ff155899..e919c3094 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -40,4 +40,4 @@ jobs: - name: Deploy run: | mike deploy -b versioning-test --push --update-aliases 2.0.0 latest - mike set-default --push latest + mike set-default -b versioning-test --push latest From e217d234723c15ad2ab3f9eddd987fa5c577ab92 Mon Sep 17 00:00:00 2001 From: Mirko Hanke Date: Wed, 13 Oct 2021 17:18:05 -0500 Subject: [PATCH 14/14] Update main.yml --- .github/workflows/main.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index e919c3094..a490cde8e 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -1,4 +1,4 @@ -name: Build Documentation using mike/MkDocs +name: Build Documentation using MkDocs # Controls when the action will run. Triggers the workflow on push # events but only for the main branch @@ -25,9 +25,10 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip + pip install mkdocs pip install mkdocs-material pip install mkdocs-git-revision-date-localized-plugin - pip install mike + # todo: add support for material for mkdocs insider theme - name: Set up git author run: | @@ -39,5 +40,4 @@ jobs: - name: Deploy run: | - mike deploy -b versioning-test --push --update-aliases 2.0.0 latest - mike set-default -b versioning-test --push latest + mkdocs gh-deploy -b github-actions-test