Skip to content

Commit

Permalink
fix: strip title line from release
Browse files Browse the repository at this point in the history
  • Loading branch information
pi0 committed Mar 3, 2023
1 parent aec2341 commit 319f7ce
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,13 @@ npx changelogen@latest [...args] [--dir <dir>]

Changelogen has built-in functionality to sync with with Github releases!

In order to manually sync a release, you can use `changelogen gh release <versions|all> [--dir] [--token]`. It will parse current `CHANGELOG.md` from current repository (local, then remote) and create or update releases.
In order to manually sync a release, you can use `changelogen gh release`. It will parse current `CHANGELOG.md` from current repository (local, then remote) and create or update releases.

Usage:

```sh
npx changelogen@latest gh release [all|versions...] [--dir] [--token]
```

To enable this integration, make sure there is a valid `repository` field in `package.json` or `repo` is set in `.changelogenrc`.

Expand Down
2 changes: 1 addition & 1 deletion src/commands/default.ts
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ export default async function defaultMain(args: Argv) {
if (args.github !== false && config.repo.provider === "github") {
await githubRelease(config, {
version: config.newVersion,
body: markdown,
body: markdown.split("\n").slice(2).join("\n"),
});
}
}
Expand Down

0 comments on commit 319f7ce

Please sign in to comment.