Giter Site home page Giter Site logo

Comments (3)

kzu avatar kzu commented on August 19, 2024 1

It uses a config file and the github changelog generator.

So, labels become important, as well as PR titles. Once you factor in this fact, what I usually do is amend PR titles with that in mind.

While the changelog is fully automated, the release notes aren't. That uses GH's built-in button to generate the release notes while you create a release from its own config which is very very close to the changelog generator itself. This feature came a bit after I started doing the automated changelog generation, so perhaps I should invest some time in unifying them so the direct notes from the actual release (potentially manually tweaked) make it to the changelog.md as-is. But right now, that's the mix.

from moq4.

kzu avatar kzu commented on August 19, 2024

It was previously manually updated by @stakx. I do automated changelog in all my repos, but I just noticed that even if the action run green there was an error when updating from the GH action: https://github.com/moq/moq/actions/runs/5836450586/job/15830043450

image

Checking why that didn't commit... Thanks for reporting!

from moq4.

stakx avatar stakx commented on August 19, 2024

It was previously manually updated by @stakx.

In fact it was expanded by whomever submitted relevant code changes. I only updated the "Unreleased" headers with version numbers immediately prior to a new release.

I'm curious though, how does your automated changelog creation process work? Is it based on the titles and authors of issues & PRs that went into a release?

(The reason why I thought that a manually edited file was OK was that issue & PR titles often aren't the best possible summary for a bug or change (from a user perspective), and sometimes you may want to add some additional notes that couldn't be derived from them. Also, not all issues and PRs may be significant, so manually deciding to omit some them may remove some noise from the log.)

from moq4.

Related Issues (20)

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.