This is an automated email from the ASF dual-hosted git repository.
damccorm pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/beam.git
The following commit(s) were added to refs/heads/master by this push:
new 23b1fe96128 add canonical link into javadocs when running post commit
(#29475)
23b1fe96128 is described below
commit 23b1fe96128903a6350402f21bd7749231ac05d1
Author: liferoad <[email protected]>
AuthorDate: Wed Nov 22 13:46:54 2023 -0500
add canonical link into javadocs when running post commit (#29475)
* add canonical link into javadocs when running post commit
* changed runs-on to test
* added java 8 for testing
* Fixed the base url
* Removed the testing parts
---
.github/workflows/README.md | 11 +++++++++++
.github/workflows/beam_PostCommit_Javadoc.yml | 5 +++++
2 files changed, 16 insertions(+)
diff --git a/.github/workflows/README.md b/.github/workflows/README.md
index bd4dcc7d067..c4f437dedd2 100644
--- a/.github/workflows/README.md
+++ b/.github/workflows/README.md
@@ -155,6 +155,17 @@ If you are testing on a fork, you likely will not have
self-hosted runners set u
To work around this, you can start using hosted runners and then switch over
when you're ready to create a PR.
You can do this by changing `runs-on: [self-hosted, ubuntu-20.04, main]`
(self-hosted, use in your PR) to `runs-on: ubuntu-20.04` (GitHub hosted, use
for local testing).
+Note when using `ubuntu-20.04` as the host, you might need to choose the Java
version since some gradle tasks only work with a certain Java version.
+One example is below to use Java 8 when testing your workflow:
+```
+ steps:
+ - uses: actions/checkout@v4
+ - uses: actions/setup-java@v3
+ with:
+ distribution: 'temurin'
+ java-version: '8'
+```
+
## Testing Workflow Updates
If you need to make more changes to the workflow yaml file after it has been
added to the repo, you can develop normally on a branch (using your fork or the
main Beam repo if you are a committer). If you are a non-committer, this flow
has several caveats mentioned below.
diff --git a/.github/workflows/beam_PostCommit_Javadoc.yml
b/.github/workflows/beam_PostCommit_Javadoc.yml
index 8207cbe9ca9..8e2a170dba6 100644
--- a/.github/workflows/beam_PostCommit_Javadoc.yml
+++ b/.github/workflows/beam_PostCommit_Javadoc.yml
@@ -78,6 +78,11 @@ jobs:
uses: ./.github/actions/gradle-command-self-hosted-action
with:
gradle-command: :sdks:java:javadoc:aggregateJavadoc
+ - name: Add canonical link into javadocs
+ uses: cicirello/javadoc-cleanup@v1
+ with:
+ path-to-root: sdks/java/javadoc/build/docs/javadoc
+ base-url-path: https://beam.apache.org/releases/javadoc/current/
- name: Upload Javadoc Results
uses: actions/upload-artifact@v3
with:
