Clarify how often usage reports are sent #928
Merged
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.
Closes #921. This PR doesn't change the current behavior, but it tries to make that behavior clear. For example, I used to think that usage reports were sent every 30 days. After this PR, usage reports will continue to be sent every 31 days — but I think that fact will be clearer.
What has been done to verify that this works as intended?
Updated and new tests.
Why is this the best possible solution? Were any other approaches considered?
I considered not making any changes at all. I realized that I could send daily usage reports by setting the
default.taskSchedule.analytics
config to 0 instead of 1. However, I think this PR makes things a little clearer.I'll also leave a comment about an individual line.
How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?
The current behavior is intended to stay the same. I've updated tests to help verify that there hasn't been a change in behavior.
Does this change require updates to the API documentation? If so, please update docs/api.md as part of this PR.
I don't think so. We say in the API docs that usage data is sent monthly, which is consistent with the current interval of 31 days.
Before submitting this PR, please make sure you have:
make test-full
and confirmed all checks still pass OR confirm CircleCI build passes