Upload File with Google Drive API on New Fork from GitHub API

Pipedream makes it easy to connect APIs for Google Drive, GitHub and 3,000+ other apps remarkably fast.

Trigger workflow on

New Fork from the GitHub API

Next, do this

Upload File with the Google Drive 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#

This integration creates a workflow with a GitHub trigger and Google Drive action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Fork trigger
1. Connect your GitHub account
2. Select a Repository
Configure the Upload File action
1. Connect your Google Drive account
2. Optional- Select a Drive
3. Optional- Select a Folder
4. Configure File Path or URL
5. Optional- Configure Name
6. Optional- Select a Mime Type
7. Optional- Select a Upload Type
8. Optional- Select a File to replace
9. Optional- Configure Metadata
10. Optional- Configure syncDir
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Fork on GitHub

Description:Emit new event when a repository is forked

Version:1.0.12

Key:github-new-fork

View on GitHub

GitHub Overview#

The GitHub API is a powerful gateway to interaction with GitHub's vast web of data and services, offering a suite of endpoints to manipulate and retrieve information on repositories, pull requests, issues, and more. Harnessing this API on Pipedream, you can orchestrate automated workflows that respond to events in real-time, manage repository data, streamline collaborative processes, and connect GitHub with other services for a more integrated development lifecycle.

Trigger Code#

import common from "../common/common-flex.mjs";
import {
  getSampleTimerEvent, getSampleWebhookEvent,
} from "./common-sample-events.mjs";

export default {
  ...common,
  key: "github-new-fork",
  name: "New Fork",
  description: "Emit new event when a repository is forked",
  version: "1.0.12",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getSampleTimerEvent,
    getSampleWebhookEvent,
    getWebhookEvents() {
      return [
        "fork",
      ];
    },
    shouldEmitWebhookEvent(body) {
      return !!body?.forkee;
    },
    getWebhookEventItem(body) {
      return body.forkee;
    },
    getSummary(item) {
      return `New fork: "${item.name}"`;
    },
    getPollingData(args) {
      return this.github.getRepositoryForks(args);
    },
    getHttpDocsLink() {
      return "https://docs.github.com/en/webhooks/webhook-events-and-payloads#fork";
    },
    getTimerDocsLink() {
      return "https://docs.github.com/en/rest/repos/forks?apiVersion=2022-11-28#list-forks";
    },
  },
};

Trigger 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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger 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:

reporead:orgadmin:org_hookgistprojectnotificationsread:userwrite:discussionadmin:repo_hook

About GitHub#

Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.

Action#

Upload File on Google Drive

Description:Upload a file to Google Drive. [See the documentation](https://developers.google.com/drive/api/v3/manage-uploads) for more information

Version:2.0.8

Key:google_drive-upload-file

View on GitHub

Google Drive Overview#

The Google Drive API on Pipedream allows you to automate various file management tasks, such as creating, reading, updating, and deleting files within your Google Drive. You can also share files, manage permissions, and monitor changes to files and folders. This opens up possibilities for creating workflows that seamlessly integrate with other apps and services, streamlining document handling, backup processes, and collaborative workflows.

Action Code#

import {
  ConfigurationError,
  getFileStreamAndMetadata,
} from "@pipedream/platform";
import { GOOGLE_DRIVE_UPLOAD_TYPE_MULTIPART } from "../../common/constants.mjs";
import {
  omitEmptyStringValues,
  parseObjectEntries,
} from "../../common/utils.mjs";
import googleDrive from "../../google_drive.app.mjs";

export default {
  key: "google_drive-upload-file",
  name: "Upload File",
  description: "Upload a file to Google Drive. [See the documentation](https://developers.google.com/drive/api/v3/manage-uploads) for more information",
  version: "2.0.8",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    googleDrive,
    drive: {
      propDefinition: [
        googleDrive,
        "watchedDrive",
      ],
      optional: true,
    },
    parentId: {
      propDefinition: [
        googleDrive,
        "folderId",
        (c) => ({
          drive: c.drive,
        }),
      ],
      description:
        "The folder you want to upload the file to. If not specified, the file will be placed directly in the drive's top-level folder.",
      optional: true,
    },
    filePath: {
      type: "string",
      label: "File Path or URL",
      description: "Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myFile.pdf).",
    },
    name: {
      propDefinition: [
        googleDrive,
        "fileName",
      ],
      description:
        "The name of the new file (e.g. `/myFile.csv`). By default, the name is the same as the source file's.",
    },
    mimeType: {
      propDefinition: [
        googleDrive,
        "mimeType",
      ],
      description:
        "The file's MIME type (e.g., `image/jpeg`). Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided.",
    },
    uploadType: {
      propDefinition: [
        googleDrive,
        "uploadType",
      ],
      default: GOOGLE_DRIVE_UPLOAD_TYPE_MULTIPART,
      optional: true,
    },
    fileId: {
      propDefinition: [
        googleDrive,
        "fileId",
      ],
      label: "File to replace",
      description: "ID of the file to replace. Leave it empty to upload a new file.",
      optional: true,
    },
    metadata: {
      type: "object",
      label: "Metadata",
      description: "Additional metadata to supply in the upload. [See the documentation](https://developers.google.com/workspace/drive/api/reference/rest/v3/files) for information on available fields. Values will be parsed as JSON where applicable. Example: `{ \"description\": \"my file description\" }`",
      optional: true,
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      parentId,
      filePath,
      name,
      mimeType,
    } = this;
    let { uploadType } = this;
    const driveId = this.googleDrive.getDriveId(this.drive);

    const {
      stream: file, metadata: fileMetadata,
    } = await getFileStreamAndMetadata(filePath);

    const filename = name || fileMetadata.name;

    const metadata = this.metadata
      ? parseObjectEntries(this.metadata)
      : undefined;

    if (metadata?.mimeType && !mimeType) {
      throw new ConfigurationError(`Please include the file's original MIME type in the \`Mime Type\` prop. File will be converted to \`${metadata.mimeType}\`.`);
    }

    let result = null;
    if (this.fileId) {
      await this.googleDrive.updateFileMedia(this.fileId, file, omitEmptyStringValues({
        mimeType,
        uploadType,
      }));
      result = await this.googleDrive.updateFile(this.fileId, omitEmptyStringValues({
        name: filename,
        mimeType,
        uploadType,
        requestBody: metadata,
      }));
      $.export("$summary", `Successfully updated file, "${result.name}"`);
    } else {
      result = await this.googleDrive.createFile(omitEmptyStringValues({
        file,
        mimeType,
        name: filename,
        parentId,
        driveId,
        uploadType,
        requestBody: metadata,
      }));
      $.export("$summary", `Successfully uploaded a new file, "${result.name}"`);
    }
    return result;
  },
};

Action Configuration#

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

Label	Prop	Type	Description
Google Drive	`googleDrive`	`app`	This component uses the Google Drive app.
Drive	`drive`	`string`	Select a value from the drop down menu.
Folder	`parentId`	`string`	Select a value from the drop down menu.
File Path or URL	`filePath`	`string`	Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myFile.pdf).
Name	`name`	`string`	The name of the new file (e.g. `/myFile.csv`). By default, the name is the same as the source file's.
Mime Type	`mimeType`	`string`	Select a value from the drop down menu.
Upload Type	`uploadType`	`string`	Select a value from the drop down menu:`{ "label": "Simple upload. Upload the media only, without any metadata.", "value": "media" }{ "label": "Resumable upload. Upload the file in a resumable fashion, using a series of at least two requests where the first request includes the metadata.", "value": "resumable" }{ "label": "Multipart upload. Upload both the media and its metadata, in a single request.", "value": "multipart" }`
File to replace	`fileId`	`string`	Select a value from the drop down menu.
Metadata	`metadata`	`object`	Additional metadata to supply in the upload. See the documentation for information on available fields. Values will be parsed as JSON where applicable. Example: `{ "description": "my file description" }`
syncDir	`syncDir`	`dir`

Action Authentication#

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

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

https://www.googleapis.com/auth/drive

Upload File with Google Drive API on New Fork from GitHub API

Pipedream makes it easy to connect APIs for Google Drive, GitHub and 3,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of3,000+apps by most popular

1
-
24
of
3,000+
apps by most popular