libelektra icon indicating copy to clipboard operation
libelektra copied to clipboard

Switch from probot/stale to github/stale

Open kodebach opened this issue 2 years ago • 1 comments

We should switch from the current Probot based "stale issue bot" to the one provided by GitHub.

Not only is the Probot based one, seemingly no longer maintained (see https://github.com/probot/stale/issues/385 and https://github.com/probot/probot.github.io/pull/376), but the GitHub one also has a lot more options. Including one option which allows closing issues as "not planned" instead of "completed".

kodebach avatar Sep 20 '22 11:09 kodebach

@markus2330 The old Probot based bot also seems to be buggy. It closed both #3318 and #1610 even though the last comment wasn't the "I mark this issue stale" from the bot.

kodebach avatar Sep 21 '22 18:09 kodebach

I can confirm that probot/stale is still installed. The config file exists at https://github.com/ElektraInitiative/libelektra/blob/master/.github/stale.yml And since it's an app, it would also have to be uninstalled.

And the improved stale issues action still needs to be installed.

Installing the new stale issues action

After a fair bit of searching, I actually found the right documentation page https://docs.github.com/en/actions/managing-issues-and-pull-requests/closing-inactive-issues

This can probably be done in a fork, and a pull request can be created with this.

Uninstalling probot/stale

By going to https://github.com/apps/stale and pressing configure.

Then one would select libelektra image

And hit the x button image

And finally press uninstall

stefnotch avatar Oct 18 '22 11:10 stefnotch

Thank you for the detailed analysis. Let us first make a config file for the new one, then I'll do the steps to add the new one and remove the old one.

markus2330 avatar Oct 20 '22 08:10 markus2330

Is creating the config file an appropriate change for a pull request in T1? It does not completely fit into any of the 3 described problems, but it it is still closely related I suppose.

Janldeboer avatar Nov 20 '22 12:11 Janldeboer

I uninstalled probot/stale as described above.

And the improved stale issues action still needs to be installed.

Is there anything else to be done?

markus2330 avatar Nov 28 '22 08:11 markus2330

And the improved stale issues action still needs to be installed.

Is there anything else to be done?

I don't think so. I think that the only manual step needed was removing the old probot/stale.

The action has been created automatically: https://github.com/ElektraInitiative/libelektra/actions/workflows/stale.yml

0x6178656c avatar Nov 28 '22 12:11 0x6178656c

Is there a reason, we didn't end up using the close-issue-reason: not_planned option?

kodebach avatar Nov 29 '22 09:11 kodebach

Is there a reason, we didn't end up using the close-issue-reason: not_planned option?

What do you mean? We switched.

markus2330 avatar Nov 29 '22 10:11 markus2330

Yes we switched to the GitHub stalebot action. But I don't see the close-issue-reason: not_planned option in https://github.com/ElektraInitiative/libelektra/blob/master/.github/workflows/stale.yml.

That means the bot still closes issues as "completed" not as "not planned". See for example https://github.com/ElektraInitiative/libelektra/issues/2991#event-7908260243, which was closed today.

kodebach avatar Nov 29 '22 10:11 kodebach

@kodebach Thanks for pointing this out. I should have read this thread more carefully.

It seems that the option close-issue-reason is set automatically to not_planned in v6. I still added it so be explicit, though.

Edit: For context: I previously chose v5 for the GitHub action and have now changed it to v6 in #4726

0x6178656c avatar Nov 29 '22 13:11 0x6178656c