feat(changelog-tool): add changelog command line tool #1
Conversation
|
|
changelog.lua
Outdated
| release <version> release a release note based on the files in the CHANGELOG/unreleased directory. | ||
| preview <version> preview a release note based on the files in the CHANGELOG/unreleased directory. |
There was a problem hiding this comment.
Please explain what's the difference of preview and release.
changelog.lua
Outdated
| local sources = { string.upper(ctx.commit.message), string.upper(ctx.pull.body) } | ||
| for _, text in ipairs(sources) do | ||
| match_pattern(text, "FTI%-%d+", jiras) | ||
| match_pattern(text, "KAG%-%d+", jiras) |
There was a problem hiding this comment.
We have other projects. Suggest we do not hard code these prefixes.
There was a problem hiding this comment.
Kong/kong#11613. If the rule is too broad, then how can we avoid matching Sep-2023 ?
changelog.lua
Outdated
|
|
||
|
|
||
| local function is_yaml(filename) | ||
| return pl_stringx.endswith(filename, ".yaml") or |
There was a problem hiding this comment.
I will keep both file suffixes support here until one of them is completely gone.
changelog.lua
Outdated
| end | ||
|
|
||
| if folder == UNRELEASED then | ||
| os.execute("mv " .. pl_path.join(path, UNRELEASED) .. " " .. target_path) |
There was a problem hiding this comment.
These does not really need to be so automatic, I would not feel too comfortable having a script mv file on the disk for me, it is very easy to make a mistake in the command and cause damage.
Just print out the command and let user execute it themself.
I even argue this script should not even write the .md file directly, use the KISS principal and let user do:
./changelog.lua 3.4.0. /path/to/kong/unreleased > CHANGELOG-3.4.0.md
is much better and safer.
If we really need to automate, Makefile and a shell script is much better idea.
Makefile
Outdated
| @@ -0,0 +1,9 @@ | |||
| test: | |||
There was a problem hiding this comment.
Only for demo, will be removed.
vm-001
force-pushed
the
dev
branch
2 times, most recently
from
079fe1f to
51ad01c
Compare
vm-001
changed the title
No description provided.