processing / processing/processing4

Trigger Javadocs update on release

Open
#876 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
494
Forks
183
Avg merge
4h 39m
Merged PRs (30d)
3

Description

Relevant sub-area for this feature?

Build process

Feature description

Trigger processing4-javadocs/.github/workflows/build-and-deploy-javadoc.yml on releases.

Benefits

Remove the need for a cron job and only update the Javadocs when necessary.

Possible challenges

No response

Additional context

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading processing4-javadocs/.github/workflows/build-and-deploy-javadoc.yml and the release configuration in processing4. Determine how a processing4 release can trigger that workflow instead of relying on a cron job. Done means Javadocs update only when a release occurs.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, java
Domain
build-system, ci-cd, release
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.