From 9d84197aae61e353bc119a588f8f0b493c161ba9 Mon Sep 17 00:00:00 2001 From: Pierre Villemot Date: Wed, 13 Sep 2023 15:11:45 +0200 Subject: [PATCH 1/2] Deploy the documentation of the main branch --- .github/workflows/documentation.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index b9c146420..45e4c5892 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -19,7 +19,7 @@ env: jobs: # For any push and PR, build the documentation from the ocaml comments # If this build fails, the documentation workflow stops - # If it succed, an artifact is made with the generated documentation + # If it succeed, an artifact is made with the generated documentation # (html format only). This artifact is used in the deploying job ocaml_docs: name: OCaml documentation @@ -95,7 +95,7 @@ jobs: # On PR, or push on next/main, build the sphinx general documentation # If this build fails, the documentation workflow stops - # If it succed, an artifact is made with the generated documentation + # If it succeed, an artifact is made with the generated documentation # This artifact is used in the deploying job sphinx_docs: name: Sphinx documentation @@ -130,12 +130,12 @@ jobs: path: docs/sphinx_docs/_build - # For every push on next, retrieve ocaml and sphinx documentation + # For every push on main, retrieve ocaml and sphinx documentation # and publish them on gh-pages branch deploy_docs: name: Deploy documentation - if: github.ref == 'refs/heads/next' + if: github.ref == 'refs/heads/main' needs: - ocaml_docs From 55f61e80cdf506f91b60b98a3bb6a536b3d12e80 Mon Sep 17 00:00:00 2001 From: Pierre Villemot Date: Tue, 19 Sep 2023 10:56:18 +0200 Subject: [PATCH 2/2] Correct spelling --- .github/workflows/documentation.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 45e4c5892..3dabc0ef5 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -19,7 +19,7 @@ env: jobs: # For any push and PR, build the documentation from the ocaml comments # If this build fails, the documentation workflow stops - # If it succeed, an artifact is made with the generated documentation + # If it succeeds, an artifact is made with the generated documentation # (html format only). This artifact is used in the deploying job ocaml_docs: name: OCaml documentation @@ -95,7 +95,7 @@ jobs: # On PR, or push on next/main, build the sphinx general documentation # If this build fails, the documentation workflow stops - # If it succeed, an artifact is made with the generated documentation + # If it succeeds, an artifact is made with the generated documentation # This artifact is used in the deploying job sphinx_docs: name: Sphinx documentation