Create Pull Request with GitHub API on New Analysis Completed (Instant) from SonarCloud API

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

Trigger workflow on

New Analysis Completed (Instant) from the SonarCloud API

Next, do this

Create Pull Request 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#

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

Select this integration
Configure the New Analysis Completed (Instant) trigger
1. Connect your SonarCloud account
2. Configure Name
3. Select a Organization
4. Optional- Select a Project
Configure the Create Pull Request action
1. Connect your GitHub account
2. Select a Base Repository
3. Select a Base Branch
4. Select a Head Repository
5. Select a Head Branch
6. Optional- Configure Body
7. Optional- Configure Maintainers Can Modify
8. Optional- Configure Is Draft
9. Optional- Configure Title
10. Optional- Select a Issue
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 Analysis Completed (Instant) on SonarCloud

Description:Emit new event when a new analisys is completed.

Version:0.0.1

Key:sonarcloud-new-analysis-completed-instant

View on GitHub

SonarCloud Overview#

The SonarCloud API facilitates automated code quality checks and security vulnerability assessments. By integrating with Pipedream, developers can harness this power within serverless workflows, triggering actions based on code analysis results, monitoring project metrics, and automating project management tasks. The API allows for enhanced productivity by connecting code quality data with other services and tools, streamlining the development process.

Trigger Code#

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

export default {
  key: "sonarcloud-new-analysis-completed-instant",
  name: "New Analysis Completed (Instant)",
  description: "Emit new event when a new analisys is completed.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    sonarcloud,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
    name: {
      type: "string",
      label: "Name",
      description: "Name displayed in the administration console of webhooks.",
    },
    organization: {
      propDefinition: [
        sonarcloud,
        "organization",
      ],
    },
    project: {
      propDefinition: [
        sonarcloud,
        "project",
        ({ organization }) => ({
          organization,
        }),
      ],
      optional: true,
    },
  },
  hooks: {
    async activate() {
      const { webhook } = await this.sonarcloud.createWebhook({
        params: {
          name: this.name,
          organization: this.organization,
          project: this.project,
          url: this.http.endpoint,
        },
      });
      this.db.set("hookId", webhook.key);
    },
    async deactivate() {
      await this.sonarcloud.deleteWebhook({
        params: {
          webhook: this.db.get("hookId"),
        },
      });
    },
  },
  async run(event) {
    this.http.respond({
      status: 200,
    });

    const { body } = event;

    this.$emit(body, {
      id: body.revision,
      summary: `New analisys completed with revision key: ${body.revision}`,
      ts: Date.parse(body.changedAt),
    });
  },
};

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
SonarCloud	`sonarcloud`	`app`	This component uses the SonarCloud app.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Name	`name`	`string`	Name displayed in the administration console of webhooks.
Organization	`organization`	`string`	Select a value from the drop down menu.
Project	`project`	`string`	Select a value from the drop down menu.

Trigger Authentication#

SonarCloud uses API keys for authentication. When you connect your SonarCloud account, Pipedream securely stores the keys so you can easily authenticate to SonarCloud APIs in both code and no-code steps.

About SonarCloud#

SonarCloud is the leading online service for Code Quality & Security. Free analysis for open-source projects covering 24 languages.

Action#

Create Pull Request on GitHub

Description:Creates a new pull request for a specified repository. [See the documentation](https://docs.github.com/en/rest/pulls/pulls#create-a-pull-request)

Version:0.1.2

Key:github-create-pull-request

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.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import github from "../../github.app.mjs";

export default {
  key: "github-create-pull-request",
  name: "Create Pull Request",
  description: "Creates a new pull request for a specified repository. [See the documentation](https://docs.github.com/en/rest/pulls/pulls#create-a-pull-request)",
  version: "0.1.2",
  type: "action",
  props: {
    github,
    repoFullname: {
      propDefinition: [
        github,
        "repoFullname",
      ],
      label: "Base Repository",
      description: "The base repository, where the pull request will be created.",
    },
    base: {
      propDefinition: [
        github,
        "branch",
        (c) => ({
          repoFullname: c.repoFullname,
        }),
      ],
      label: "Base Branch",
      description: "The base branch, where the changes will be received.",
    },
    headRepo: {
      propDefinition: [
        github,
        "repoFullname",
      ],
      label: "Head Repository",
      description: "The head repository, where the changes originate from. This can, but does not have to, be the same repository.",
    },
    head: {
      propDefinition: [
        github,
        "branch",
        (c) => ({
          repoFullname: c.headRepo,
        }),
      ],
      label: "Head Branch",
      description: "The head branch, where the changes originate from",
    },
    body: {
      label: "Body",
      description: "The text description of the pull request.",
      type: "string",
      optional: true,
    },
    maintainerCanModify: {
      label: "Maintainers Can Modify",
      description: "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.",
      type: "boolean",
      optional: true,
    },
    draft: {
      label: "Is Draft",
      description: "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.",
      type: "boolean",
      optional: true,
    },
    title: {
      label: "Title",
      description: "The title of the pull request.",
      type: "string",
      optional: true,
    },
    issue: {
      propDefinition: [
        github,
        "issueNumber",
        (c) => ({
          repoFullname: c.repoFullname,
        }),
      ],
      label: "Issue",
      description: "An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request.",
      min: 1,
      optional: true,
    },
  },
  async run({ $ }) {

    if (!this.issue && !this.title) {
      throw new ConfigurationError("Title is required if Issue is unspecified. You can either specify a new pull request with Title or convert an existing issue to a pull request with Issue.");
    }

    if (this.issue && this.title) {
      throw new ConfigurationError("You can't specify both Title and Issue at the same time.");
    }

    const data = {
      title: this.title,
      head: this.head.split("/")[1],
      base: this.base.split("/")[1],
      head_repo: this.headRepo,
      body: this.body,
      maintainer_can_modify: this.maintainerCanModify,
      draft: this.draft,
      issue: this.issue,
    };

    const response = await this.github.createPullRequest({
      owner: this.owner,
      repoFullname: this.repoFullname,
      data: data,
    });

    $.export("$summary", `Successfully created pull request: ${response.title}.`);

    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
GitHub	`github`	`app`	This component uses the GitHub app.
Base Repository	`repoFullname`	`string`	Select a value from the drop down menu.
Base Branch	`base`	`string`	Select a value from the drop down menu.
Head Repository	`headRepo`	`string`	Select a value from the drop down menu.
Head Branch	`head`	`string`	Select a value from the drop down menu.
Body	`body`	`string`	The text description of the pull request.
Maintainers Can Modify	`maintainerCanModify`	`boolean`	Indicates whether maintainers can modify the pull request.
Is Draft	`draft`	`boolean`	Indicates whether the pull request is a draft. See "Draft Pull Requests" in the GitHub Help documentation to learn more.
Title	`title`	`string`	The title of the pull request.
Issue	`issue`	`integer`	Select a value from the drop down menu.

Action 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

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.

More Ways to Connect GitHub + SonarCloud#

Other Popular Integrations#

Create Branch with GitHub API on New Analysis Completed (Instant) from SonarCloud API

SonarCloud + GitHub

Create Pull Request with GitHub API on New Analysis Completed (Instant) from SonarCloud API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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