npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

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

v5.2.12

Published

gh-pages publishing plugin for semantic-release

Downloads

5,957

Readme

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

CI Test Coverage Maintainability npm (tag)

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
yarn add @qiwi/semantic-release-gh-pages-plugin --dev
# npm
npm i @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",
      [
        "@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 | docs updated <%= nextRelease.gitTag %> | | src | Documentation directory | docsNOTE 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 | | branches | Optional list of src-to-target branches association. If defined it suppresses branch option. For example, [['master', 'gh-pages'], ['beta', beta-docs]] | undefined | | repositoryUrl | Repository url | inherited from .git | | enterprise | Disables host assertion for GitHub Enterprise domains | false | | pullTagsBranch | Target branch for tags fetching hook. If '' empty string, skips this action | globalConfig.branch || master | | dotfiles | gh-pages dotfiles option | false | | add | gh-pages add option | false |

License

MIT