Skip to content

labor-digital/conventional-release-action

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LABOR - Conventional Release Action

A github action that generates a CHANGELOG.md and updates your package.json as well as the composer.json of your project after you pushed a new release.

This library aims to provide with an automatic release cycle based on Conventional Changelog and angular's commit guidelines . Both provide tools to keep the git history readable, generate version numbers and changelogs automatically.

Usage

Simply add the action to your pipeline configuration like:

name: Create new Release

on:
  push:
    branches:
      - master
    paths-ignore:
      - 'composer.json'
      - 'package.json'
      - 'CHANGELOG.md'
jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - name: Create Changelog and bump release version
        uses: labor-digital/conventional-release-action@master
        with:
          github-token: ${{ secrets.github_token }}
          [ preRelease: rc ] // Allows you to create pre-release version numbeers
          [ preMajor: true ] // If preRelease is set, this is true automatically
          // which will disable the semver version to be bumped.
          [ dryRun: true ] // Only simulate the action
          [ tagPrefix: v ] // "v" is already the default

After Bump action

If your project contains a after-bump.js file. The file will be executed after the version has been bumped but before the changes are pushed back to the repository.

About

An action for creating a changelog and bumping your package versions based on conventional commit messages

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •