GitHub upload using GraphQL

.changeset/stale-forks-love.md

@@ -0,0 +1,5 @@
+---
+'skuba': minor
+---
+
+Git: Add [fastForwardBranch](https://seek-oss.github.io/skuba/docs/development-api/git.html#fastForwardBranch) function

.changeset/thin-carrots-burn.md

@@ -0,0 +1,7 @@
+---
+'skuba': minor
+---
+
+GitHub: Add functions to create and push verified commits using the GitHub GraphQL API
+
+See our [GitHub API documentation](https://seek-oss.github.io/skuba/docs/development-api/github.html#commitAndPush) for more information.

.changeset/unlucky-kings-provide.md

@@ -0,0 +1,5 @@
+---
+'skuba': patch
+---
+
+lint: Use GitHub GraphQL API to push verified autofix commits

docs/cli/lint.md

@@ -60,6 +60,8 @@ you can limit this with the `--serial` flag.
 | `--debug`  | Enable debug console output (implies `--serial`) |
 | `--serial` | Force serial execution of linting operations     |
 
+[GitHub autofixes] are enabled when CI and GitHub environment variables are present.
+
 ### Annotations
 
 `skuba lint` can automatically emit annotations in CI.
@@ -74,6 +76,7 @@ you can limit this with the `--serial` flag.
 [eslint-config-seek]: https://github.com/seek-oss/eslint-config-seek
 [eslint]: https://eslint.org/
 [github annotations]: ../deep-dives/github.md#github-annotations
+[github autofixes]: ../deep-dives/github.md#github-autofixes
 [prescribes eslint]: https://tech-strategy.ssod.skinfra.xyz/docs/v1/technology.html#typescript
 [prettier]: https://prettier.io/
 [tsc]: https://www.typescriptlang.org/docs/handbook/compiler-options.html

docs/development-api/git.md

@@ -45,6 +45,24 @@ const currentBranch = Git.currentBranch({ dir });
 
 ---
 
+## fastForwardBranch
+
+Fast forwards the specified `ref` from the remote to the local Git repository
+
+Currently, only GitHub app tokens are supported as an auth mechanism.
+
+```typescript
+import { Git } from 'skuba';
+
+await Git.fastForwardBranch({
+  auth: { type: 'gitHubApp' },
+  dir,
+  ref: 'branch-name',
+});
+```
+
+---
+
 ## getChangedFiles
 
 Returns all the files which have been added, modified or deleted in the working directory of the local Git repository since the last commit.

docs/development-api/github.md

@@ -20,6 +20,53 @@ const buildName = GitHub.buildNameFromEnvironment();
 
 ---
 
+## commitAndPush
+
+Commits and pushes file changes from the local workspace to a specified GitHub branch.
+
+Commits pushed using this method appear verified on GitHub.
+
+```typescript
+import { GitHub } from 'skuba';
+
+const commitId = await GitHub.commitAndPush({
+  dir: './',
+  branch: 'some-branch',
+  fileChanges: {
+    additions: [{ contents: '', path: 'another-path' }],
+    deletions: [{ path: 'some-path' }],
+  },
+  messageHeadline: 'some-commit',
+  messageBody: 'extra-body',
+  updateLocal: true, // Updates the local Git repository to reflect the new remote branch state
+});
+```
+
+---
+
+## commitAndPushAllChanges
+
+Retrieves all file changes from the local Git repository using [getChangedFiles],
+then commits and pushes the changes to a specified GitHub branch using [commitAndPush](#commitandpush).
+
+Commits pushed using this method appear verified on GitHub.
+
+`undefined` is returned instead of a commit ID when there are no changes to push.
+
+```typescript
+import { GitHub } from 'skuba';
+
+const commitId = await GitHub.commitAndPushAllChanges({
+  dir: './',
+  branch: 'some-branch',
+  messageHeadline: 'some-commit',
+  messageBody: 'extra-body',
+  updateLocal: true, // Updates the local Git repository to reflect the new remote branch state
+});
+```
+
+---
+
 ## createCheckRun
 
 Asynchronously creates a GitHub [check run] with annotations.
@@ -119,5 +166,23 @@ await GitHub.putIssueComment({
 
 ---
 
+## mapChangedFilesToFileChanges
+
+Maps changed files from [getChangedFiles] to GitHub GraphQL [file changes]
+
+```typescript
+import { GitHub } from 'skuba';
+
+const fileChanges = await GitHub.mapChangedFilesToFileChanges([
+  { path: 'added-path', state: 'added' },
+  { path: 'modified-path', state: 'modified' },
+  { path: 'delete-path', state: 'deleted' },
+]);
+```
+
+---
+
 [check run]: https://docs.github.com/en/rest/reference/checks#runs
+[file changes]: https://docs.github.com/en/graphql/reference/input-objects#filechanges
+[getchangedfiles]: ./git.md#getchangedfiles
 [github guide]: ../deep-dives/github.md

package.json

@@ -6,6 +6,8 @@
     "url": "https://github.com/seek-oss/skuba/issues"
   },
   "dependencies": {
+    "@octokit/graphql": "^4.8.0",
+    "@octokit/graphql-schema": "^10.73.0",
     "@octokit/rest": "^18.12.0",
     "@octokit/types": "^6.34.0",
     "@types/jest": "^28.0.0",
@@ -63,6 +65,7 @@
     "@types/supertest": "2.0.12",
     "enhanced-resolve": "5.9.3",
     "express": "4.18.1",
+    "graphql-tag": "2.12.6",
     "jsonfile": "6.1.0",
     "koa": "2.13.4",
     "memfs": "3.4.4",

src/api/git/index.ts

@@ -5,4 +5,5 @@ export { getChangedFiles } from './getChangedFiles';
 export { getHeadCommitId, getHeadCommitMessage } from './log';
 export { getOwnerAndRepo } from './remote';
 export { push } from './push';
+export { fastForwardBranch } from './pull';
 export { reset } from './reset';

src/api/git/pull.test.ts

@@ -0,0 +1,42 @@
+import git from 'isomorphic-git';
+
+import { fastForwardBranch } from './pull';
+
+jest.mock('isomorphic-git');
+
+afterEach(jest.resetAllMocks);
+
+describe('fastForwardBranch', () => {
+  it('propagates props to isomorphic-git', async () => {
+    jest
+      .mocked(git.listRemotes)
+      .mockResolvedValue([
+        { remote: 'origin', url: '[email protected]:seek-oss/skuba.git' },
+      ]);
+
+    await fastForwardBranch({
+      auth: { token: 'abc', type: 'gitHubApp' },
+      dir: '/workdir/skuba',
+      ref: 'c'.repeat(40),
+      remoteRef: 'feature-a',
+    });
+
+    expect(git.fastForward).toHaveBeenCalledTimes(1);
+    expect(jest.mocked(git.fastForward).mock.calls[0][0]).toMatchInlineSnapshot(
+      { http: expect.any(Object), fs: expect.any(Object) },
+      `
+      Object {
+        "dir": "/workdir/skuba",
+        "fs": Any<Object>,
+        "http": Any<Object>,
+        "onAuth": [Function],
+        "ref": "cccccccccccccccccccccccccccccccccccccccc",
+        "remote": undefined,
+        "remoteRef": "feature-a",
+        "singleBranch": true,
+        "url": "https://github.com/seek-oss/skuba",
+      }
+    `,
+    );
+  });
+});

src/api/git/pull.ts

@@ -0,0 +1,75 @@
+import fs from 'fs-extra';
+import git from 'isomorphic-git';
+import http from 'isomorphic-git/http/node';
+
+import { apiTokenFromEnvironment } from '../github/environment';
+
+import { getOwnerAndRepo } from './remote';
+
+/**
+ * Use a GitHub app token to auth the Git push.
+ *
+ * This defaults to the `GITHUB_API_TOKEN` and `GITHUB_TOKEN` environment
+ * variables if `token` is not provided.
+ */
+interface GitHubAppAuth {
+  type: 'gitHubApp';
+  token?: string;
+}
+
+interface PullParameters {
+  /**
+   * The auth mechanism for the push.
+   *
+   * Currently, only GitHub app tokens are supported.
+   */
+  auth: GitHubAppAuth;
+
+  dir: string;
+
+  /**
+   * The branch to merge into
+   */
+  ref: string;
+
+  remote?: string;
+
+  /**
+   * The destination branch or tag on the remote.
+   *
+   * This defaults to `ref`.
+   */
+  remoteRef?: string;
+}
+
+/**
+ * Fast forwards the local branch to the remote state
+ */
+export const fastForwardBranch = async ({
+  auth,
+  dir,
+  ref,
+  remote,
+  remoteRef,
+}: PullParameters) => {
+  const { owner, repo } = await getOwnerAndRepo({ dir });
+
+  const url = `https://github.com/${encodeURIComponent(
+    owner,
+  )}/${encodeURIComponent(repo)}`;
+
+  return git.fastForward({
+    onAuth: () => ({
+      username: 'x-access-token',
+      password: auth.token ?? apiTokenFromEnvironment(),
+    }),
+    dir,
+    fs,
+    http,
+    ref,
+    remote,
+    remoteRef,
+    url,
+    singleBranch: true,
+  });
+};

src/api/github/index.ts

@@ -4,3 +4,8 @@ export { createCheckRun } from './checkRun';
 export { enabledFromEnvironment } from './environment';
 export { getPullRequestNumber } from './pullRequest';
 export { putIssueComment } from './issueComment';
+export {
+  commitAndPush,
+  commitAndPushAllChanges,
+  mapChangedFilesToFileChanges,
+} from './push';