https://github.com/labor-digital/conventional-release-action

An action for creating a changelog and bumping your package versions based on conventional commit messages
https://github.com/labor-digital/conventional-release-action

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/labor-digital/conventional-release-action
• Owner: labor-digital
• Created: 2020-02-12T12:31:21.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-08-18T19:22:17.000Z (over 2 years ago)
• Last Synced: 2023-03-04T02:57:37.600Z (almost 2 years ago)
• Language: JavaScript
• Size: 4.37 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](https://github.com/conventional-changelog/conventional-changelog)

and [angular's commit guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-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:

```yaml

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.