Add workflow and script to clean Dependabot description bodies#989
Closed
mhucka wants to merge 8 commits intoquantumlib:mainfrom
Closed
Add workflow and script to clean Dependabot description bodies#989mhucka wants to merge 8 commits intoquantumlib:mainfrom
mhucka wants to merge 8 commits intoquantumlib:mainfrom
Conversation
This adds a simple Python program to clean up the Dependabot description bodies to remove unwanted sections (like the list of commands) and convert the HTML body to Markdown. Pytest test cases are also provided.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Turns out it's easy to process these Markdown bodies by looking for the "Commits" section and deleting it and everything after it, then converting what's left to Markdown. The script is short enough that it can be inlined in the workflow YAML file.
github-actions
bot
added
size: M
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This adds a simple work to clean up the Dependabot description bodies to remove unwanted sections (like the list of commands) and convert the HTML body to Markdown.
The algorithm is simple: look for
<details><summary>Commits</summary>, which marks the beginning of a section listing the commits in the upstream repository, and just delete everything in the Dependabot description from that point to the end. This gets rid of the commits list, the Dependabot command summary, and miscellaneous other bits that we don't find useful.