Giter Club home page Giter Club logo

action-auto-changelog's Introduction

action-auto-changelog

Generate a changelog automatically for your npm packages with GitHub actions.


๐Ÿ“Ÿ

Install

Create a new file in .github/workflows/changelog.yml with the following:

name: 'Generate Auto Changelog'
on:
    push:
        branches:
            - master
jobs:
    master:
        name: 'build'
        runs-on: ubuntu-latest
        steps:
            - uses: actions/checkout@master
              with:
                  fetch-depth: 0
            - name: Generate Auto Changelog
              uses: ahmadawais/action-auto-changelog@master
              with:
                  github_token: ${{ secrets.GITHUB_TOKEN }}

โš™๏ธ

Usage

Now, whenever you commit/push onto GitHub master branch, for your repo that contains a package.json file. This workflow will auto-generate a new changelog.


๐Ÿ“

Changelog

โฏ Read the changelog here โ†’


KEY: ๐Ÿ“ฆ NEW, ๐Ÿ‘Œ IMPROVE, ๐Ÿ› FIX, ๐Ÿ“– DOC, ๐Ÿš€ RELEASE, and โœ… TEST

I use Emoji-log, you should try it and simplify your git commits.


๐Ÿ“ƒ

License & Conduct


๐Ÿ™Œ

Connect

GitHub @AhmadAwaisย (follow) To stay up to date on free & open-source software

Twitter @MrAhmadAwaisย (follow) To get #OneDevMinute daily hot tips & trolls

YouTube AhmadAwaisย (subscribe) To tech talks & #OneDevMinute videos

Blog: AhmadAwais.comย (read) In-depth & long form technical articles

LinkedIn @MrAhmadAwaisย (connect) On the LinkedIn profile y'all


๐Ÿ‘Œ

Sponsor

Me (Ahmad Awais) and my incredible wife (Maedah Batool) are two engineers who fell in love with open source and then with each other. You can read more about me here. If you or your company use any of my projects or like what Iโ€™m doing then consider backing me. I'm in this for the long run. An open-source developer advocate.


Or you can back me by checking out my super fun video course. As developers, we spend over 200 Hrs/month with our code editors โ€” it's only fair to learn your next editor deeply. This course will save you 15-20 hours every month. Become a VSCode Power User โ†’


VSCODE


VSCode Ahmad on Twitter

action-auto-changelog's People

Contributors

ahmadawais avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

action-auto-changelog'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.