feat: add create-pr helper (#41)

.github/workflows/create-pr.yml

@@ -0,0 +1,22 @@
+name: Open Pull Request
+
+on:
+  push:
+    branches:
+      - create-pull-request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - uses: ./
+        with:
+          helper: create-pr
+          title: New PR
+          body: Implemented new feature. Added tests.
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
+permissions: write-all

README.md

@@ -15,6 +15,8 @@ Each of the following helpers are defined in a file of the same name in `src/hel
 ### [**assign-pr-reviewers**](.github/workflows/assign-pr-reviewers.yml)
   * Randomly assigns members of a github team to review a PR. If `login` is provided, it does nothing if that user is already part of the team
   * You can also pass a `slack_webhook_url` to notify the assignees that they are assigned to the PR!
+### [**create-pr**](.github/workflows/create-pr.yml)
+  * Opens a pull request
 ### [**create-project-card**](.github/workflows/create-project-card.yml)
   * Creates a Project card into your GitHub Project repository by providing a `project_name` and `project_destination_column_name` in which the card should be created.
   * If `note` is provided, it will add that information into the card. If it is not provided, it will use the PR information details to populate it.

action.yml

@@ -85,6 +85,9 @@ inputs:
   override_filter_globs:
     description: 'A list of file paths in glob syntax (newline/comma separated) that is used to override the filter'
     required: false
+  title:
+    description: 'An issue title'
+    required: false
 outputs:
   output:
     description: 'The output of the helper'

dist/action.yml

@@ -85,6 +85,9 @@ inputs:
   override_filter_globs:
     description: 'A list of file paths in glob syntax (newline/comma separated) that is used to override the filter'
     required: false
+  title:
+    description: 'An issue title'
+    required: false
 outputs:
   output:
     description: 'The output of the helper'

dist/index.js

@@ -18836,6 +18836,11 @@ var map = {
 		438,
 		956
 	],
+	"./create-pr": [
+		9150,
+		438,
+		150
+	],
 	"./create-pr-comment": [
 		3461,
 		438,
@@ -18846,6 +18851,11 @@ var map = {
 		438,
 		461
 	],
+	"./create-pr.ts": [
+		9150,
+		438,
+		150
+	],
 	"./create-project-card": [
 		6124,
 		438,

src/helpers/create-pr.ts

@@ -0,0 +1,34 @@
+/*
+Copyright 2021 Expedia, Inc.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    https://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { context } from '@actions/github';
+import { octokit } from '../octokit';
+
+interface CreatePR {
+  title: string;
+  body: string;
+}
+
+export const createPr = async ({ title, body }: CreatePR) => {
+  const {
+    data: { default_branch }
+  } = await octokit.repos.get({ ...context.repo });
+  return octokit.pulls.create({
+    title,
+    head: context.ref.replace('refs/heads/', ''),
+    base: default_branch,
+    body,
+    maintainer_can_modify: true,
+    ...context.repo
+  });
+};

test/helpers/create-pr.test.ts

@@ -0,0 +1,63 @@
+/*
+Copyright 2021 Expedia, Inc.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    https://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { Mocktokit } from '../types';
+import { context } from '@actions/github';
+import { createPr } from '../../src/helpers/create-pr';
+import { octokit } from '../../src/octokit';
+
+jest.mock('@actions/core');
+jest.mock('@actions/github', () => ({
+  context: { repo: { repo: 'repo', owner: 'owner' }, ref: 'refs/heads/source' },
+  getOctokit: jest.fn(() => ({
+    rest: {
+      repos: { get: jest.fn() },
+      pulls: { create: jest.fn() }
+    }
+  }))
+}));
+
+(octokit.repos.get as unknown as Mocktokit).mockImplementation(async () => ({
+  data: {
+    default_branch: 'default branch'
+  }
+}));
+
+describe('createPr', () => {
+  const title = 'title';
+  const body = 'body';
+
+  beforeEach(() => {
+    createPr({
+      title,
+      body
+    });
+  });
+
+  it('should call repos get with correct params', () => {
+    expect(octokit.repos.get).toHaveBeenCalledWith({ ...context.repo });
+  });
+
+  it('should call create with correct params', () => {
+    expect(octokit.pulls.create).toHaveBeenCalledWith({
+      title,
+      head: 'source',
+      base: 'default branch',
+      body,
+      maintainer_can_modify: true,
+      draft: undefined,
+      issue: undefined,
+      ...context.repo
+    });
+  });
+});