Giter Club home page Giter Club logo

automated-releases-example's Introduction

Automating GitHub Releases

This is an example Node project that leverages actions/create-release and auto-changelog to automate the creation of GitHub releases, complete with release notes generated from the commit log with a customizable template.

Usage

To publish a new release, create a tag and push to GitHub. The release is published server-side in an Actions workflow.

npm version patch
git push --follow-tags

When a new tag that begins with v (e.g. v1.2.0, v3.0.1, etc.) is pushed to GitHub, the release workflow runs. It generates release notes by running auto-changelog, then uses the create-release action to publish a new release.

Release notes are created based on the RELEASE.md.bhs template file. The template is populated with references to all commits between the last two tags, rendered into Markdown, then piped into the create-release action.

License

MIT © Jesse Youngblood

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.