Get Repository Content with GitHub API

Pipedream makes it easy to connect APIs for GitHub and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Get Repository Content with the GitHub API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Get Repository Content with the GitHub API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Get Repository Content action
1. Connect your GitHub account
2. Select a Repository
3. Optional- Configure Path
4. Optional- Select a Media Type
5. Optional- Select a Branch
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Get Repository Content with GitHub API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + GitHub

Try it

Get Repository Content with GitHub API on New Item in Feed from RSS API

RSS + GitHub

Try it

Get Repository Content with GitHub API on New Message in Channel from Discord Bot API

Discord Bot + GitHub

Try it

Get Repository Content with GitHub API on New Submission from Typeform API

Typeform + GitHub

Try it

Get Repository Content with GitHub API on Custom Events from Zoom API

Zoom + GitHub

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Get Repository Content on GitHub

Description:Get the content of a file or directory in a specific repository. [See the documentation](https://docs.github.com/en/rest/repos/contents#get-repository-content)

Version:0.1.0

Key:github-get-repository-content

View on GitHub

Code#

import github from "../../github.app.mjs";

export default {
  key: "github-get-repository-content",
  name: "Get Repository Content",
  description: "Get the content of a file or directory in a specific repository. [See the documentation](https://docs.github.com/en/rest/repos/contents#get-repository-content)",
  version: "0.1.0",
  type: "action",
  props: {
    github,
    repoFullname: {
      propDefinition: [
        github,
        "repoFullname",
      ],
    },
    path: {
      label: "Path",
      description: "The file path or directory to retrieve. Defaults to the repository's root directory.",
      type: "string",
      default: "",
      optional: true,
    },
    mediaType: {
      label: "Media Type",
      description: "The media type of the response. [See the documentation](https://docs.github.com/en/rest/repos/contents?apiVersion=2022-11-28#get-repository-content) for more information.",
      type: "string",
      options: [
        {
          value: "application/vnd.github.raw+json",
          label: "Returns the raw file contents for files and symlinks",
        },
        {
          value: "application/vnd.github.html+json",
          label: "Returns the file contents in HTML",
        },
        {
          value: "application/vnd.github.object+json",
          label: "Returns the contents in a consistent object format regardless of the content type",
        },
      ],
      optional: true,
    },
    branch: {
      propDefinition: [
        github,
        "branch",
        (c) => ({
          repoFullname: c.repoFullname,
        }),
      ],
      description:
        "The branch to use. Defaults to the repository's default branch (usually `main` or `master`)",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.github.getRepoContent({
      repoFullname: this.repoFullname,
      path: this.path,
      mediaType: this.mediaType,
      params: {
        ref: this.branch?.split?.("/")[0],
      },
    });

    $.export("$summary", "Successfully retrieved repository content.");

    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
GitHub	`github`	`app`	This component uses the GitHub app.
Repository	`repoFullname`	`string`	Select a value from the drop down menu.
Path	`path`	`string`	The file path or directory to retrieve. Defaults to the repository's root directory.
Media Type	`mediaType`	`string`	Select a value from the drop down menu:`{ "value": "application/vnd.github.raw+json", "label": "Returns the raw file contents for files and symlinks" }{ "value": "application/vnd.github.html+json", "label": "Returns the file contents in HTML" }{ "value": "application/vnd.github.object+json", "label": "Returns the contents in a consistent object format regardless of the content type" }`
Branch	`branch`	`string`	Select a value from the drop down menu.

Authentication#

GitHub uses OAuth authentication. When you connect your GitHub account, Pipedream will open a popup window where you can sign into GitHub and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any GitHub API.

Pipedream requests the following authorization scopes when you connect your account:

repoadmin:orgadmin:public_keyadmin:org_hookgistprojectnotificationsuserwrite:discussionwrite:packagesread:packagesadmin:repo_hook

Try it

New Card in Column (Classic Projects) from the GitHub API

Emit new event when a (classic) project card is created or moved to a specific column. For Projects V2 use New Issue with Status trigger. More information here

Try it

New Collaborator from the GitHub API

Emit new event when a collaborator is added

Try it

New Commit from the GitHub API

Emit new event when commits are pushed to a branch

Try it

New Commit Comment from the GitHub API

Emit new event when a commit comment is created

Try it