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

v5.2.12

gh-pages publishing plugin for semantic-release For more information about how to use this package see README

Latest version published 11 months ago

License: MIT

NPM

GitHub

Package Health Score

67 / 100

security
No known security issues
popularity
Small
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
5.2.12	\|	01/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.1.1	\|	07/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.0.3	\|	08/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.0.0	\|	05/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.0.0	\|	05/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (1,226)

GitHub Stars: 23
Forks: 7
Contributors: 20

Direct Usage Popularity

The npm package @qiwi/semantic-release-gh-pages-plugin receives a total of 1,226 downloads a week. As such, we scored @qiwi/semantic-release-gh-pages-plugin popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package @qiwi/semantic-release-gh-pages-plugin, we found that it has been starred 23 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 20
Funding: No

With more than 10 contributors for the @qiwi/semantic-release-gh-pages-plugin repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 5
Open PR: 12
Last Release: 11 months ago
Last Commit: 10 months ago

Further analysis of the maintenance status of @qiwi/semantic-release-gh-pages-plugin based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that @qiwi/semantic-release-gh-pages-plugin demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 6 years
Dependencies: 16 Direct
Versions: 108
Install Size: 84.1 kB
Dist-tags: 20
# of Files: 27
Maintainers: 2
TS Typings: Yes

@qiwi/semantic-release-gh-pages-plugin has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

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

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	`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`
`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

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

@types/debug @types/git-url-parse @types/semantic-release @types/gh-pages @types/lodash @qiwi/substrate aggregate-error debug execa gh-pages git-url-parse lodash queuefy read-pkg then-request tslib

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

@qiwi/libdefkit @qiwi/npm-run-all @types/jest coveralls jest cpy-cli mkdirp rimraf ts-jest eslint eslint-config-prettier eslint-config-qiwi typedoc typescript

FAQs

What is @qiwi/semantic-release-gh-pages-plugin?

gh-pages publishing plugin for semantic-release. Visit Snyk Advisor to see a full health score report for @qiwi/semantic-release-gh-pages-plugin, including popularity, security, maintenance & community analysis.

Is @qiwi/semantic-release-gh-pages-plugin popular?

The npm package @qiwi/semantic-release-gh-pages-plugin receives a total of 1,226 weekly downloads. As such, @qiwi/semantic-release-gh-pages-plugin popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @qiwi/semantic-release-gh-pages-plugin well maintained?

We found indications that @qiwi/semantic-release-gh-pages-plugin maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @qiwi/semantic-release-gh-pages-plugin safe to use?

The npm package @qiwi/semantic-release-gh-pages-plugin was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 November-2024, at 10:43 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (1,226)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

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

Install

Usage

Configuration

Environment variables

Options

License

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

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

FAQs

What is @qiwi/semantic-release-gh-pages-plugin?

Is @qiwi/semantic-release-gh-pages-plugin popular?

Is @qiwi/semantic-release-gh-pages-plugin well maintained?

Is @qiwi/semantic-release-gh-pages-plugin safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues