apiage: add commands to detect and report on APIs needing to be updated#759
Merged
mergify[bot] merged 4 commits intoceph:masterfrom Aug 30, 2022
Merged
Conversation
Find preview apis that should become stable. Find deprecated apis that should be removed. Have a mode to convert between the low level json report and some markdown that could be pasted into an issue. Signed-off-by: John Mulligan <jmulligan@redhat.com>
Signed-off-by: John Mulligan <jmulligan@redhat.com>
Right now this workflow needs to be run manually and it will generate some files that are archived. The plan is to build upon this as a base eventually teaching the workflow how to automatically file an issue reporting on what API updates are needed after each release. Signed-off-by: John Mulligan <jmulligan@redhat.com>
phlogistonjohn
added
the
no-API
Collaborator
Author
|
FWIW I have been reading up on ways to more completely automate this process. I found an action that can help file issues: https://github.com/JasonEtco/create-an-issue which is looking promising. However, I'm starting small with a manual action that just archives the output of the new apiage.py commands. This PR is mainly for the Makefile and aipage.py changes. I plan to use a later PR for the other actions enhancements so this should be reviewable as-is. Thanks! |
anoopcs9
reviewed
Aug 23, 2022
Signed-off-by: John Mulligan <jmulligan@redhat.com>
anoopcs9
approved these changes
Aug 30, 2022
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
2 participants
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.
The apiage part is a building block for eventual plans to try and automate this more fully.
Fixes: #591