proposal: Lock issues(?)

[Andre601]

Is your feature request related to a problem? Please describe.
I'm unable to find an option in the label-commenter-config.yml to lock an issue in order to prevent things like Spam or similar, which makes me assume that this Action doesn't have such an option to begin with.

Describe the solution you'd like
It would be nice to have the option, to also lock an issue alongside closing it.
the actions could simply be called lock and unlock and perhaps an additional option to set the reason for why it was locked could be added too.

Examples:

labels:
  # User spammed an issue and comments
  - name: 'Locked (Spam)'
    labeled:
      issue:
        body: |-
          This issue has been **LOCKED** because of spam!
          
          Please do not spam messages and/or issues on the issue tracker. You may get blocked from this repository for doing so.
        action: 'lock'
        reason: 'spam'
  # User send very heated (aggressive) messages
  - name: 'Locked (Heated Chat)'
    labeled:
      issue:
        body: |-
          This issue has been **LOCKED** because of heated conversation!
          
          We appreciate exciting conversations, as long as they won't become too aggressive and/or emotional.
        action: 'lock'
        reason: 'heated'
  # Issue was completely off-topic or messages where not about the issue itself
  - name: 'Locked (Off-topic)'
    labeled:
      issue:
        body: |-
          This issue has been **LOCKED** because of Off-topic conversations!
          
          While we do appreciate conversations in issues would we like to keep them on the topic of the issue.
          Please use our other means of communication for casual chats.
        action: 'lock'
        reason: 'off-topic'
  # Issue was resolved and future messages should be avoided
  - name: 'Locked (Resolved)'
    labeled:
      issue:
        body: |-
          This issue has been **LOCKED** because of it being resolved!
          
          The issue has been fixed and is therefore considered resolved.
          If you still encounter this or it has changed, open a new issue instead of responding to solved ones.
        action: 'lock'
        reason: 'resolved'

GitHub does offer the above 4 reasons (Off-topic, Too Heated, Resolved and Spam) when locking an issue which is optional.

Describe alternatives you've considered
The only option is a manual lock of the issue.

Additional context

[github-actions]

Thank you @Andre601 for suggesting this.

[peaceiris]

I will consider this.

The field name lock_reason is better than reason, I think.

• off-topic: lock and close
• too heated: do nothing
• resolved: lock and close
• spam: lock and close

related functions:

• https://octokit.github.io/rest.js/v18#issues-lock
• https://octokit.github.io/rest.js/v18#issues-unlock

[Andre601]

I don't think that "too heated" should be nothing.
It can easly mean "Extremely agressive and insulting chats"

[peaceiris]

We can add new fields lock and lock_reason to enable choosing whether we close an issue (Pull Request) before locking.

[peaceiris]

You can try it now with the following setting!

• workflow: https://github.com/peaceiris/actions-label-commenter/blob/77b9624243e92c44570d4131ad52c1de2a70007f/.github/workflows/label-commenter.yml
• label config: https://github.com/peaceiris/actions-label-commenter/blob/77b9624243e92c44570d4131ad52c1de2a70007f/.github/label-commenter-config.yml

[github-actions]

This issue has been LOCKED because of it being resolved!

The issue has been fixed and is therefore considered resolved.
If you still encounter this or it has changed, open a new issue instead of responding to solved ones.

Log | Bot Usage

[peaceiris]

like this

[Andre601]

Looks really nice.

I also see you added a sort of Footer?
In that case would it perhaps be a useful thing to auto-add a footer that informs people, that the message was send through a GitHub Action and that responding to it or mentioning the bot account has no influence.

Similar to what I setup in one of the repos I contribute towards.

[peaceiris]

I opened #318

#317 has been merged.

TODO:

• proposal: Comment header and footer #318
• Release v1.8.0
• Update config YAML example on README.md

[peaceiris]

#318 has been merged. You can try it now with the following setting!

• workflow: https://github.com/peaceiris/actions-label-commenter/blob/1106b2a3f0eb5745782a02f8d45684092bad8ea0/.github/workflows/label-commenter.yml
• label config: https://github.com/peaceiris/actions-label-commenter/blob/1106b2a3f0eb5745782a02f8d45684092bad8ea0/.github/label-commenter-config.yml

[github-actions]

Hi, there.

This issue has been LOCKED because of heated conversation!

We appreciate exciting conversations, as long as they won't become too aggressive and/or emotional.

This is an automated comment created by the peaceiris/actions-label-commenter. Responding to the bot or mentioning it won't have any effect.
bot setting file, GitHub Actions workflow file

Log | Bot Usage

[github-actions]

Hi, there.

This issue has been unlocked now.

This is an automated comment created by the peaceiris/actions-label-commenter. Responding to the bot or mentioning it won't have any effect.
bot setting file, GitHub Actions workflow file

Log | Bot Usage

[Andre601]

👍

[peaceiris]

Version v1.8.0 has been released and the v1 tag updated now.

Release actions-label-commenter v1.8.0 · peaceiris/actions-label-commenter

Thank you!