feat: update file feature_toggle_annotations.yaml#97
Merged
robrap merged 4 commits intoopenedx:masterfrom Jan 30, 2024
Merged
Conversation
|
Thanks for the pull request, @Yagnesh1998! Please note that it may take us up to several weeks or months to complete a review and merge your PR. Feel free to add as much of the following information to the ticket as you can:
All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here. Please let us know once your PR is ready for our review and all tests are green. |
openedx-webhooks
added
the
open-source-contribution
mphilbrick211
added
the
needs test run
robrap
reviewed
Jan 17, 2024
code_annotations/contrib/config/feature_toggle_annotations.yaml
Outdated
Show resolved
Hide resolved
robrap
reviewed
Jan 18, 2024
Contributor
robrap
left a comment
robrap
left a comment
There was a problem hiding this comment.
Great. Thanks.
- You also need to update the version to 1.6.0 and add a note to the CHANGELOG.
- We may hold on merging until we get the how-to docs updated as well.
mphilbrick211
removed
the
needs test run
robrap
reviewed
Jan 30, 2024
|
@Yagnesh1998 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future. |
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
4 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.
Description:
Add annotation for toggle_removal_ticket to make it simpler to know if a toggle has an associated DEPR or removal ticket.
As Per this DEPR: openedx/edx-toggles#324
Additional notes:
This will be an optional annotation, at least to start.
Thoughts for documentation enhancements:
The link could be to a DEPR or another ticket.
Ideally it would not be a private ticket, but maybe that is ok if the removal is part of the same ticket used to introduce the toggle and it will be very short-lived?
In this case (or all cases?), all information that would support the removal should be added to the description or warning annotation.
We should note that for temporary rollout toggles, we should document the intended final value. Note that the toggle default might change as part of the rollout, which means it won't always just be the opposite.
This ticket was spun out of openedx/edx-toggles#283, which listed a number of potential improvements.