All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Bump cicirello/pyaction from 4.25.0 to 4.32.0
- Fix minor bug in regex used to detect if an html file was generated by Javadoc.
- Fix minor bug in regex used to detect if an html file is a redirect, such as in javadocs for libraries that define a JPMS module.
- Fix minor bug in regex used to detect if a Javadoc page already specified a viewport directive, such as in Java 16+.
- Bump cicirello/pyaction from 4.11.1 to 4.25.0, including upgrading Python within the Docker container to 3.12.
- Bump Python to 3.12 in CI/CD workflows when running unit tests.
- Some users may be using the action on a self-hosted runner not yet updated to a version supporting the new GitHub Actions
GITHUB_OUTPUTenvironment file. This patch adds backwards compatibility for those users (e.g., it falls back to using the deprecatedset-outputifGITHUB_OUTPUTdoesn't exist).
- Bump cicirello/pyaction from 4.11.0 to 4.11.1
- Replaced the usage of GitHub Action's deprecated
set-outputwith the new$GITHUB_OUTPUTenv file.
- Bump cicirello/pyaction from 4.7.1 to 4.11.0, including upgrading Python within the Docker container to 3.10.7
- Added missing new line character to improve readability of the generated javadoc-cleanup block.
- Correctly handle cases of javadoc redirected pages, such as when javadoc generates a redirect from root of javadoc to a module page when Java Platform Module System is used. This includes not inserting a redundant canonical link, and also includes directing search engines to noindex and follow such redirected pages.
- Bump cicirello/pyaction from 4.3.0 to 4.7.1
- Bumped base Docker image cicirello/pyaction from 4.2.0 to 4.3.0.
- Fixed issue for recent Java versions (Java 16+) where a redundant meta viewport directive was inserted by javadoc-cleanup. This is not needed for Java 16+ because javadoc properly defines viewport.
- Fixed issue in parsing the "Generated by javadoc" comment for versions of javadoc that include a version string in that comment.
- Bumped python to 3.10.
- Changed base docker image to cicirello/pyaction:4.2.0.
- Now pulls base image from GitHub Container Registry under assumption that from actions it should be faster from GitHub than from Docker.
- Disabled pycache.
- Ability to insert a user-defined block into the head of each javadoc page. The motivation of this was for the purpose of adding the ability to insert links to a favicon for the site. But exactly what is needed for this can vary greatly from one site to the next. This new feature is not limited to this use-case. It can be used to insert anything that is valid in the head of an html page into every javadoc generated page.
- Changed tag used to pull base docker image from
latestto3(the current latest major release tag) to ensure we don't accidentally pick up breaking changes in future releases of base image. - Refactored existing code to improve maintainability.
- Various improvements to documentation, specifically to the example workflows.
- Introduced major version tag.
- Enabled CodeQL code scanning on all push/pull-request events.
- Added integration testing to all push/pull-request events.
- Added changelog.
- Now includes option to also generate and insert canonical URLs in head of each javadoc page.
- Example workflows now assume Maven for running workflows, but can easily be adapted to any other method of running javadoc.
- Switched to smaller docker base image, pyaction-lite, to speed up action loading
- Updated example workflows in README
- Minor bug fix: javadoc-cleaner is now prevented from modifying non-javadoc html files, if any are present.
- Initial release features improved browsing of javadocs on mobile devices.