Skip to content

Commit

Permalink
fix: add Java 21, remove EOL version and exclude unsupported MacOS di…
Browse files Browse the repository at this point in the history
…stributions (#83)

* fix: build on some arch + java 21 test

* Update test-action-final.yml

* fix: remove EOL version

* fix: remove mac unsupported distributions

* fix: remove mac unsupported distributions

* chore: cleanup readme
  • Loading branch information
brenoepics authored May 9, 2024
1 parent a753a7a commit 274e984
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 18 deletions.
17 changes: 11 additions & 6 deletions .github/workflows/test-action-final.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ name: Test Actions
on:
schedule:
- cron: '0 0 * * *'
workflow_dispatch:
pull_request:
branches:
- main
Expand All @@ -13,7 +14,7 @@ jobs:
steps:
- uses: actions/checkout@v4

- uses: GuillaumeFalourd/assert-command-line-output@v2
- uses: GuillaumeFalourd/assert-command-line-output@v2.3
with:
command_line: cat pom.xml
contains: JAVAVERSION
Expand All @@ -23,14 +24,18 @@ jobs:
continue-on-error: true
strategy:
matrix:
java: [8, 11, 16, 17, 18, 19]
java: [8, 11, 17, 19, 21]
java-distribution: [adopt, zulu, temurin, corretto, microsoft, liberica]
os: [ubuntu-latest, windows-latest, macos-latest]
project: [maven, gradle]
exclude:
- java: 8
java-distribution: microsoft
- java: 18
java-distribution: temurin
os: macos-latest
- java: 8
java-distribution: adopt
os: macos-latest
- java: 8
java-distribution: microsoft
- java: 19
java-distribution: microsoft
Expand Down Expand Up @@ -76,13 +81,13 @@ jobs:
without-checkout: true
custom-command: gradle javadoc

- uses: GuillaumeFalourd/assert-command-line-output@v2
- uses: GuillaumeFalourd/assert-command-line-output@v2.3
if: ${{ matrix.project == 'maven' }}
with:
command_line: cat target/site/apidocs/index.html
contains: javadoc

- uses: GuillaumeFalourd/assert-command-line-output@v2
- uses: GuillaumeFalourd/assert-command-line-output@v2.3
if: ${{ matrix.project == 'gradle' }}
with:
command_line: cat build/docs/javadoc/index.html
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/test-action-local-subdirectories.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
steps:
- uses: actions/checkout@v4

- uses: GuillaumeFalourd/assert-command-line-output@v2
- uses: GuillaumeFalourd/assert-command-line-output@v2.3
with:
command_line: cat pom-module.xml
contains: JAVAVERSION
Expand Down Expand Up @@ -59,7 +59,7 @@ jobs:
custom-command: mvn -f pom-module.xml javadoc:javadoc
subdirectories: moduleA moduleB

- uses: GuillaumeFalourd/assert-command-line-output@v2
- uses: GuillaumeFalourd/assert-command-line-output@v2.3
if: ${{ matrix.project == 'maven' }}
with:
command_line: cat target/site/apidocs/moduleA/apidocs/index.html
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/test-action-local.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
steps:
- uses: actions/checkout@v4

- uses: GuillaumeFalourd/assert-command-line-output@v2
- uses: GuillaumeFalourd/assert-command-line-output@v2.3
with:
command_line: cat pom.xml
contains: JAVAVERSION
Expand Down Expand Up @@ -57,7 +57,7 @@ jobs:
without-deploy: true
without-checkout: true

- uses: GuillaumeFalourd/assert-command-line-output@v2
- uses: GuillaumeFalourd/assert-command-line-output@v2.3
if: ${{ matrix.project == 'maven' }}
with:
command_line: cat target/site/apidocs/index.html
Expand Down
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Deploy Publish JavaDoc
[![Public workflows that use this action.](https://img.shields.io/endpoint?url=https%3A%2F%2Fapi-endbug.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3DMathieuSoysal%2FJavadoc-publisher%26badge%3Dtrue)](https://github.com/search?o=desc&q=MathieuSoysal+javadoc-publisher+path%3A.github%2Fworkflows+language%3AYAML&s=&type=code) [![Test Actions](https://github.com/MathieuSoysal/publish-javadoc/actions/workflows/test-action-final.yml/badge.svg)](https://github.com/MathieuSoysal/publish-javadoc/actions/workflows/test-action-final.yml)*(Tested on Java 8, 11, 17, 19, Maven, Gradle, Ubuntu, Macos, Windows)*
[![Public workflows that use this action.](https://img.shields.io/endpoint?url=https%3A%2F%2Fapi-endbug.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3DMathieuSoysal%2FJavadoc-publisher%26badge%3Dtrue)](https://github.com/search?o=desc&q=MathieuSoysal+javadoc-publisher+path%3A.github%2Fworkflows+language%3AYAML&s=&type=code)
[![Test Actions](https://github.com/MathieuSoysal/publish-javadoc/actions/workflows/test-action-final.yml/badge.svg)](https://github.com/MathieuSoysal/publish-javadoc/actions/workflows/test-action-final.yml)
*(Tested on Java 8, 11, 17, 19, 21, Maven, Gradle, Ubuntu, macOS, Windows)*


Automatically generate Javadoc from your Java project and publish it to GitHub Page.

## Requirements
- Your project need to use **Maven** or **Gradle**.
- Your project needs to use **Maven** or **Gradle**.
<details>
<summary>
<h2>Inputs</h2>
Expand Down Expand Up @@ -135,19 +137,20 @@ jobs:

### GitHub page

Don't forget to configure your repository settings with your new GitHub Page. 😉
Remember to configure your repository settings with your new GitHub Page. 😉

<details>
<summary>Help to set up the GitHub Pages settings in your repository</summary>


If you need to use the specified directory to store the javadoc, You need to do this on your Settings page. like this.
If you need to use the specified directory to store the javadoc, You need to do this on your Settings page. Like this.


![]()
[<img src="https://user-images.githubusercontent.com/43273304/230144277-3714a61b-640e-49d4-b164-47598de8734b.jpg" width="900" alt="GitHub-Page-settings" />](https://user-images.githubusercontent.com/43273304/230144277-3714a61b-640e-49d4-b164-47598de8734b.jpg)

Not only that, but if you have README.md file in your javadoc branch, the access will show up just as well. and Doing so does not affect the javadoc commit.
Not only that, but if you have README.md file in your javadoc branch, the access will show up just as well.
And Doing so does not affect the javadoc commit.
</details>

### Badge
Expand All @@ -174,12 +177,11 @@ act workflow_dispatch -W .github/workflows/test-action-local.yml -P ubuntu-lates
```

## Contributors
<img src="CONTRIBUTORS.svg"/>

<img src="CONTRIBUTORS.svg" alt="Contributors"/>

## Stars 🎇

If you like or use this project, please don't forget to give it a star ⭐️. Thanks!
If you like or use this project, please remember to give it a star ⭐️. Thanks!

## License
The Dockerfile and associated scripts and documentation in this project are released under the [Apache 2.0 License](https://github.com/MathieuSoysal/publish-javadoc/blob/main/LICENSE).

0 comments on commit 274e984

Please sign in to comment.