JSPM

new-github-release-url

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 744970
  • Score
    100M100P100Q195747F
  • License MIT

Generate a URL for opening a new GitHub release with prefilled tag, body, and other fields

Package Exports

  • new-github-release-url

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (new-github-release-url) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

new-github-release-url Build Status

Generate a URL for opening a new GitHub release with prefilled tag, body, and other fields

GitHub supports prefilling a new release by setting certain search parameters. This package simplifies generating such URL.

Install

$ npm install new-github-release-url

Usage

const newGithubReleaseUrl = require('new-github-release-url');
const open = require('open');

const url = newGithubReleaseUrl({
    user: 'sindresorhus',
    repo: 'new-github-release-url',
    body: '\n\n\n---\nI\'m a human. Please be nice.'
});
//=> 'https://github.com/sindresorhus/new-github-release-url/releases/new?body=%0A%0A%0A---%0AI%27m+a+human.+Please+be+nice.'

// Then open it
open(url);

API

newGithubReleaseUrl(options)

Returns a URL string.

options

Type: object

You are required to either specify the repoUrl option or both the user and repo options.

repoUrl

Type: string

The full URL to the repo.

user

Type: string

GitHub username or organization.

repo

Type: string

GitHub repo.

tag

Type: string

The tag name of the release.

target

Type: string
Default: The default branch

The branch name or commit SHA to point the release's tag at, if the tag doesn't already exist.

title

Type: string

The title of the release.

GitHub shows the tag name when not specified.

body

Type: string

The description text of the release.

isPrerelease

Type: boolean
Default: false

Whether the release should be marked as a pre-release.

  • new-github-issue-url - Generate a URL for opening a new GitHub issue with prefilled title, body, and other fields

License

MIT © Sindre Sorhus