Giter Club home page Giter Club logo

bump_workspaces's Introduction

@deno/bump-workspaces

A tool for releasing workspaces project in Deno.

ci codecov

This tool automatically detects necessary version updates for workspaces-enabled projects and creates a PR with necessary version changes.

Set up the GitHub Actions yaml like the below, and trigger the workflow manually:

name: version_bump

on: workflow_dispatch

jobs:
  build:
    name: version bump
    runs-on: ubuntu-latest
    timeout-minutes: 15

    steps:
      - name: Clone repository
        uses: actions/checkout@v4

      - name: Set up Deno
        uses: denoland/setup-deno@v1

      - name: Run workspaces version bump
        run: |
          git fetch --unshallow origin
          deno run -A jsr:@deno/[email protected]
        env:
          GITHUB_TOKEN: ${{ secrets.BOT_TOKEN }}

Example pull request: kt3k/deno_std#34

How it works

TBD

Commit titles

This tool uses the commit titles as the input for detecting which modules and versions to update. The commit titles need to follow the following format:

<tag>(<scopes,...>): <commit message>

Some examples are:

fix(foo): fix a bug
fix(baz,qux): fix a bug
feat(bar): add a new feature
chore(foo): clean up
chore(bar): clean up
BREAKING(quux): some breaking change

This example results in the following version updates:

module version
foo patch
bar minor
baz patch
qux patch
quux major

The tool automatically detects following commit tags:

  • BREAKING
  • feat
  • fix
  • perf
  • docs
  • deprecation
  • refactor
  • test
  • style
  • chore

If a module has BREAKING commits, then major version will be updated. If a module has feat commits, minor version will be updated. Othrewise patch version will be update.

tag version
BREAKING major
feat minor
fix patch
perf patch
docs patch
deprecation patch
refactor patch
test patch
style patch
chore patch

TODO(kt3k): document scope-required tags.

Customize version detection

TBD

License

MIT

bump_workspaces's People

Contributors

kt3k avatar denobot avatar

Stargazers

hashrock avatar Alex Lane avatar Harry Solovay avatar Ethan Davidson avatar

Watchers

 avatar Will (Newby) Atlas avatar Luca Casonato avatar  avatar

Forkers

chriss-0x01

bump_workspaces's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.