Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@crystal-ball/semantic-release-base

Package Overview
Dependencies
Maintainers
4
Versions
53
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@crystal-ball/semantic-release-base

🔮 Projects - Semantic Release configs

  • 2.40.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
4
Created
Source

Crystal Ball Projects documentation

Package version NPM downloads Build status Known vulnerabilities Test coverage Maintainability :status      
Renovate Commitizen friendly ZenHub Semantic Release Contributor Covenant :integrations
Contains magic Full of love :flair       


Fully automated version management and package publishing for 🔮 packages



Package contains the shared base configs for automated release management with Semantic Release. Included configurations will:

  1. Analyze commits using the ESLint commit standards to determine a semver version
  2. Generate release notes for the release
  3. Generate changelog updates for the release
  4. Update the package.json version and publish to NPM
  5. Push a release commit and tag
  6. Add a comment to Github issues and PRs resolved in the release

Setup

1. Install

npm i -D @crystal-ball/semantic-release-base

2. Update package.json

{
  "release": {
    "extends": ["@crystal-ball/semantic-release-base"]
  }
}

CI/CD configuration

Releases should be configured to trigger on change to default branch in CI/CD. Configurations must be set as environment values including:

  • GH_TOKEN Github token
  • NPM_TOKEN NPM token

Configuring Github Actions

jobs:
  ci-cd:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - name: Setup Node.js
        uses: actions/setup-node@v1
        with:
          node-version: '10'
      - name: Install
        run: npm install
        env:
          CI: true
      - name: Test
        run: npm test
      - name: Release
        if: success() && github.ref == 'refs/heads/main'
        run: npx semantic-release
        env:
          GH_TOKEN: ${{ secrets.SEMANTIC_GH_TOKEN }}
          NPM_TOKEN: ${{ secrets.SEMANTIC_NPM_TOKEN }}

Configuring Travis

deploy:
  provider: script
  skip_cleanup: true
  script:
    - npx semantic-release

Changelog generation

  • Commits with breaking changes will create a notes section

Included plugins

Keywords

FAQs

Package last updated on 17 Sep 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc