DS-2758 improve broken links workflow #1417
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- auto run for PR to develop and main - fix csv format - it's potentially partially quoted-csv - generate summary in markup - run decorated with summary - on failure: - store csv file - add message to PR (not really necessary but makes the issue very salient
peterswirl
requested review from
dnicodemus,
erikspears and
monteiroalan-swirl
peterswirl
commented
Aug 22, 2024
Comment on lines
+88
to
+95
|
|
||
| if failed_count > 0: | ||
| summary.write("\n### Failed URLs:\n") | ||
| summary.write("* " + "\n* ".join(failed_urls) + "\n") | ||
|
|
||
| if unhandled_count > 0: | ||
| summary.write("\n### Unhandled Lines:\n") | ||
| summary.write("* " + "\n* ".join(unhandled_lines) + "\n") |
There was a problem hiding this comment.
FYI, I could include the excluded. Let me know if we want to do that
erikspears
reviewed
Aug 22, 2024
There was a problem hiding this comment.
Hey @peterswirl ,
Adding the README is a great idea. But do we need to run this on merges to develop branch? We don't maintain the README.md on that branch (we don't take it into releases, for example). And the docs/ directory only exists on main. Maybe one of those things is changing based on what you were told, but that's my understanding at the moment. Good stuff otherwise for sure!
There was a problem hiding this comment.
Yeah, that was my question. So, this is process related but,... docs do go straight to main. Let me redo this using main
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Branching Reminders
Branching off of develop as we will want this in both cases as README.md is included in the scan. Happy to redo if I'm mistaken
Description
Improve workflow - auto run for PR to develop and main
urlstechie/[email protected]potentially generates partially quoted-csvRelated Issue(s)
Internal issue DS-2758
Testing and Validation
Setup on Fork and ran PR with broken doc and that after fix
Broken case
After Fix
No comment on PR and the run looks like
Type of Change
NOTE: this is actually more of a process change for non shipping code. So, it could be a new feature, but it is not really for the product but its development processes