release-lab / whatchanged Goto Github PK

Currently only made the simplest version

There may be some flaws in the design

eg. --dir and --file are easy to make confuse.

So here are the things that need to be changed for v0.2.0

If you are interested, welcome to share your opinion

1. rename --dir to --project

--dir is confusing

use --project to support remote.

eg. --project=https://github.com/axetroy/changelog.git

2. rename --file to --output

maybe, --output is better.

3. rename version range tag:0~tag:1

tag:{N} syntax is not memorable

- $ changelog tag:0~tag:1
+ $ changelog @0~@1

4. Generate multiple versions of syntax

Currently generating multiple versions of the syntax v2~v1

It will not only generate v1 and v2 changelogs, but also the versions between them.

We need a way to generate only v1 and v2

eg.

$ changelog v1,v2,v3,v4

5. Github Action integrated

I want to use changelog in Github, and I need to write an additional Github Action

preview:

name: ci

on: [push, pull_request]

jobs:
  release:
    name: Release to Github
    if: startsWith(github.ref, 'refs/tags/') && github.repository == 'axetroy/changelog'
    needs: [ci]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: 0

      - uses: axetroy/setup-changelog@v1
        with:
           changelog-version: v0.1.0

      - name: Generate release.md
        run: changelog --tpl=release.tpl --file=release.md

      - name: Run GoReleaser
        uses: goreleaser/goreleaser-action@v2
        with:
          version: latest
          args: release --rm-dist --release-notes=./release.md
        env:
          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}

6. Publish to npm

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• chore(deps): update github/codeql-action action to v3
• chore(deps): update golangci/golangci-lint-action action to v4
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update dependency @types/ffi-napi to v4.0.10
• fix(deps): update module github.com/88250/lute to v1.7.6
• fix(deps): update module github.com/masterminds/sprig/v3 to v3.2.3
• chore(deps): update dependency typescript to v5.4.5
• fix(deps): update module github.com/go-git/go-git/v5 to v5.12.0
• fix(deps): update module github.com/stretchr/testify to v1.9.0
• chore(deps): update actions/checkout action to v4
• chore(deps): update actions/setup-go action to v5
• chore(deps): update actions/setup-node action to v4
• chore(deps): update dependency jest to v29
• chore(deps): update goreleaser/goreleaser-action action to v5
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

eg.

v1.5.0
v1.4.0
v1.3.0
v1.2.0
v1.1.0
v1.0.0

eg, I want to start with version v1.5.0 and generate 3 versions forward

$ whatchanged #3~v1.5.0
# it will generate v1.5.0/v1.4.0/v1.3.0/v1.2.0

$ whatchanged v1.2.0~#3
# it will generate v1.5.0/v1.4.0/v1.3.0/v1.2.0

No offence, but it would please more people if the default Readme would be English.
At least for me and I agree it is a bad prejustice, that as soon as some weird glyphs appear I cant deceifer, my attention gets lost sadly.

BR

It might be nice, if the revision range just supports Git syntax "SHA..SHA".
The parsers seems a bit complicated.
Actually the whole thing could be made much easier:

git rev-parse A..B

is extremely powerfull and could be used once, to get the list of commits.
Then another for loop just parses everything.

Thats gonna result in a 5% of the code in 0_parser.go
And I really suggest to use open ranges https://github.com/gabyx/Githooks/blob/06b29e49f6bf62b58bee38431eb3603e45bb85f2/githooks/git/gitcommon.go#L313
with a maybe flag --include-last.

Do you think that might work?

In a monorepo it is very common to have different git tag patterns. Therefore multiple applications in a single repository.

• v1.0.0 -> ./app
• @wundergraph/[email protected] -> ./packages/sdk
• ...

It would be great to filter the changes based on a glob to generate only the changes relevant for a specific application. Ideally, we can pass multiple filter flags and it supports a glob.

whatchanged --filter 'packages/sdk'
whatchanged --filter 'packages/**'

## @wundergraph/[email protected]

### New feature:
....

There may be some private projects with usernames and passwords on their git URL.

eg. https://username:[email protected]/username/private.git

This information should not be included in the generated changelog

A service should be deployed to access the real-time preview the changelog via URL

eg. https://example.com/changelog?usernameaxetroy&repo=changelog

It would be nice if we could specify regex and replacements
in the context such that we could modify stuff:

feat: Implement button (#71, JIRA-1232)

We did it

In the template:

{{ .Field.Header.Subject | subs "#\d+" "https://bla/\1" }}

Would that be possible?

Not only one breaking change footer should be extracted but multiple ones are allowed.

Breaking-Change: asdasd
Breaking-Change: asdasdasd1

Should be parsed too. See

大佬，这个没有检查分支的commit诶，
我跟踪了一下代码,发现获取到的commit只有master分支的

看起来和使用下面的git命令得到的日志一样

git log --first-parent

是不是我的用法有问题呢？我到go-git提了一个问题

我使用的方式是

./whatchanged 

Because the name of changelog is so usual that search engines cannot find it.

• changelog
• whatchanged
• diffchange
• skier
• molt
• shed
• shift
• rise
• robeta

eg. v1.5.0 and v1.5.1 on the same tag