Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Autodocs #266

Merged
merged 9 commits into from
Apr 25, 2022
Merged

Autodocs #266

merged 9 commits into from
Apr 25, 2022

Conversation

graebm
Copy link
Contributor

@graebm graebm commented Apr 22, 2022

Automated update the API documentation published to https://aws.github.io/aws-iot-device-sdk-java-v2/

Issue:

  • Docs weren't updated unless someone remembered to do it manually.
  • Manually updating docs whenever you update code pollutes the diff, making it hard to review
  • Having HTML docs in main branch can cause issues.
    • Bloats size.
    • Generated docs might contain licenses we don't want to be redistributing.

Description of changes:

  • Docs are kept in docs branch now
    • New docs.yml Github Workflow updates the docs branch whenever the main branch changes.
    • New check-docs job in ci.yml checks pull-requests for anything that would break docs.
    • delete the docs/ folder in main and use .gitignore to prevent someone from accidentally resurrecting it.

TODO:
Turn on warnings as errors (in mavan-javadoc-plugin configuration add <failsOnError>true</failsOnError>). I tried turning it on but it was too much work to tackle today, since a lot of warnings were in the generated code.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@graebm graebm marked this pull request as ready for review April 22, 2022 04:11
sdk/pom.xml Outdated Show resolved Hide resolved
@graebm graebm merged commit 0b4c980 into main Apr 25, 2022
@graebm graebm deleted the autodocs branch April 25, 2022 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants