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

@cmflow/cli

v1.0.16

Published

An awesome Git Flow

Downloads

7,701

Readme

npm version semantic-release code style: prettier

npm i -g @cmflow/cli

CmFlow release

Installation

CmFlow is compatible with semantic-release 📦🚀. You can use CmFlow release to deploy your projects based on CmFlow convention.

Add the cmflow to your project:

npm i --save-dev @cmflow/cli

Then create release.config.js with this configuration:

const { getSemanticConfig } = require('@cmflow/cli')

module.exports = {
  ...getSemanticConfig(),
  // Additional semantic configuration props
  npmPublish: false
}

Then edit your package.json add the following tasks on script property:

{
  "script": {
    "release": "cmrelease",
    "release_dry_run": "cmrelease --dry-run"
  }
}

Now, CmFlow and semantic release are correctly installed on your project.

Build and E2E Test

CmFlow release are able to run build and test_e2e task during the deploy process. It's useful when you want to deploy a docker image on docker hub with the right revision number in the package.json. The only requirement, is to have a build and test_e2e tasks in you npm scripts.

Example:

{
  "scripts": {
    "build": "docker-compose build",
    "test_e2e": "docker-compose up -d && sleep 10 && npm run test_cucumber && docker-compose stop"
  }
}

Generate changelog

CmFlow release call also a npm task build_changelog to let you generate the changelog file with your preferred tool.

Example:

{
  "scripts": {
    "build_changelog": "conventional-changelog --preset angular --release-count 0 --outfile ./CHANGELOG.md",
    "build_changelog": "cmchangelog"
  }
}

Configure CI

CmFlow release can be used with Travis CI, Circle CI and GitLab. You have to create these environments variables to allow git release note deployment, commit push and docker image deployment.

| Variable | Description | |---------------------|---------------------------------------------------------------------------------------------------------------------------| | PROJECT_NAME | The project to publish artifact on docker | | GH_TOKEN | A GitHub personal access token. | | GIT_USER_EMAIL | User mail to sign the commit produced by CmFlow release | | GIT_USER_NAME | User name to sign the commit produced by CmFlow release | | DEPLOY_ON_DOCKER | Set 1 to deploy on docker | | DOCKER_HUB_ID | The docker hub id | | DOCKER_HUB_PWD | The docker password account | | HEROKU_APP | Enable deployment on heroku. Note: You have to configure HEROKU_API_KEY token on your CI | | SKIP_DEPLOY | Skip all deployment task (docker, heroku). | | SKIP_GITHUB_PUBLISH | Skip tag and release note publication on Github. | | GITHUB_PAGES_PATH | Path to the front-end artifact. Enable github pages deployment. |