From e4bbfb3f352cb5b5fb46e4b80019c3c7b105858a Mon Sep 17 00:00:00 2001 From: Sander Ploegsma Date: Mon, 22 Jan 2024 21:34:20 +0100 Subject: [PATCH 01/15] Update README --- README.md | 40 +++++++++++++++++++++++++++++++++------- 1 file changed, 33 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 73727635..ffc69d01 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,42 @@ # java-analyzer -The Java track project-auto-mentor analyzer using abstract syntax trees +The Java analyzer uses [Abstract Syntax Trees][ast-wiki] (ASTs) to analyze submitted solutions using the [`javaparser`][javaparser] library. +## Usage -## Running in docker +### Running directly -To analyze a solution in docker, -1. Build the image +Start by building the JAR using Gradle: + +```sh +./gradlew build ``` -docker build -t exercism/java-analyzer . + +Then, run the Java analyzer using `build/libs/java-analyzer.jar`. +For example, to analyze a solution for the `leap` exercise, run: + +```sh +java -jar build/libs/java-analyzer.jar leap /path/to/leap/ /path/to/output/folder/ ``` -2. Run the image + +The analyzer output is written to `analysis.json` and `tags.json` in `/path/to/output/folder/`. + +### Running with Docker + +To run the Java analyzer using Docker, first build and tag the Docker image: + +```sh +docker build -t exercism/java-analyzer . ``` -docker run -v <~/a/local/solution>:/solution exercism/java-analyzer /solution + +Then, run the image and mount the directory of the solution to analyze. +For example, to analyze a solution for the `leap` exercise located at `~/exercism/java/leap`, run: + +```sh +docker run -v /path/to/leap:/input -v /path/to/output/folder:/output exercism/java-analyzer leap /input/ /output/ ``` + +The analyzer output is written to `analysis.json` and `tags.json` in `/path/to/output/folder/`. + +[ast-wiki]: https://en.wikipedia.org/wiki/Abstract_syntax_tree +[javaparser]: https://github.com/javaparser/javaparser \ No newline at end of file From 234a1482d1ac7f9b96466d56612f6600edb04063 Mon Sep 17 00:00:00 2001 From: Sander Ploegsma Date: Mon, 22 Jan 2024 21:34:30 +0100 Subject: [PATCH 02/15] Add CONTRIBUTING.md --- CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..208a1437 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,39 @@ +# Contributing + +Thank you so much for contributing! 🎉 + +We welcome contributions of all sorts and sizes, from reporting issues to submitting patches, as well as joining discussions on the [Java forum][java-forum]. + +Unprompted (without an issue) PRs with small bugfixes are welcome. +However, if you want to propose bigger changes, make sure to post on the [forum][java-forum] first so that we can discuss it. + +## Code of Conduct + +Help us keep Exercism welcoming. +Please read and abide by the [Code of Conduct][coc]. + +## How does this project work? + +Start by reading up on Exercism analyzers: + +- [The analyzer interface][analyzer-docs-interface] +- [Guidance on implementing analyzers][analyzer-docs-guidance] + +To learn how the Java Analyzer works: + +- Browse [existing exercise analyzer implementations][browse-analyzers]. + +### Writing comments + +All the Analyzer comments for all tracks are stored together in [exercism/website-copy][analyzer-comments]. +When adding a new Analyzer check with a new comment, you need to open a corresponding PR in [exercism/website-copy][analyzer-comments] with that comment's content. + +See [the Analyzer comment guidelines][analyzer-comments-guidelines] for guidance on how to write friendly and constructive Analyzer comments. + +[coc]: https://github.com/exercism/java-analyzer/blob/main/CODE_OF_CONDUCT.md +[analyzer-comments]: https://github.com/exercism/website-copy/tree/main/analyzer-comments +[analyzer-comments-guidelines]: https://exercism.org/docs/building/tooling/analyzers/comments +[java-forum]: https://forum.exercism.org/c/programming/java/91 +[browse-analyzers]: https://github.com/exercism/java-analyzer/tree/main/src/main/java/analyzer/exercises/ +[analyzer-docs-guidance]: https://exercism.org/docs/building/tooling/analyzers/guidance +[analyzer-docs-interface]: https://exercism.org/docs/building/tooling/analyzers/interface \ No newline at end of file From c29841d2e598039bd387524cafdcaf09e2fd8deb Mon Sep 17 00:00:00 2001 From: Sander Ploegsma Date: Mon, 22 Jan 2024 21:43:31 +0100 Subject: [PATCH 03/15] Link to Exercism docs in CONTRIBUTING.md --- CONTRIBUTING.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 208a1437..5f26b043 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,6 +12,13 @@ However, if you want to propose bigger changes, make sure to post on the [forum] Help us keep Exercism welcoming. Please read and abide by the [Code of Conduct][coc]. +## Contributing to Exercism + +If you are new to contributing to Exercism, please read: + +- [Being a good community member][community-docs] +- [Contributing via GitHub][contributing-docs-github] + ## How does this project work? Start by reading up on Exercism analyzers: @@ -36,4 +43,6 @@ See [the Analyzer comment guidelines][analyzer-comments-guidelines] for guidance [java-forum]: https://forum.exercism.org/c/programming/java/91 [browse-analyzers]: https://github.com/exercism/java-analyzer/tree/main/src/main/java/analyzer/exercises/ [analyzer-docs-guidance]: https://exercism.org/docs/building/tooling/analyzers/guidance -[analyzer-docs-interface]: https://exercism.org/docs/building/tooling/analyzers/interface \ No newline at end of file +[analyzer-docs-interface]: https://exercism.org/docs/building/tooling/analyzers/interface +[community-docs]: https://exercism.org/docs/community/being-a-good-community-member +[contributing-docs-github]: https://exercism.org/docs/building/github From df182d8e83e138a1105f7b2c171a0d0f633207cf Mon Sep 17 00:00:00 2001 From: Sander Ploegsma Date: Mon, 22 Jan 2024 21:43:41 +0100 Subject: [PATCH 04/15] Link to contributing guide in README --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index ffc69d01..9f850db3 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ The Java analyzer uses [Abstract Syntax Trees][ast-wiki] (ASTs) to analyze submitted solutions using the [`javaparser`][javaparser] library. +## Contributing + +If you want to contribute to the Java analyzer, please refer to the [Contributing Guide][contributing-guide]. + ## Usage ### Running directly @@ -38,5 +42,24 @@ docker run -v /path/to/leap:/input -v /path/to/output/folder:/output exercism/ja The analyzer output is written to `analysis.json` and `tags.json` in `/path/to/output/folder/`. +## Tests + +### Unit tests + +To run the unit tests: + +```sh +./gradlew test +``` + +### Smoke tests + +To run the smoke tests using Docker: + +```sh +bin/run-tests-in-docker.sh +``` + [ast-wiki]: https://en.wikipedia.org/wiki/Abstract_syntax_tree +[contributing-guide]: https://github.com/exercism/java-analyzer/blob/main/CONTRIBUTING.md [javaparser]: https://github.com/javaparser/javaparser \ No newline at end of file From c1e0661e21fec448bd121b6ff611992a30a2e6fc Mon Sep 17 00:00:00 2001 From: Sander Ploegsma Date: Mon, 22 Jan 2024 21:51:13 +0100 Subject: [PATCH 05/15] Add GHA workflow to deploy Javadoc to GitHub Pages --- .github/workflows/pages.yml | 38 +++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .github/workflows/pages.yml diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml new file mode 100644 index 00000000..8049558e --- /dev/null +++ b/.github/workflows/pages.yml @@ -0,0 +1,38 @@ +name: GitHub Pages + +on: + push: +# TODO: uncomment before merging +# branches: +# - main + +jobs: + build: + name: Build Javadoc + runs-on: ubuntu-22.04 + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 + - uses: actions/setup-java@387ac29b308b003ca37ba93a6cab5eb57c8f5f93 + with: + java-version: "21" + distribution: "temurin" + - run: ./gradlew --no-daemon javadoc + - uses: actions/upload-pages-artifact@0252fc4ba7626f0298f0cf00902a25c6afc77fa8 + with: + path: build/docs/javadoc + + deploy: + needs: build + permissions: + pages: write + id-token: write + + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + runs-on: ubuntu-22.04 + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@87c3283f01cd6fe19a0ab93a23b2f6fcba5a8e42 From d938b84e79dc007d18e933161241df034abd56c8 Mon Sep 17 00:00:00 2001 From: Sander Ploegsma Date: Mon, 22 Jan 2024 21:57:04 +0100 Subject: [PATCH 06/15] Add names to GHA job steps --- .github/workflows/pages.yml | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 8049558e..777a8254 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -11,26 +11,29 @@ jobs: name: Build Javadoc runs-on: ubuntu-22.04 steps: - - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 - - uses: actions/setup-java@387ac29b308b003ca37ba93a6cab5eb57c8f5f93 + - name: Checkout + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 + - name: Set up JDK + uses: actions/setup-java@387ac29b308b003ca37ba93a6cab5eb57c8f5f93 with: java-version: "21" distribution: "temurin" - - run: ./gradlew --no-daemon javadoc - - uses: actions/upload-pages-artifact@0252fc4ba7626f0298f0cf00902a25c6afc77fa8 + - name: Build Javadoc + run: ./gradlew --no-daemon javadoc + - name: Upload artifact + uses: actions/upload-pages-artifact@0252fc4ba7626f0298f0cf00902a25c6afc77fa8 with: path: build/docs/javadoc deploy: + name: Deploy to GitHub Pages needs: build permissions: pages: write id-token: write - environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} - runs-on: ubuntu-22.04 steps: - name: Deploy to GitHub Pages From a4da349555b8600aa49fb9b3c5d77ce37bd19f05 Mon Sep 17 00:00:00 2001 From: Sander Ploegsma Date: Tue, 23 Jan 2024 09:34:55 +0100 Subject: [PATCH 07/15] Add mkdocs plugin --- build.gradle | 13 ++++++++++++- docs/index.md | 3 +++ mkdocs.yml | 21 +++++++++++++++++++++ 3 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/build.gradle b/build.gradle index a88d0123..570abc8f 100644 --- a/build.gradle +++ b/build.gradle @@ -1,7 +1,8 @@ plugins { - id "com.github.johnrengelman.shadow" version "8.1.1" id "java" id "application" + id "com.github.johnrengelman.shadow" version "8.1.1" + id "ru.vyarus.mkdocs-build" version '3.0.0' } group = "org.exercism" @@ -39,3 +40,13 @@ test { events = ["passed", "failed", "skipped"] } } + +python { + scope = USER +} + +mkdocs { + sourcesDir = "." + buildDir = "build/docs/mkdocs" + publish.docPath = null +} diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..a07f7e84 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,3 @@ +# Index + +Welcome to the Exercism Java analyzer documentation! 👋 diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..c48f1dc0 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,21 @@ +site_name: Exercism Java analyzer + +site_description: Documentation for the Exercism Java analyzer +site_url: https://exercism.github.io/java-analyzer + +repo_name: java-analyzer +repo_url: https://github.com/exercism/java-analyzer +edit_uri: blob/main/docs/ + +copyright: 'Copyright © 2024 Exercism' + +markdown_extensions: + - admonition + - fenced_code + - footnotes + - tables + - toc: + permalink: true + +nav: + - Home: index.md From 4cc529d99464d60533ab5bbd2d372dd0a66b3965 Mon Sep 17 00:00:00 2001 From: Sander Ploegsma Date: Tue, 23 Jan 2024 09:46:56 +0100 Subject: [PATCH 08/15] Add material plugin --- docs/contributing.md | 1 + docs/index.md | 2 +- mkdocs.yml | 21 +++++++++++++++++++++ 3 files changed, 23 insertions(+), 1 deletion(-) create mode 120000 docs/contributing.md diff --git a/docs/contributing.md b/docs/contributing.md new file mode 120000 index 00000000..44fcc634 --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1 @@ +../CONTRIBUTING.md \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index a07f7e84..9d2230a6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,3 @@ -# Index +# Welcome to exercism/java-analyzer Welcome to the Exercism Java analyzer documentation! 👋 diff --git a/mkdocs.yml b/mkdocs.yml index c48f1dc0..cc813ce1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,6 +9,26 @@ edit_uri: blob/main/docs/ copyright: 'Copyright © 2024 Exercism' +theme: + name: material + palette: + # Palette toggle for light mode + - scheme: default + toggle: + icon: material/brightness-7 + name: Switch to dark mode + # Palette toggle for dark mode + - scheme: slate + toggle: + icon: material/brightness-4 + name: Switch to light mode + features: + - navigation.path + - navigation.tabs + - navigation.tabs.sticky + - navigation.top + - navigation.tracking + markdown_extensions: - admonition - fenced_code @@ -19,3 +39,4 @@ markdown_extensions: nav: - Home: index.md + - contributing.md From aa5024a891d0d1064cfc1560fbb26bf96f97ec33 Mon Sep 17 00:00:00 2001 From: Sander Ploegsma Date: Tue, 23 Jan 2024 10:16:12 +0100 Subject: [PATCH 09/15] Build docs + javadoc into one folder --- .github/workflows/pages.yml | 10 +++++++--- build.gradle | 9 +++++++-- docs/contributing.md | 1 - src/doc/docs/contributing.md | 1 + {docs => src/doc/docs}/index.md | 0 mkdocs.yml => src/doc/mkdocs.yml | 3 ++- 6 files changed, 17 insertions(+), 7 deletions(-) delete mode 120000 docs/contributing.md create mode 120000 src/doc/docs/contributing.md rename {docs => src/doc/docs}/index.md (100%) rename mkdocs.yml => src/doc/mkdocs.yml (93%) diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 777a8254..c8e931c3 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -18,12 +18,16 @@ jobs: with: java-version: "21" distribution: "temurin" - - name: Build Javadoc - run: ./gradlew --no-daemon javadoc + - name: Set up Python + uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c + with: + python-version: "3.12" + - name: Build documentation + run: ./gradlew --no-daemon clean mkdocsBuild javadoc - name: Upload artifact uses: actions/upload-pages-artifact@0252fc4ba7626f0298f0cf00902a25c6afc77fa8 with: - path: build/docs/javadoc + path: build/docs deploy: name: Deploy to GitHub Pages diff --git a/build.gradle b/build.gradle index 570abc8f..5c99f84d 100644 --- a/build.gradle +++ b/build.gradle @@ -46,7 +46,12 @@ python { } mkdocs { - sourcesDir = "." - buildDir = "build/docs/mkdocs" + sourcesDir = "src/doc" + buildDir = file("build/docs") publish.docPath = null } + +javadoc { + mustRunAfter(mkdocsBuild) + destinationDir = file("build/docs/api") +} diff --git a/docs/contributing.md b/docs/contributing.md deleted file mode 120000 index 44fcc634..00000000 --- a/docs/contributing.md +++ /dev/null @@ -1 +0,0 @@ -../CONTRIBUTING.md \ No newline at end of file diff --git a/src/doc/docs/contributing.md b/src/doc/docs/contributing.md new file mode 120000 index 00000000..c97564d9 --- /dev/null +++ b/src/doc/docs/contributing.md @@ -0,0 +1 @@ +../../../CONTRIBUTING.md \ No newline at end of file diff --git a/docs/index.md b/src/doc/docs/index.md similarity index 100% rename from docs/index.md rename to src/doc/docs/index.md diff --git a/mkdocs.yml b/src/doc/mkdocs.yml similarity index 93% rename from mkdocs.yml rename to src/doc/mkdocs.yml index cc813ce1..f41a676b 100644 --- a/mkdocs.yml +++ b/src/doc/mkdocs.yml @@ -5,7 +5,7 @@ site_url: https://exercism.github.io/java-analyzer repo_name: java-analyzer repo_url: https://github.com/exercism/java-analyzer -edit_uri: blob/main/docs/ +edit_uri: blob/main/docs/src/ copyright: 'Copyright © 2024 Exercism' @@ -40,3 +40,4 @@ markdown_extensions: nav: - Home: index.md - contributing.md + - API: /java-analyzer/api From 745fac2f7ab1ec1622998451220abdc4094b7214 Mon Sep 17 00:00:00 2001 From: Sander Ploegsma Date: Tue, 23 Jan 2024 10:34:30 +0100 Subject: [PATCH 10/15] Build docs always; publish only from main --- .github/workflows/{pages.yml => docs.yml} | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) rename .github/workflows/{pages.yml => docs.yml} (84%) diff --git a/.github/workflows/pages.yml b/.github/workflows/docs.yml similarity index 84% rename from .github/workflows/pages.yml rename to .github/workflows/docs.yml index c8e931c3..562ebf30 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/docs.yml @@ -1,14 +1,16 @@ -name: GitHub Pages +name: Docs on: push: -# TODO: uncomment before merging -# branches: -# - main + branches: + - main + pull_request: + branches: + - main jobs: build: - name: Build Javadoc + name: Build documentation runs-on: ubuntu-22.04 steps: - name: Checkout @@ -28,6 +30,7 @@ jobs: uses: actions/upload-pages-artifact@0252fc4ba7626f0298f0cf00902a25c6afc77fa8 with: path: build/docs + if: ${{ github.ref == "refs/head/main" }} deploy: name: Deploy to GitHub Pages @@ -39,6 +42,7 @@ jobs: name: github-pages url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-22.04 + if: ${{ github.ref == "refs/head/main" }} steps: - name: Deploy to GitHub Pages id: deployment From 07dd5c8b3cd31177dfb76e789f7a9bfcb11d7d81 Mon Sep 17 00:00:00 2001 From: Sander Ploegsma Date: Tue, 23 Jan 2024 10:51:35 +0100 Subject: [PATCH 11/15] Use virtualenv for mkdocs plugin --- build.gradle | 4 ---- 1 file changed, 4 deletions(-) diff --git a/build.gradle b/build.gradle index 43fa1eed..4aac700f 100644 --- a/build.gradle +++ b/build.gradle @@ -51,10 +51,6 @@ jacocoTestReport { } } -python { - scope = USER -} - mkdocs { sourcesDir = "src/doc" buildDir = file("build/docs") From c9b5f517711ea16e8c15a6cdc2f309bde61dfbd3 Mon Sep 17 00:00:00 2001 From: Sander Ploegsma Date: Tue, 23 Jan 2024 10:56:16 +0100 Subject: [PATCH 12/15] Fix syntax in GHA workflow --- .github/workflows/docs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 562ebf30..2e78f704 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -28,9 +28,9 @@ jobs: run: ./gradlew --no-daemon clean mkdocsBuild javadoc - name: Upload artifact uses: actions/upload-pages-artifact@0252fc4ba7626f0298f0cf00902a25c6afc77fa8 + if: ${{ github.ref == 'refs/heads/main' }} with: path: build/docs - if: ${{ github.ref == "refs/head/main" }} deploy: name: Deploy to GitHub Pages @@ -42,7 +42,7 @@ jobs: name: github-pages url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-22.04 - if: ${{ github.ref == "refs/head/main" }} + if: github.ref == 'refs/heads/main' steps: - name: Deploy to GitHub Pages id: deployment From 973035aba3ad3051534547b6fea377e260ef7018 Mon Sep 17 00:00:00 2001 From: Sander Ploegsma Date: Tue, 23 Jan 2024 11:03:14 +0100 Subject: [PATCH 13/15] Downgrade Python version --- .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 2e78f704..3b46d615 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -23,7 +23,7 @@ jobs: - name: Set up Python uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c with: - python-version: "3.12" + python-version: "3.11" - name: Build documentation run: ./gradlew --no-daemon clean mkdocsBuild javadoc - name: Upload artifact From f4dced3aa7e1cd3b9bd93485ce63249abd2657cc Mon Sep 17 00:00:00 2001 From: Sander Ploegsma Date: Tue, 23 Jan 2024 11:08:06 +0100 Subject: [PATCH 14/15] Temporarily deploy from branches --- .github/workflows/docs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 3b46d615..e392a65d 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -28,7 +28,7 @@ jobs: run: ./gradlew --no-daemon clean mkdocsBuild javadoc - name: Upload artifact uses: actions/upload-pages-artifact@0252fc4ba7626f0298f0cf00902a25c6afc77fa8 - if: ${{ github.ref == 'refs/heads/main' }} +# if: ${{ github.ref == 'refs/heads/main' }} with: path: build/docs @@ -42,7 +42,7 @@ jobs: name: github-pages url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-22.04 - if: github.ref == 'refs/heads/main' +# if: github.ref == 'refs/heads/main' steps: - name: Deploy to GitHub Pages id: deployment From e3b8ba8d41184776d4db7aef69c78059a9c759e0 Mon Sep 17 00:00:00 2001 From: Sander Ploegsma Date: Tue, 23 Jan 2024 11:09:55 +0100 Subject: [PATCH 15/15] Revert "Temporarily deploy from branches" This reverts commit f4dced3aa7e1cd3b9bd93485ce63249abd2657cc. --- .github/workflows/docs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e392a65d..3b46d615 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -28,7 +28,7 @@ jobs: run: ./gradlew --no-daemon clean mkdocsBuild javadoc - name: Upload artifact uses: actions/upload-pages-artifact@0252fc4ba7626f0298f0cf00902a25c6afc77fa8 -# if: ${{ github.ref == 'refs/heads/main' }} + if: ${{ github.ref == 'refs/heads/main' }} with: path: build/docs @@ -42,7 +42,7 @@ jobs: name: github-pages url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-22.04 -# if: github.ref == 'refs/heads/main' + if: github.ref == 'refs/heads/main' steps: - name: Deploy to GitHub Pages id: deployment