Code Monkey home page Code Monkey logo

Comments (11)

gombosg avatar gombosg commented on May 18, 2024 1

I'll look into this, but first, Flathub and Fedora submission has priority.

from antimicrox.

gombosg avatar gombosg commented on May 18, 2024 1

Okay, let's stick with that for now! :)

from antimicrox.

gombosg avatar gombosg commented on May 18, 2024 1

I'd close this issue for now, auto changelog generation works fine. We can reopen if more stuff comes up later. 🙂

from antimicrox.

pktiuk avatar pktiuk commented on May 18, 2024

Are there any ways of filtering commits to be mentioned in changelogs (by tags or by names/types of changed files)?
I don't want to fill our changelogs with README updates etc.

from antimicrox.

pktiuk avatar pktiuk commented on May 18, 2024

Requirements for our changelogs:

  • describe changes visible for end-users (changing readme, or any similar files doesn't count)
  • don't include issues irrelevant for users (for example issues tagged as questions shouldn't be mentioned), I am not sure if issues should be mentioned in changelog at all 🤔
  • avoid duplicates (for example if we have bug mentioned by issue and single Pull request fixing it, we should mention only one of them)
  • It would be good to use Conventional Commits to have multiple categories

I am not sure about mentioning changes in code, which doesn't affect functionality (I mean cleanups, chores etc).

But in Release descriptions (visible on release site) we should show all the changes on repo since previous release Issues, Merges etc.
It would look there especially good, mainly because it is generated in Markdown and links relevant issues.

from antimicrox.

gombosg avatar gombosg commented on May 18, 2024

https://github.com/github-changelog-generator/github-changelog-generator/wiki/Advanced-change-log-generation-examples
Here you can see which labels we can use.
Doing complex config is not possible here, if you want complex changelog, then we'll have to write it manually.

from antimicrox.

pktiuk avatar pktiuk commented on May 18, 2024

We could generate basic log, and later we could cut it using Python script (I can write this script).

from antimicrox.

gombosg avatar gombosg commented on May 18, 2024

A simple git commit log command with sed or whatever?

from antimicrox.

pktiuk avatar pktiuk commented on May 18, 2024

I mean, we could generate regular changelog using this generator and later remove all of unwanted commits.

from antimicrox.

pktiuk avatar pktiuk commented on May 18, 2024

Or we could just generate these changelogs using your config and manually remove unwanted pieces (I think it will be the simplest solution, because removing some lines is pretty quick task).

from antimicrox.

gombosg avatar gombosg commented on May 18, 2024

For now I just changed labels for sections so that we can manually remove stuff.
We can also play around with section and PR labels: https://github.com/github-changelog-generator/github-changelog-generator/wiki/Advanced-change-log-generation-examples#section-options

So we'll only include e.g. enchantments and bugs, but not docs and packaging, or whatever.

from antimicrox.

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.