Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add changelog #1276

Merged
merged 2 commits into from
Apr 11, 2023
Merged

Add changelog #1276

merged 2 commits into from
Apr 11, 2023

Conversation

rth
Copy link
Contributor

@rth rth commented Apr 11, 2023

Adds a changelog since v0.9.94

Closes #1010

For each release the changelog is constructed by searching PRs between previous and current release dates. For instance,

is:pr is:closed sort:updated-desc merged:2022-11-07..2023-04-05 base:master 

It's not perfect, but in any case users can discover more context by clicking on the corresponding PR links.

The rendered markdown version can be seen here

Ideally changelog entries should be added in new PRs (unless someone want's to do this before each future release).

@oroulet
Copy link
Member

oroulet commented Apr 11, 2023

Nice one!
Can we automate that work? It looks really possible by listing all merged PR.
It requires people to make good PR descriptions but that can be done

@oroulet oroulet merged commit 8962ab0 into FreeOpcUa:master Apr 11, 2023
@rth rth deleted the add-changelog branch April 11, 2023 13:33
@rth
Copy link
Contributor Author

rth commented Apr 11, 2023

Can we automate that work? It looks really possible by listing all merged PR.

Yeah some of it should be partially automatable,

  1. either by querying the Github API with the above query
  2. or maybe easier by using git log <tagA>...<tagB> but right now the output of git log is not very readable because you don't squash PRs. If you start squashing PRs then that would give already a pretty close output to a changelog as by default each commit message would be PR title + PR id.

@oroulet
Copy link
Member

oroulet commented Apr 11, 2023

There are tools to use commits, but often it is too detailled, so using PR as you did was a good idea.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants