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

add docs upstream validation workflow #11113

Merged
merged 1 commit into from Oct 30, 2023

Conversation

dvdksn
Copy link
Contributor

@dvdksn dvdksn commented Oct 20, 2023

Signed-off-by: David Karlsson 35727626+dvdksn@users.noreply.github.com

What I did

added a gha workflow that verifies that the reference docs don't contain broken links etc

Related issue

(not mandatory) A picture of a cute animal, if possible in relation to what you did

🐥

@dvdksn dvdksn force-pushed the docs-validate-upstream-ci branch 4 times, most recently from 61b3943 to 37368a9 Compare October 20, 2023 20:00
@codecov
Copy link

codecov bot commented Oct 20, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (b8773ad) 57.42% compared to head (93137e7) 57.42%.
Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #11113      +/-   ##
==========================================
- Coverage   57.42%   57.42%   -0.01%     
==========================================
  Files         129      129              
  Lines       11274    11285      +11     
==========================================
+ Hits         6474     6480       +6     
- Misses       4168     4173       +5     
  Partials      632      632              

see 7 files with indirect coverage changes

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

@dvdksn
Copy link
Contributor Author

dvdksn commented Oct 25, 2023

hey @glours and @ndeloof, I added this new workflow that gives you some validation (check for broken links etc) in your CI. We have the same in Buildx and BuildKit, and since we vendor docs from this repo too I thought it would be good to add here

verifies that the reference docs don't contain broken links etc

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Copy link
Contributor

@glours glours left a comment

Choose a reason for hiding this comment

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

LGTM

@glours glours requested a review from ndeloof October 27, 2023 18:40
@ndeloof ndeloof merged commit 328ca3f into docker:main Oct 30, 2023
28 checks passed
@dvdksn dvdksn deleted the docs-validate-upstream-ci branch October 30, 2023 20:19
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.

None yet

3 participants