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.
I was very confused when I got a update proposal from my "update bot" to bump
actions/setup-nodefromv2.3.0tov2.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:
And then when the maintenance is done: