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

chore: auto update config docs #305

Merged

Conversation

skyerus
Copy link
Contributor

@skyerus skyerus commented Jan 23, 2023

This PR

  • Introduced make generate-docs which auto generates cmd config documentation
  • Pipeline check that doc generation doesn't create a diff (fail if it does with a message to run make generate-docs)

Related Issues

Fixes #243

Notes

Follow-up Tasks

How to test

@beeme1mr beeme1mr self-requested a review January 23, 2023 15:21
Copy link
Member

@beeme1mr beeme1mr left a comment

Choose a reason for hiding this comment

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

Very cool!

Signed-off-by: Skye Gill <gill.skye95@gmail.com>
Signed-off-by: Skye Gill <gill.skye95@gmail.com>
Signed-off-by: Skye Gill <gill.skye95@gmail.com>
@skyerus skyerus force-pushed the issue-243_auto-generate-config-docs branch from 6158085 to 4af7f9e Compare January 23, 2023 15:38
Copy link
Member

@toddbaert toddbaert left a comment

Choose a reason for hiding this comment

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

Love it.

Checking it in the CI (therefor forcing it to be committed) is the best approach, I think.

@skyerus skyerus merged commit 7d24060 into open-feature:main Jan 24, 2023
@skyerus skyerus deleted the issue-243_auto-generate-config-docs branch January 24, 2023 12:17
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.

[DOC] Auto Update Config Docs
4 participants