GitHub App icon

GitHub App

Consume GitHub API using GitHub App authentication

Actions36

Issue → Lock

AI-generated

Overview

This node operation locks a specific issue in a GitHub repository. It is useful for scenarios where you want to prevent further comments or interactions on an issue, such as when the discussion is off-topic, too heated, resolved, or spam. For example, a project maintainer might lock an issue after it has been resolved to avoid additional comments.

Use Case Examples

  1. Locking an issue after it has been resolved to prevent further comments.
  2. Locking an issue that has become too heated to maintain a respectful discussion environment.

Properties

Name Meaning
Repository Owner The owner of the GitHub repository where the issue exists. It can be selected from a list, provided as a URL, or entered by name.
Repository Name The name of the GitHub repository containing the issue. It can be selected from a list, provided as a URL, or entered by name.
Issue Number The number of the issue to lock in the repository.
Lock Reason The reason for locking the issue, which can be Off-Topic, Too Heated, Resolved, or Spam.

Output

JSON

  • json - The JSON response from GitHub API after locking the issue, typically containing the updated issue state.

Dependencies

  • GitHub API accessed via GitHub App authentication using an API key credential

Troubleshooting

  • Ensure the repository owner and repository name are correctly specified and accessible by the GitHub App.
  • Verify that the issue number exists in the specified repository.
  • Check that the GitHub App has the necessary permissions to lock issues in the repository.
  • Common error: 'The issue number to lock is required' - make sure the issue number parameter is provided.
  • Common error: 'Failed to authenticate with GitHub App' - verify the GitHub App credentials and permissions.

Links

Discussion