[Issue 740] current sprint report #760
Merged
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
Setting the BaseMetric.chart attribute during the __init__() method was slow By deferring the execution of plot_results() until BaseMetric.chart is called we can speed up the __init__() method
This property returns the name of the current sprint, which depends on another new method: get_sprint_name_from_date()
Allows users to pass "@current" as the sprint to calculate burndown for the current sprint
This reduces duplication across tests for creating sample SprintBoard data
lucasmbrown-usds
approved these changes
Nov 28, 2023
| # fmt: on | ||
| matching_sprints = self.sprints.loc[date_filter, self.sprint_col] | ||
| # if there aren't any sprints return None | ||
| if len(matching_sprints) == 0: |
There was a problem hiding this comment.
if len > 1, should we raise an error rather than silently choosing the first one?
There was a problem hiding this comment.
Oh good point! I'll add a quick fix for this before merging
There was a problem hiding this comment.
Actually I'm working through a fairly complicated merge conflict upstream, to simplify things I might spike getting this into #685 so I'm just resolving one merge conflict.
widal001
merged commit 892946f
into
issue-314-30k-deliverable-reporting
2 checks passed
widal001
added a commit
that referenced
this pull request
Nov 28, 2023
Enables users to calculate sprint burndown for the current sprint by passing `@current` to the `sprint` argument
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.
Summary
Adds support for calculating sprint burndown using
@currentinstead of specifying the name of a sprint. This allows us to set a schedule-based GitHub action that will calculate sprint burndown dynamically.Fixes #740
Time to review: 5 mins
Changes proposed
SprintBoardSprintBoard.get_sprint_name_from_date()Which accepts a date and returns the name of the sprint that contains it.SprintBoard.current_sprintWhich returns the name of the currently active sprintSprintBurndown._get_and_validate_sprint_name()which is used to ensure that the value passed to thesprintargument is a valid sprint nameBaseMetric.chartto be a property instead of an attribute whose value was set during__init__()This change defers the invocation ofplot_results()which is a slow method and, as a result, it speeds up initialization overall.@currentContext for reviewers
git fetch origin && git checkout issue-740-current-sprint-reportanalytics/README.mdfile@currentfunctionality with the following commands:Additional information