Skip to content
github-pages publishing plugin for semantic-release
TypeScript JavaScript
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src test: tune up context mocks Aug 1, 2019
.gitignore
.travis.yml ci: up yarn version Jul 25, 2019
CHANGELOG.md chore(release): 1.10.5 [skip ci] Aug 1, 2019
LICENSE doc(license): update copyrights Mar 1, 2019
README.md docs(readme): extend usage example Aug 8, 2019
jest.config.json refactor: migrate to maven dir layout Jul 16, 2019
package.json chore(package): up deps Aug 8, 2019
renovate.json chore(deps): add renovate.json (#36) Jun 16, 2019
tsconfig.es5.json build: tune up tsconfig Jul 17, 2019
tsconfig.es6.json build: tune up tsconfig Jul 17, 2019
tsconfig.json
tsconfig.test.json
tslint.json style: tune up lint runner Apr 1, 2019
typedoc.json docs: configure self-publishing Jul 16, 2019
yarn.lock chore(package): up deps Aug 8, 2019

README.md

@qiwi/semantic-release-gh-pages-plugin

Build Status npm (tag) dependencyStatus Test Coverage Maintainability Greenkeeper badge CodeStyle

gh-pages publishing plugin for semantic-release

Step Description
verifyConditions Verify the presence of the GH_TOKEN set via environment variables.
publish Pushes commit to the documentation branch

Install

yarn add @qiwi/semantic-release-gh-pages-plugin --dev

or

npm add @qiwi/semantic-release-gh-pages-plugin -D

Usage

Describe plugin configuration in package.json / .releaserc.js

{
  "release": {
    "branch": "master",
    "verifyConditions": [
      "@semantic-release/changelog",
      "@semantic-release/npm",
      "@semantic-release/git",
      "@qiwi/semantic-release-gh-pages-plugin"
    ],
    "publish": [
      "@semantic-release/npm",
      "@semantic-release/github",
      {
        "path": "@qiwi/semantic-release-gh-pages-plugin",
        "msg": "updated",
        "branch": "docs"
      }
    ]
  }
}

or even shorter if default settings are used:

{
  "release": {
    "branch": "master",
    "plugins": [
      "@semantic-release/release-notes-generator",
      "@semantic-release/changelog",
      "@semantic-release/git",
      "@semantic-release/github",
      "@semantic-release/npm",
      "@qiwi/semantic-release-gh-pages-plugin"
    ]
  }
}

Configuration

Environment variables
Variable Description
GH_TOKEN or GITHUB_TOKEN Required. The token used to authenticate with GitHub.
Options
Option Description Default
msg Commit message template updated v{{=it.nextRelease.gitTag}}
src Documentation directory docs

NOTE don't forget to run docs builder (yarn docs, yarn typedoc, etc) as a part of your build step or any other way
dst Destination directory . (root)
branch Docs branch to push gh-pages
repositoryUrl Repository url inherited from .git
enterprise Disables host assertion for GitHub Enterprise domains false
You can’t perform that action at this time.