@joedoyle23/semantic-release-github-pullrequest v0.1.1

semantic-release-github-pullrequest

This plugin is a plugin for semantic-release.

It automatically creates a pull request containing changes for any files you want to publish in your repository, like release notes of your newly published release.

Install

Add the plugin to your npm-project:

npm install semantic-release-github-pullrequest -D

Usage

The plugin can be configured in the semantic-release configuration file:

{
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    [
      "semantic-release-github-pullrequest", {
        "assets": ["CHANGELOG.md"],
        "baseRef": "main"
      }
    ]
  ]
}

With this example, a GitHub pull request will be created, with the content of CHANGELOG.md file, on the main branch.

Configuration

GitHub authentication

The GitHub authentication configuration is required and can be set via environment variables.

Follow the Creating a personal access token for the command line documentation to obtain an authentication token. The token has to be made available in your CI environment via the GH_TOKEN_RELEASE or GH_TOKEN environment variable. The user associated with the token must have push permission to the repository.

When creating the token, the minimum required scopes are:

• repo for a private repository
• public_repo for a public repository

Note on GitHub Actions: You can use the default token which is provided in the secret GITHUB_TOKEN. However no workflows will be triggered in the Pull Request, providing it to be merged. You can use GH_TOKEN or GITHUB_TOKEN with the secret GITHUB_TOKEN to create the release, and use GH_TOKEN_RELEASE with this plugin to create the Pull Request.

Environment variables

Options

proxy

Can be false, a proxy URL or an Object with the following properties:

See node-https-proxy-agent and node-http-proxy-agent for additional details.

proxy examples

'http://168.63.76.32:3128': use the proxy running on host 168.63.76.32 and port 3128 for each GitHub API request. {host: '168.63.76.32', port: 3128, headers: {Foo: 'bar'}}: use the proxy running on host 168.63.76.32 and port 3128 for each GitHub API request, setting the Foo header value to bar.

assets

Can be a glob or and Array of globs and Objects with the following properties:

Each entry in the assets Array is globbed individually. A glob can be a String ("dist/**/*.js" or "dist/mylib.js") or an Array of Strings that will be globbed together (["dist/**", "!**/*.css"]).

If a directory is configured, all the files under this directory and its children will be included.

The name and label for each assets are generated with Lodash template. The following variables are available:

Note: If a file has a match in assets it will be included even if it also has a match in .gitignore.

pullrequestTitle

The title of the pull request is generated with Lodash template. The following variables are available: