GitHub App icon

GitHub App

Consume GitHub API using GitHub App authentication

Workflow → Disable

AI-generated

Overview

This node operation disables a specified GitHub Actions workflow in a given repository. It is useful for automating the management of GitHub workflows, such as temporarily disabling workflows during maintenance or updates. For example, a user can disable a CI/CD workflow in a repository to prevent it from running while making significant changes.

Use Case Examples

  1. Disabling a GitHub Actions workflow by specifying the repository owner, repository name, and workflow ID.
  2. Automating workflow management by disabling workflows based on certain triggers or conditions in an n8n automation.

Properties

Name Meaning
Repository Owner The owner of the GitHub repository where the workflow exists. This can be selected from a list, provided as a URL, or entered by name.
Repository Name The name of the GitHub repository containing the workflow. This can be selected from a list, provided as a URL, or entered by name.
Workflow The specific GitHub Actions workflow to disable. This can be selected from a list, specified by file name, or by workflow ID.

Output

JSON

  • json - The JSON response from the GitHub API indicating the result of the disable operation.

Dependencies

  • GitHub API
  • GitHub App authentication with an API key credential

Troubleshooting

  • Ensure the workflow ID is correct and exists in the specified repository to avoid 404 errors.
  • Verify that the GitHub App has the necessary permissions to disable workflows in the repository.
  • Check that the repository owner and repository name are correctly specified and accessible by the authenticated GitHub App.
  • If the node throws an error about invalid JSON inputs, verify the input parameters are correctly formatted.

Links

Discussion