Skip to content

Commit 19facab

Browse files
authored
Replace GH pages for javadoc.io (#201)
No need to maintain GH pages if javadoc.io can serve it. Also re-enable test-readme-links on PRs.
1 parent 1605270 commit 19facab

File tree

4 files changed

+21
-93
lines changed

4 files changed

+21
-93
lines changed

.github/workflows/pr.yml

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,8 @@ jobs:
3030
- name: 'unittest discover'
3131
run: python3 -m unittest discover -bs .github/scripts
3232

33-
# TODO Re-enable once rename is done (too many dead links until new javadoc is published)
34-
# readme-links-test:
35-
# uses: ./.github/workflows/test-readme-links.yml
33+
readme-links-test:
34+
uses: ./.github/workflows/test-readme-links.yml
3635

3736
generated-api-diff:
3837
runs-on: ubuntu-latest
@@ -76,11 +75,6 @@ jobs:
7675
body-file: 'comment.md'
7776
edit-mode: replace
7877

79-
dry-run-publish-javadoc:
80-
uses: ./.github/workflows/publish-javadoc.yml
81-
with:
82-
dry_run: true
83-
8478
dry-run-publish-library:
8579
uses: ./.github/workflows/publish-library.yml
8680
with:

.github/workflows/publish-javadoc.yml

Lines changed: 0 additions & 66 deletions
This file was deleted.

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -194,23 +194,23 @@ import com.gabrielfeo.develocity.api.model.extension.*
194194
[4]: https://github.com/square/retrofit/issues/3144#issuecomment-508300518
195195
[5]: https://docs.gradle.com/enterprise/api-manual/ref/2022.4.html
196196
[6]: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator-gradle-plugin/README.adoc
197-
[7]: https://gabrielfeo.github.io/develocity-api-kotlin/
198-
[8]: https://gabrielfeo.github.io/develocity-api-kotlin/library/com.gabrielfeo.develocity.api/-config/index.html
199-
[9]: https://gabrielfeo.github.io/develocity-api-kotlin/library/com.gabrielfeo.develocity.api/-develocity-api/
200-
[11]: https://gabrielfeo.github.io/develocity-api-kotlin/library/com.gabrielfeo.develocity.api/-develocity-api/shutdown.html
201-
[12]: https://gabrielfeo.github.io/develocity-api-kotlin/library/com.gabrielfeo.develocity.api/-config/-cache-config/cache-enabled.html
202-
[13]: https://gabrielfeo.github.io/develocity-api-kotlin/library/com.gabrielfeo.develocity.api/-config/-cache-config/index.html
203-
[14]: https://central.sonatype.com/artifact/com.gabrielfeo/develocity-api-kotlin/2023.4.0
204-
[16]: https://gabrielfeo.github.io/develocity-api-kotlin/library/com.gabrielfeo.develocity.api/-config/api-url.html
205-
[17]: https://gabrielfeo.github.io/develocity-api-kotlin/library/com.gabrielfeo.develocity.api/-config/api-token.html
206-
[18]: https://gabrielfeo.github.io/develocity-api-kotlin/library/com.gabrielfeo.develocity.api/-builds-api/index.html
207-
[19]: https://gabrielfeo.github.io/develocity-api-kotlin/library/com.gabrielfeo.develocity.api.model/-gradle-attributes/index.html
208-
[20]: https://gabrielfeo.github.io/develocity-api-kotlin/library/com.gabrielfeo.develocity.api/-builds-api/index.html
209-
[21]: https://gabrielfeo.github.io/develocity-api-kotlin/library/com.gabrielfeo.develocity.api/-builds-api/get-builds.html
210-
[22]: https://gabrielfeo.github.io/develocity-api-kotlin/library/com.gabrielfeo.develocity.api/-builds-api/get-gradle-attributes.html
211-
[23]: https://gabrielfeo.github.io/develocity-api-kotlin/library/com.gabrielfeo.develocity.api/-develocity-api/-default-instance/index.html
212-
[24]: https://gabrielfeo.github.io/develocity-api-kotlin/library/com.gabrielfeo.develocity.api.extension/get-builds-flow.html
213-
[25]: https://gabrielfeo.github.io/develocity-api-kotlin/library/com.gabrielfeo.develocity.api.extension/index.html
197+
[7]: https://javadoc.io/doc/com.gabrielfeo/develocity-api-kotlin/2024.1.0/
198+
[8]: https://javadoc.io/doc/com.gabrielfeo/develocity-api-kotlin/2024.1.0/library/com.gabrielfeo.develocity.api/-config/index.html
199+
[9]: https://javadoc.io/doc/com.gabrielfeo/develocity-api-kotlin/2024.1.0/library/com.gabrielfeo.develocity.api/-develocity-api/
200+
[11]: https://javadoc.io/doc/com.gabrielfeo/develocity-api-kotlin/2024.1.0/library/com.gabrielfeo.develocity.api/-develocity-api/shutdown.html
201+
[12]: https://javadoc.io/doc/com.gabrielfeo/develocity-api-kotlin/2024.1.0/library/com.gabrielfeo.develocity.api/-config/-cache-config/cache-enabled.html
202+
[13]: https://javadoc.io/doc/com.gabrielfeo/develocity-api-kotlin/2024.1.0/library/com.gabrielfeo.develocity.api/-config/-cache-config/index.html
203+
[14]: https://central.sonatype.com/artifact/com.gabrielfeo/develocity-api-kotlin/2024.1.0
204+
[16]: https://javadoc.io/doc/com.gabrielfeo/develocity-api-kotlin/2024.1.0/library/com.gabrielfeo.develocity.api/-config/api-url.html
205+
[17]: https://javadoc.io/doc/com.gabrielfeo/develocity-api-kotlin/2024.1.0/library/com.gabrielfeo.develocity.api/-config/api-token.html
206+
[18]: https://javadoc.io/doc/com.gabrielfeo/develocity-api-kotlin/2024.1.0/library/com.gabrielfeo.develocity.api/-builds-api/index.html
207+
[19]: https://javadoc.io/doc/com.gabrielfeo/develocity-api-kotlin/2024.1.0/library/com.gabrielfeo.develocity.api.model/-gradle-attributes/index.html
208+
[20]: https://javadoc.io/doc/com.gabrielfeo/develocity-api-kotlin/2024.1.0/library/com.gabrielfeo.develocity.api/-builds-api/index.html
209+
[21]: https://javadoc.io/doc/com.gabrielfeo/develocity-api-kotlin/2024.1.0/library/com.gabrielfeo.develocity.api/-builds-api/get-builds.html
210+
[22]: https://javadoc.io/doc/com.gabrielfeo/develocity-api-kotlin/2024.1.0/library/com.gabrielfeo.develocity.api/-builds-api/get-gradle-attributes.html
211+
[23]: https://javadoc.io/doc/com.gabrielfeo/develocity-api-kotlin/2024.1.0/library/com.gabrielfeo.develocity.api/-develocity-api/-default-instance/index.html
212+
[24]: https://javadoc.io/doc/com.gabrielfeo/develocity-api-kotlin/2024.1.0/library/com.gabrielfeo.develocity.api.extension/get-builds-flow.html
213+
[25]: https://javadoc.io/doc/com.gabrielfeo/develocity-api-kotlin/2024.1.0/library/com.gabrielfeo.develocity.api.extension/index.html
214214
[26]: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/
215215
[27]: ./examples/example-scripts/example-script.main.kts
216216
[28]: ./examples/example-project

examples/example-notebooks/MostFrequentBuilds.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,9 @@
8181
"response using the `models` parameter. \"Models\" are build details that would come from other endpoints. For example, \n",
8282
"requesting models=[gradleAttributes][3] brings data from `/api/builds/{id}/gradle-attributes` in the same response.\n",
8383
"\n",
84-
"[1]: https://gabrielfeo.github.io/develocity-api-kotlin/library/com.gabrielfeo.develocity.api.extension/get-builds-flow.html\n",
84+
"[1]: https://javadoc.io/doc/com.gabrielfeo/develocity-api-kotlin/2024.1.0/library/com.gabrielfeo.develocity.api.extension/get-builds-flow.html\n",
8585
"[2]: https://docs.gradle.com/enterprise/api-manual/#advanced_search_syntax \n",
86-
"[3]: https://gabrielfeo.github.io/develocity-api-kotlin/library/com.gabrielfeo.develocity.api\n",
86+
"[3]: https://javadoc.io/doc/com.gabrielfeo/develocity-api-kotlin/2024.1.0/library/com.gabrielfeo.develocity.api\n",
8787
".model/-build-model-name/gradle-attributes/index.html"
8888
]
8989
},

0 commit comments

Comments
 (0)