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: commit generated docs for readthedocs.org #2535

Merged
merged 5 commits into from
Jan 26, 2023

Conversation

zachaller
Copy link
Collaborator

@zachaller zachaller commented Jan 24, 2023

If we do not commit the docs all the autogenerated docs do not show or work on argo-rollouts.readthedocs.org this also brings the pattern in line with and is probably why argocd does the same.

https://cloud-native.slack.com/archives/C01U781DW2E/p1674574980825679
https://cloud-native.slack.com/archives/C01U781DW2E/p1674579723986039

Screenshot 2023-01-24 at 12 13 31 PM

vs

https://argo-rollouts.readthedocs.io/en/fix-docs-version/features/kubectl-plugin/

I also feel it makes sense to have these committed for things like different versions which is why readthedocs needs them as well

Signed-off-by: zachaller [email protected]

@zachaller zachaller changed the title fix: commit generated docs for readthedocs.org docs: commit generated docs for readthedocs.org Jan 24, 2023
@zachaller zachaller marked this pull request as ready for review January 24, 2023 16:20
@zachaller zachaller marked this pull request as draft January 24, 2023 16:31
@github-actions
Copy link
Contributor

github-actions bot commented Jan 24, 2023

Go Published Test Results

1 834 tests   1 834 ✔️  2m 30s ⏱️
   105 suites         0 💤
       1 files           0

Results for commit 0b5b8f9.

♻️ This comment has been updated with latest results.

@github-actions
Copy link
Contributor

github-actions bot commented Jan 24, 2023

E2E Tests Published Test Results

    2 files      2 suites   1h 38m 24s ⏱️
  95 tests   90 ✔️ 3 💤 2
192 runs  184 ✔️ 6 💤 2

For more details on these failures, see this check.

Results for commit 0b5b8f9.

♻️ This comment has been updated with latest results.

@zachaller zachaller marked this pull request as ready for review January 24, 2023 17:22
@zachaller zachaller requested a review from leoluz January 24, 2023 17:22
@codecov
Copy link

codecov bot commented Jan 24, 2023

Codecov Report

Base: 81.69% // Head: 81.66% // Decreases project coverage by -0.04% ⚠️

Coverage data is based on head (0b5b8f9) compared to base (3c2cef9).
Patch coverage: 30.76% of modified lines in pull request are covered.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2535      +/-   ##
==========================================
- Coverage   81.69%   81.66%   -0.04%     
==========================================
  Files         126      126              
  Lines       19136    19147      +11     
==========================================
+ Hits        15634    15636       +2     
- Misses       2709     2717       +8     
- Partials      793      794       +1     
Impacted Files Coverage Δ
metricproviders/prometheus/prometheus.go 89.43% <30.76%> (-7.00%) ⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

If we do not commit the docs all the autogenerated docs do not show
or work on argo-rollouts.readthedocs.org this also brings the pattern
in line with and is probably why argocd does the same.

Signed-off-by: zachaller <[email protected]>
Signed-off-by: zachaller <[email protected]>
Signed-off-by: zachaller <[email protected]>
@zachaller zachaller force-pushed the fix-autogen-docs-readthedocs branch from 23a65b8 to 0b5b8f9 Compare January 25, 2023 22:56
@sonarcloud
Copy link

sonarcloud bot commented Jan 25, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.9% 0.9% Duplication

Copy link
Contributor

@leoluz leoluz left a comment

Choose a reason for hiding this comment

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

LGTM
We should probably investigate how to avoid having to manually generate those files and push. Maybe we could configure the build to take care of that.

@zachaller zachaller merged commit 373c4a0 into argoproj:master Jan 26, 2023
zachaller added a commit that referenced this pull request Jan 26, 2023
* fix: commit generated docs for readthedocs.org

If we do not commit the docs all the autogenerated docs do not show
or work on argo-rollouts.readthedocs.org this also brings the pattern
in line with and is probably why argocd does the same.

Signed-off-by: zachaller <[email protected]>

* remove already included in make codegen cmds

Signed-off-by: zachaller <[email protected]>

* static default value for doc generation

Signed-off-by: zachaller <[email protected]>

* cleanup

Signed-off-by: zachaller <[email protected]>

* typo

Signed-off-by: zachaller <[email protected]>

Signed-off-by: zachaller <[email protected]>
zachaller added a commit that referenced this pull request Jan 26, 2023
* fix: commit generated docs for readthedocs.org

If we do not commit the docs all the autogenerated docs do not show
or work on argo-rollouts.readthedocs.org this also brings the pattern
in line with and is probably why argocd does the same.

Signed-off-by: zachaller <[email protected]>

* remove already included in make codegen cmds

Signed-off-by: zachaller <[email protected]>

* static default value for doc generation

Signed-off-by: zachaller <[email protected]>

* cleanup

Signed-off-by: zachaller <[email protected]>

* typo

Signed-off-by: zachaller <[email protected]>

Signed-off-by: zachaller <[email protected]>
@zachaller zachaller added the cherry-pick-completed Used once we have cherry picked the PR to all requested releases label Jan 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cherry-pick/release-1.3 cherry-pick/release-1.4 cherry-pick-completed Used once we have cherry picked the PR to all requested releases
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants