Rerun Workflow with CircleCI API on New Branch Created from GitHub API

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

Trigger workflow on

New Branch Created from the GitHub API

Next, do this

Rerun Workflow with the CircleCI 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 CircleCI action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Branch Created trigger
1. Connect your GitHub account
2. Select a Repository
Configure the Rerun Workflow action
1. Connect your CircleCI account
2. Configure Project Slug
3. Select a Pipeline ID
4. Select a Workflow ID
5. Optional- Configure Enable SSH
6. Optional- Configure From Failed
7. Optional- Select one or more Jobs
8. Optional- Configure Sparse Tree
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 Branch Created on GitHub

Description:Emit new event when a branch is created.

Version:1.0.11

Key:github-new-branch

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-branch",
  name: "New Branch Created",
  description: "Emit new event when a branch is created.",
  version: "1.0.11",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getSampleTimerEvent,
    getSampleWebhookEvent,
    getWebhookEvents() {
      return [
        "create",
      ];
    },
    shouldEmitWebhookEvent(body) {
      return body?.ref_type === "branch";
    },
    getId(item) {
      return item.ref ?? item.name;
    },
    getSummary(item) {
      return `New branch: ${this.getId(item)}`;
    },
    getPollingData(args) {
      return this.github.getBranches(args);
    },
    getHttpDocsLink() {
      return "https://docs.github.com/en/webhooks/webhook-events-and-payloads#create";
    },
    getTimerDocsLink() {
      return "https://docs.github.com/en/rest/branches/branches?apiVersion=2022-11-28#list-branches";
    },
  },
};

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#

Rerun Workflow on CircleCI

Description:Reruns the specified workflow. [See the documentation](https://circleci.com/docs/api/v2/index.html#tag/Workflow/operation/rerunWorkflow)

Version:0.0.2

Key:circleci-rerun-workflow

View on GitHub

CircleCI Overview#

The CircleCI API allows for seamless integration and automation of your CI/CD pipeline. By leveraging the API through Pipedream, you can trigger builds, monitor the status of pipelines, fetch build artifacts, and interact with various aspects of your CircleCI projects. This facilitates the creation of dynamic workflows that can streamline development practices, enhance deployment strategies, and ensure continuous integration processes are more efficient and less error-prone.

Action Code#

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

export default {
  key: "circleci-rerun-workflow",
  name: "Rerun Workflow",
  description: "Reruns the specified workflow. [See the documentation](https://circleci.com/docs/api/v2/index.html#tag/Workflow/operation/rerunWorkflow)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    circleci,
    projectSlug: {
      propDefinition: [
        circleci,
        "projectSlug",
      ],
    },
    pipelineId: {
      propDefinition: [
        circleci,
        "pipelineId",
        (c) => ({
          projectSlug: c.projectSlug,
        }),
      ],
    },
    workflowId: {
      propDefinition: [
        circleci,
        "workflowId",
        (c) => ({
          pipelineId: c.pipelineId,
        }),
      ],
    },
    enableSsh: {
      type: "boolean",
      label: "Enable SSH",
      description: "Whether to enable SSH access for the triggering user on the newly-rerun job. Requires the jobs parameter to be used and so is mutually exclusive with the from_failed parameter.",
      optional: true,
    },
    fromFailed: {
      type: "boolean",
      label: "From Failed",
      description: "Whether to rerun the workflow from the failed job. Mutually exclusive with the jobs parameter.",
      optional: true,
    },
    jobIds: {
      propDefinition: [
        circleci,
        "jobIds",
        (c) => ({
          workflowId: c.workflowId,
        }),
      ],
    },
    sparseTree: {
      type: "boolean",
      label: "Sparse Tree",
      description: "",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.circleci.rerunWorkflow({
      $,
      workflowId: this.workflowId,
      data: {
        enable_ssh: this.enableSsh,
        from_failed: this.fromFailed,
        jobs: typeof this.jobIds === "string"
          ? JSON.parse(this.jobIds)
          : this.jobIds,
        sparse_tree: this.sparseTree,
      },
    });
    $.export("$summary", `Successfully started a rerun of workflow with ID: ${this.workflowId}`);
    return response;
  },
};

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
CircleCI	`circleci`	`app`	This component uses the CircleCI app.
Project Slug	`projectSlug`	`string`	Project slug in the form `vcs-slug/org-name/repo-name` (found in Project Settings)
Pipeline ID	`pipelineId`	`string`	Select a value from the drop down menu.
Workflow ID	`workflowId`	`string`	Select a value from the drop down menu.
Enable SSH	`enableSsh`	`boolean`	Whether to enable SSH access for the triggering user on the newly-rerun job. Requires the jobs parameter to be used and so is mutually exclusive with the from_failed parameter.
From Failed	`fromFailed`	`boolean`	Whether to rerun the workflow from the failed job. Mutually exclusive with the jobs parameter.
Jobs	`jobIds`	`string[]`	Select a value from the drop down menu.
Sparse Tree	`sparseTree`	`boolean`

Rerun Workflow with CircleCI API on New Branch Created from GitHub API

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

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

Developers ♥ Pipedream

1-24of2,800+apps by most popular

1
-
24
of
2,800+
apps by most popular