From ab49710d2145981291c00727c5b285e169f408af Mon Sep 17 00:00:00 2001 From: FrankLeeeee Date: Mon, 13 Feb 2023 15:25:31 +0800 Subject: [PATCH 01/10] [workflow] added doc build test --- .github/workflows/check_doc_on_pr.yml | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/.github/workflows/check_doc_on_pr.yml b/.github/workflows/check_doc_on_pr.yml index 5b3c4f6fbc6d..141189803551 100644 --- a/.github/workflows/check_doc_on_pr.yml +++ b/.github/workflows/check_doc_on_pr.yml @@ -21,3 +21,23 @@ jobs: python-version: '3.8.14' - run: python .github/workflows/scripts/check_doc_i18n.py -d docs/source + + check-doc-build: + name: Test if the docs can be built + if: | + github.event.pull_request.draft == false && + github.base_ref == 'main' && + github.event.pull_request.base.repo.full_name == 'hpcaitech/ColossalAI' + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + - uses: actions/checkout@v2 + repository: 'hpcaitech/ColossalAI-Documentation' + + - run: | + ls -la + + - uses: actions/setup-python@v2 + with: + python-version: '3.8.14' From 97338727a4423cf9e918dc5607443a391d30152d Mon Sep 17 00:00:00 2001 From: FrankLeeeee Date: Mon, 13 Feb 2023 15:26:17 +0800 Subject: [PATCH 02/10] polish code --- docs/test.sh | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/test.sh diff --git a/docs/test.sh b/docs/test.sh new file mode 100644 index 000000000000..e69de29bb2d1 From bb1cf7ebb7b995b748b8c2fbe14634087fee12fc Mon Sep 17 00:00:00 2001 From: FrankLeeeee Date: Mon, 13 Feb 2023 15:29:59 +0800 Subject: [PATCH 03/10] polish code --- .github/workflows/check_doc_on_pr.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/check_doc_on_pr.yml b/.github/workflows/check_doc_on_pr.yml index 141189803551..c046a00a0443 100644 --- a/.github/workflows/check_doc_on_pr.yml +++ b/.github/workflows/check_doc_on_pr.yml @@ -33,7 +33,8 @@ jobs: - uses: actions/checkout@v2 - uses: actions/checkout@v2 - repository: 'hpcaitech/ColossalAI-Documentation' + with: + repository: 'hpcaitech/ColossalAI-Documentation' - run: | ls -la From f45e659150c024176a0ae6a3394c90c03e774ffc Mon Sep 17 00:00:00 2001 From: FrankLeeeee Date: Mon, 13 Feb 2023 15:31:23 +0800 Subject: [PATCH 04/10] polish code --- .github/workflows/check_doc_on_pr.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/check_doc_on_pr.yml b/.github/workflows/check_doc_on_pr.yml index c046a00a0443..7752dc0911e0 100644 --- a/.github/workflows/check_doc_on_pr.yml +++ b/.github/workflows/check_doc_on_pr.yml @@ -38,6 +38,7 @@ jobs: - run: | ls -la + ls -la .. - uses: actions/setup-python@v2 with: From f78e8d0310b8ede7593203a808542c29c4914803 Mon Sep 17 00:00:00 2001 From: FrankLeeeee Date: Mon, 13 Feb 2023 15:40:12 +0800 Subject: [PATCH 05/10] polish code --- .github/workflows/check_doc_on_pr.yml | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/.github/workflows/check_doc_on_pr.yml b/.github/workflows/check_doc_on_pr.yml index 7752dc0911e0..868214c1565b 100644 --- a/.github/workflows/check_doc_on_pr.yml +++ b/.github/workflows/check_doc_on_pr.yml @@ -31,15 +31,32 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 + with: + path: './ColossalAI' - uses: actions/checkout@v2 with: + path: './ColossalAI-Documentation' repository: 'hpcaitech/ColossalAI-Documentation' + - uses: actions/setup-python@v2 + with: + python-version: '3.8.14' + - run: | ls -la ls -la .. - - uses: actions/setup-python@v2 - with: - python-version: '3.8.14' + - name: Make the merged branch main + run: | + cd ColossalAI + curBranch=$(git rev-parse --abbrev-ref HEAD) + git merge --strategy=ours main # keep the content of this branch, but record a merge + git checkout main + git merge $curBranch # fast-forward master up to the merge + + - name: Build docs + run: | + cache_dir=ColossalAI-Documentation/doc-build/.cache + mkdir $cache_dir + mv ColossalAI $cache_dir From ac03f078efcbb86c773026f76eee1f7b8cf7dfde Mon Sep 17 00:00:00 2001 From: FrankLeeeee Date: Mon, 13 Feb 2023 15:43:26 +0800 Subject: [PATCH 06/10] polish code --- .github/workflows/check_doc_on_pr.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/check_doc_on_pr.yml b/.github/workflows/check_doc_on_pr.yml index 868214c1565b..9713274cd8cf 100644 --- a/.github/workflows/check_doc_on_pr.yml +++ b/.github/workflows/check_doc_on_pr.yml @@ -51,7 +51,6 @@ jobs: run: | cd ColossalAI curBranch=$(git rev-parse --abbrev-ref HEAD) - git merge --strategy=ours main # keep the content of this branch, but record a merge git checkout main git merge $curBranch # fast-forward master up to the merge From 3a20fbe6f8483b37e91402f1b8e770ce76f63c94 Mon Sep 17 00:00:00 2001 From: FrankLeeeee Date: Mon, 13 Feb 2023 15:44:49 +0800 Subject: [PATCH 07/10] polish code --- .github/workflows/check_doc_on_pr.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/check_doc_on_pr.yml b/.github/workflows/check_doc_on_pr.yml index 9713274cd8cf..69a7c719045c 100644 --- a/.github/workflows/check_doc_on_pr.yml +++ b/.github/workflows/check_doc_on_pr.yml @@ -33,6 +33,7 @@ jobs: - uses: actions/checkout@v2 with: path: './ColossalAI' + fetch-depth: 0 - uses: actions/checkout@v2 with: From b1b26bcc64852a297d3049a4b573144aa32ddf6e Mon Sep 17 00:00:00 2001 From: FrankLeeeee Date: Mon, 13 Feb 2023 15:46:23 +0800 Subject: [PATCH 08/10] polish code --- .github/workflows/check_doc_on_pr.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/check_doc_on_pr.yml b/.github/workflows/check_doc_on_pr.yml index 69a7c719045c..1d6db3ccce3d 100644 --- a/.github/workflows/check_doc_on_pr.yml +++ b/.github/workflows/check_doc_on_pr.yml @@ -60,3 +60,5 @@ jobs: cache_dir=ColossalAI-Documentation/doc-build/.cache mkdir $cache_dir mv ColossalAI $cache_dir + pip install -v ./doc-build + bash ./scripts/build.sh From 8ee8e74d621a44e90f014f24bd35c68d601e52b3 Mon Sep 17 00:00:00 2001 From: FrankLeeeee Date: Mon, 13 Feb 2023 15:47:37 +0800 Subject: [PATCH 09/10] polish code --- .github/workflows/check_doc_on_pr.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/check_doc_on_pr.yml b/.github/workflows/check_doc_on_pr.yml index 1d6db3ccce3d..58525e27db86 100644 --- a/.github/workflows/check_doc_on_pr.yml +++ b/.github/workflows/check_doc_on_pr.yml @@ -60,5 +60,6 @@ jobs: cache_dir=ColossalAI-Documentation/doc-build/.cache mkdir $cache_dir mv ColossalAI $cache_dir + cd ColossalAI-Documentation pip install -v ./doc-build bash ./scripts/build.sh From 95dd6803e411bf0ca5a47e84b0faa13b484a1362 Mon Sep 17 00:00:00 2001 From: FrankLeeeee Date: Mon, 13 Feb 2023 15:53:59 +0800 Subject: [PATCH 10/10] polish code --- .github/workflows/check_doc_on_pr.yml | 3 +++ docs/test.sh | 0 2 files changed, 3 insertions(+) delete mode 100644 docs/test.sh diff --git a/.github/workflows/check_doc_on_pr.yml b/.github/workflows/check_doc_on_pr.yml index 58525e27db86..6e42053ddc08 100644 --- a/.github/workflows/check_doc_on_pr.yml +++ b/.github/workflows/check_doc_on_pr.yml @@ -48,6 +48,9 @@ jobs: ls -la ls -la .. + # we use the versions in the main branch as the guide for versions to display + # checkout will give your merged branch + # therefore, we need to make the merged branch as the main branch - name: Make the merged branch main run: | cd ColossalAI diff --git a/docs/test.sh b/docs/test.sh deleted file mode 100644 index e69de29bb2d1..000000000000