chore: fix the Javadocs publishing action

[briangleeson]

PR summary

Originally the publishJavadoc-gha.sh script was based on the version used by our old Travis builds to publish the Javadoc. Though that had never actually worked. After migrating to Github Actions, found that the script couldnt merge the commit to main branch, despite removing branch protection and testing various approaches to solve what seemed to be an authentication issue.

Solution

Reworked the script so that it does not clone the repo (and gh-pages branch) within the script itself. Instead there are two GHA steps to checkout the main branch and gh-pages branch into two different folders. This approach seems to better propagate the correct GH permissions and solves the problem when pushing to the gh-pages branch.

The github action to publish the Javadoc uses the content of the main branch to generate the docs, and then copies them over to the gh-pages folder. From there it creates a commit and pushes to the gh-pages branch in the repo. This allows us to build the docs off the latest codebase in main, whilst preserving all previous javadoc builds in the gh-pages branch (in the docs subdirectory).

This reworking also required moving the maven commands into the publishJavadoc script, instead of calling them as GHA steps. It also means we no longer need to pass the GH_TOKEN or GITHUB_TOKEN into the script as the auth is persisted from the checkout steps.

PR Checklist

Please make sure that your PR fulfills the following requirements:

• The commit message follows the Angular Commit Message Guidelines.
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

• Bugfix
• Feature
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• New tests
• Build/CI related changes
• Documentation content changes
• Other (please describe)

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

• Yes
• No

[jerh616]

LGTM

[github-actions]

🎉 This PR is included in version 2.0.7 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀