Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use release notes to communicate maintenance work if needed #312

Closed
HonkingGoose opened this issue Aug 4, 2021 · 1 comment
Closed

Use release notes to communicate maintenance work if needed #312

HonkingGoose opened this issue Aug 4, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@HonkingGoose
Copy link
Contributor

HonkingGoose commented Aug 4, 2021

I was very confused when I got a update proposal from my "update bot" to bump actions/setup-node from v2.3.0 to v2.3.1. The change-logs were not clear enough for me about why you needed to turn this behavior off temporarily. So I tried to get clarification from the maintainers: #308 (comment).

Turns out this was a "quick-fix" to enable maintenance behind the scenes (#310). I know maintenance is needed, and that sometimes you need to turn things off to be able to do the work. So this is not a complaint about the maintenance itself, only about the communication about the maintenance.

I'd like to propose you use the release notes to communicate to the end-users.

A message like this would have made things clear right away:

We need to perform some behind-the-scenes maintenance. To do this work we need to disable `feature_name`. 

We will release a newer version of this action that reverts to the old situation once we're done.

And then when the maintenance is done:

We're done with the maintenance and have enabled `feature_name` again.
Thank you for your patience/understanding.
@dmitry-shibanov dmitry-shibanov added the documentation Improvements or additions to documentation label Nov 11, 2021
@dmitry-shibanov
Copy link
Contributor

Hello @HonkingGoose. Thank you for your report. Sorry for not providing a clear description in release notes. It was a quick maintaining fix, that is why it produced some noise. For now we try to provide clear description.

For now I'm closing the issue. If you have any concerns feel free to ping us.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants