GitHub App icon

GitHub App

Consume GitHub API using GitHub App authentication

Actions36

Workflow → Get

AI-generated

Overview

This node operation retrieves a specific GitHub workflow from a repository. It is useful for users who want to fetch details about a particular workflow defined in a GitHub repository, such as its configuration, status, or metadata. For example, a user might want to get the details of a CI/CD workflow to monitor or audit its setup.

Use Case Examples

  1. Fetch details of a GitHub Actions workflow by specifying the repository owner, repository name, and workflow ID.
  2. Use the node to programmatically retrieve workflow information for automation or reporting purposes.

Properties

Name Meaning
Repository Owner The owner of the GitHub repository, which can be selected from a list, provided as a URL, or entered by name. This identifies the user or organization owning the repository.
Repository Name The name of the GitHub repository from which to get the workflow. It can be selected from a list, provided as a URL, or entered by name.
Workflow The specific workflow to retrieve, identified by selecting from a list, by file name, or by workflow ID.

Output

JSON

  • id - The unique identifier of the workflow.
  • node_id - The node identifier of the workflow.
  • name - The name of the workflow.
  • path - The file path of the workflow in the repository.
  • state - The current state of the workflow (e.g., active or disabled).
  • created_at - The timestamp when the workflow was created.
  • updated_at - The timestamp when the workflow was last updated.
  • url - The API URL for the workflow.
  • html_url - The web URL for the workflow on GitHub.

Dependencies

  • GitHub API access via GitHub App authentication

Troubleshooting

  • Ensure the 'Repository Owner', 'Repository Name', and 'Workflow' parameters are correctly set and valid. Invalid or missing parameters can cause errors.
  • If the workflow to get is not found, the node throws an error indicating the workflow could not be found. Verify the workflow ID or file name is correct.
  • Authentication errors may occur if the GitHub App credentials are not properly configured or the installation token cannot be obtained. Verify the GitHub App credentials and permissions.

Links

Discussion