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

docs(atlantis): use auto generated docs #371

Merged
merged 5 commits into from
Mar 30, 2024

Conversation

GMartinez-Sisti
Copy link
Member

@GMartinez-Sisti GMartinez-Sisti commented Mar 30, 2024

what

  • Auto generate docs from values.yaml using helm-docs
  • Moves the chart docs into the chart folder
  • Add CI step to check if docs are up to date on PRs
  • Remove deprecated docs workflow (.github/workflows/sync-readme.yaml)
  • Regarding helm changes, this PR is a no-op

why

The current documentation is hard to manage and we can't ensure it was up to date programatically.

tests

  • I have tested my changes by adding a step that ensures docs are up to date. Example of CI failure here.

    image

references

Closes #230.

@GMartinez-Sisti GMartinez-Sisti added the documentation Improvements or additions to documentation label Mar 30, 2024
@GMartinez-Sisti GMartinez-Sisti self-assigned this Mar 30, 2024
@GMartinez-Sisti GMartinez-Sisti marked this pull request as ready for review March 30, 2024 16:40
@GMartinez-Sisti GMartinez-Sisti requested a review from a team as a code owner March 30, 2024 16:40
Copy link
Contributor

@jamengual jamengual left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@GMartinez-Sisti GMartinez-Sisti merged commit 2895061 into runatlantis:main Mar 30, 2024
2 checks passed
@GMartinez-Sisti GMartinez-Sisti deleted the 230-auto-readme branch March 30, 2024 21:38
# Deprecated in favor of orgAllowlist
# orgWhitelist: <replace-me>
# -- Deprecated in favor of orgAllowlist.
orgWhitelist: "<replace-me>"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@GMartinez-Sisti orgWhitelist seems to be taking precedence now that it is uncommented, breaking configs with orgAllowlist set.

          - name: ATLANTIS_REPO_ALLOWLIST
-           value: foo.bar/some/repo
+           value: <replace-me>

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the heads up @peikk0! Fixing on #373.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Automatically generate README from helm values
3 participants