Git Product home page Git Product logo

changelog-and-tag-action's Introduction

Github Action - Generate CHANGELOG and tag release

This Github Action (simply written in bash) :

  • Generates changelog content based on commit messages.
  • Push it to the current branch.
  • Tag a new release with the content of this release.

Usage

Pre-requisites

Your project has to respect two thing to use this action correctly :

  • Commit message convention : Currently, the only supported commit convention is the angular one. See Angular contributing for more informations.
  • Semantic versionning : At least your last tag has to respect the Semantic versionning convention, so the tagging system can increment the corresponding number.

Inputs

  • GITHUB_TOKEN : A github generated token that will be used to commit/push the updated CHANGELOG.md and the tag
  • GITHUB_USER : The user linked to the token that will be used to commit/push the updated CHANGELOG.md and the tag

Outputs

  • NEW_TAG : This will contain the new created tag, you then are able to make update on it further in your workflow

Example

name: Java CI

on: 
  push:
    branches:
    - master
    paths-ignore:
    - 'CHANGELOG.md'

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v1
    - name: Generate changelog
      uses: zthulj/changelog-and-tag-action@master
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        GITHUB_USER: user

License

The scripts and documentation in this project are released under the MIT License

changelog-and-tag-action's People

Contributors

grzi avatar

Watchers

 avatar

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.