Git Product home page Git Product logo

Comments (2)

metcalfc avatar metcalfc commented on August 24, 2024

This is the way to use it by default:

- name: Generate changelog
  id: changelog
  uses: metcalfc/[email protected]
  with:
    myToken: ${{ secrets.GITHUB_TOKEN }}

This automatically moves the changelog between the point and time you run the action and the last release. The action assumes that you have created a real GitHub release and not just a tag.

You can also use the action to generate notes between any valid reference (hash, tag, branch, whatever). You just have to update the workflow somehow to do that.

My project flow is make updates. npm version patch and that generates a tag formatted as vX.Y.Z. Pushing that tag kicks off the release workflow which builds the notes and creates a GitHub release from the tag. Here is the workflow:

https://github.com/metcalfc/changelog-generator/blob/main/.github/workflows/release.yml

You'll see that I generate the notes and then create a GitHub release. So the notes get calculated between the last release and right before I create the next release.

from changelog-generator.

metcalfc avatar metcalfc commented on August 24, 2024

Thanks for checking out the action. I hope the default does what you need. I'll close this for now. Feel free to reopen if there is something about this action that the built in doesn't handle.

from changelog-generator.

Related Issues (19)

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.