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

Use an empty config file to produce docs #6092

Merged
merged 2 commits into from
Dec 6, 2024

Conversation

eapolinario
Copy link
Contributor

Tracking issue

NA

Why are the changes needed?

After #5972 we require a config file in order to run the docs subcommand in all components.

We use the docs subcommand to produce the rst files under the docs directory, e.g. https://github.com/flyteorg/flyte/blob/master/docs/deployment/configuration/generated/flyteadmin_config.rst.

What changes were proposed in this pull request?

This PR introduces an empty config file to be passed to each of the invocations of the components docs subcommands in https://github.com/flyteorg/flyte/blob/master/script/generate_config_docs.sh#L46-L49.

How was this patch tested?

Ran make release_automation locally and confirmed that the command succeeds and docs are generated.

Setup process

Screenshots

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Related PRs

Docs link

Copy link

codecov bot commented Dec 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.09%. Comparing base (9dc21f4) to head (7df4eb7).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #6092      +/-   ##
==========================================
- Coverage   37.10%   37.09%   -0.01%     
==========================================
  Files        1318     1318              
  Lines      132403   132403              
==========================================
- Hits        49122    49116       -6     
- Misses      79009    79015       +6     
  Partials     4272     4272              
Flag Coverage Δ
unittests-datacatalog 51.58% <ø> (ø)
unittests-flyteadmin 54.07% <ø> (-0.03%) ⬇️
unittests-flytecopilot 30.99% <ø> (ø)
unittests-flytectl 62.29% <ø> (ø)
unittests-flyteidl 7.23% <ø> (ø)
unittests-flyteplugins 53.82% <ø> (ø)
unittests-flytepropeller 42.60% <ø> (ø)
unittests-flytestdlib 57.59% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

wild-endeavor
wild-endeavor previously approved these changes Dec 6, 2024
Signed-off-by: Eduardo Apolinario <[email protected]>
@eapolinario eapolinario merged commit 25d84e6 into master Dec 6, 2024
52 of 53 checks passed
@eapolinario eapolinario deleted the use-config-file-in-release branch December 6, 2024 22:35
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