Skip to content

Commit 9b231ac

Browse files
authored
Update README.md
1 parent 4ccf7ad commit 9b231ac

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,19 @@ This repository automatically generates the Javadoc for Processing 4 and hosts i
33

44
👉 https://processing.github.io/processing4-javadocs/
55

6+
## Automated Javadocs Deployment
7+
8+
This repository uses a custom GitHub Actions workflow [`build-and-deploy-javadoc.yml`](https://github.com/processing/processing4-javadocs/blob/gh-pages/.github/workflows/build-and-deploy-javadoc.yml) to automatically generate and updates Javadocs in the `/docs` folder.
9+
10+
### How It Works
11+
12+
- **Scheduled Run:** The workflow is triggered every Monday at midnight (UTC) to ensure that the Javadocs are always up-to-date.
13+
- **Manual Trigger:** You can also manually trigger the workflow if needed.
14+
- **Javadocs Generation:** The workflow clones the `processing/processing4` repository, builds the Javadocs using `ant`, and copies the generated files to the `/docs` directory of this repository.
15+
- **Update Source Files:** The updated Javadocs are committed and pushed to the `gh-pages` branch.
16+
- **Deployment:** We've set "Deploy from branch" in the repo settings to trigger on push to the `gh-pages` branch.
17+
18+
This automation helps keep the Javadocs updated without requiring manual intervention.
19+
620
## License
721
The Processing 4 reference is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License ([CC-BY-NC-SA-4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)).

0 commit comments

Comments
 (0)