v5.1.0

Compare Source

Features

• add support for labels (#​131) (0295fd0)

v5.0.0

Compare Source

Features

• allow update function to trigger file deletion (#​130) (ac571dc)

BREAKING CHANGES

• The meaning of null has changed!

Previously the following snippet was causing a file deletion.

files: {
  "file/to/delete.txt": null
}

If you want to retain this behavior you must use the DELETE_FILE Symbol

import { createPullRequest, DELETE_FILE } from 'octokit-plugin-create-pull-request';

files: {
  "file/to/delete.txt": DELETE_FILE
}

If you want to trigger a file deletion from an update function, you can now do so by returning the deleteFile Symbol.

import { createPullRequest, DELETE_FILE } from 'octokit-plugin-create-pull-request';

files: {
  "file/to/delete.txt": ({ exists, encoding, content }) => {
    const fileContent = Buffer.from(content, encoding).toString("utf-8")

    if (fileContent.includes('abc')) {
      // trigger file deletion
      return DELETE_FILE
    }

    // do not alter file content
    return null;
  }
}

v4.2.2

Compare Source

Bug Fixes

• build: add script to fix package.json before publishing (#​127) (f961a6d)

v4.2.1

Compare Source

Bug Fixes

• run file update functions sequentially (#​128) (636cddf)

v4.2.0

Compare Source

Features

• add signature option (#​120) (3fe11f6)

v4.1.2

Compare Source

Bug Fixes

• deps: bump yaml and semantic-release (3064d0b)