From f66263d859e26058076d5060537fe1fddb8fc981 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9goire=20Paris?= Date: Sat, 2 Sep 2023 19:01:46 +0200 Subject: [PATCH 1/3] Remove output directory argument It is no actually necessary at all. --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 242bf81fe82..8bfbad2676f 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -48,4 +48,4 @@ jobs: printf '%s\n%s\n\n%s\n' "Dummy title" "===========" "$(cat docs/en/sidebar.rst)" > docs/en/sidebar.rst - name: "Run guides-cli" - run: "vendor/bin/guides -vvv --no-progress docs/en /tmp/test 2>&1 | ( ! grep WARNING )" + run: "vendor/bin/guides -vvv --no-progress docs/en 2>&1 | ( ! grep WARNING )" From 816ecc6d6bd006e1699fef75f93943bca0b33933 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9goire=20Paris?= Date: Sat, 2 Sep 2023 19:02:59 +0200 Subject: [PATCH 2/3] Use a stable release 0.1.0 has been published 3 weeks ago. This means we no longer need to use dev stability --- .github/workflows/documentation.yml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 8bfbad2676f..11f94fcc5f2 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -33,10 +33,7 @@ jobs: run: "rm composer.json" - name: "Require phpdocumentor/guides-cli" - run: "composer require --dev phpdocumentor/guides-cli dev-main@dev --no-update" - - - name: "Configure minimum stability" - run: "composer config minimum-stability dev" + run: "composer require --dev phpdocumentor/guides-cli --no-update" - name: "Install dependencies with Composer" uses: "ramsey/composer-install@v2" From 0628204b436b81ca82ed525c0ab0dae66e9e1802 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9goire=20Paris?= Date: Sat, 2 Sep 2023 19:12:15 +0200 Subject: [PATCH 3/3] Ignore "Unknown directive" error We have a lot of errors about "Unknown directive" that we should make known when implementing guides for Doctrine, but cannot address by modifying the docs. The unknown directives are: - configuration-block - toc - tocheader - sectionauthor --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 11f94fcc5f2..a41e7de9516 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -45,4 +45,4 @@ jobs: printf '%s\n%s\n\n%s\n' "Dummy title" "===========" "$(cat docs/en/sidebar.rst)" > docs/en/sidebar.rst - name: "Run guides-cli" - run: "vendor/bin/guides -vvv --no-progress docs/en 2>&1 | ( ! grep WARNING )" + run: "vendor/bin/guides -vvv --no-progress docs/en 2>&1 | grep -v 'Unknown directive' | ( ! grep WARNING )"