Skip to content

Commit 43f4873

Browse files
committed
Revise README.md to clarify deployment process and remove inaccurate info about limitations
1 parent 9245459 commit 43f4873

File tree

1 file changed

+4
-15
lines changed

1 file changed

+4
-15
lines changed

README.md

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,17 @@
11
# Processing 4 Javadoc
2-
This repository automatically generates the Javadoc for Processing 4 and hosts it on GitHub Pages at:
2+
This repository automatically generates the Javadoc for Processing 4 and hosts it on GitHub Pages at the following address:
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-
106
### How It Works
117

12-
The workflow clones the `processing/processing4` repository, builds the Javadocs using `ant`, and copies the generated files to the `/docs` directory of this repository. The updated Javadocs are then committed and pushed to the `gh-pages` branch.
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) .
139

14-
The workflow is triggered every Monday at midnight (UTC) to ensure that the Javadocs are always up-to-date. You can also manually trigger the workflow if needed.
10+
The workflow clones the `processing/processing4` repository, gets the commit corresponding to the latest release, builds the Javadocs using `ant`, and copies the generated files to the `/docs` directory of this repository. The updated Javadocs are then committed and pushed to the `gh-pages` branch.
1511

1612
We've set "Deploy from branch" in the repo settings to trigger on push to the `gh-pages` branch. Every time the `build-and-deploy-javadoc.yml` workflow completes, it will trigger a deploy to GitHub pages.
1713

18-
This automation helps keep the Javadocs updated without requiring manual intervention.
19-
20-
## Limitations
21-
22-
Currently, the workflow checks out the main branch of the `processing/processing4` repository to generate the Javadocs. As a result, the Javadocs reflect the latest changes in the main branch, which might include updates that haven't been included in an official release yet. This could lead to discrepancies between the documentation and the most recent stable release of Processing 4
23-
24-
## To Do
25-
- [ ] Update the workflow to generate Javadocs based on the latest stable release instead of the `main` branch.
14+
The workflow is triggered every Monday at midnight (UTC). A maintainer can manually trigger the workflow if needed.
2615

2716
## Legacy
2817

0 commit comments

Comments
 (0)