Skip to content

Commit

Permalink
Merge branch 'main' into revert_resolver
Browse files Browse the repository at this point in the history
  • Loading branch information
KennethTrecy committed Jul 14, 2023
2 parents 2e11919 + 1b5fa2d commit c3652ac
Show file tree
Hide file tree
Showing 14 changed files with 1,822 additions and 1,541 deletions.
61 changes: 61 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,67 @@

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

## v0.5.4

[compare changes](https://github.com/unjs/changelogen/compare/v0.5.3...v0.5.4)

### 🚀 Enhancements

- Support `--publish` and `--canary` ([#123](https://github.com/unjs/changelogen/pull/123))

### 🩹 Fixes

- **markdown:** Remove unnecessary spaces ([#106](https://github.com/unjs/changelogen/pull/106))
- Add missing type export to package.json ([#113](https://github.com/unjs/changelogen/pull/113))

### 📖 Documentation

- Add documentation about `--push` flag ([#114](https://github.com/unjs/changelogen/pull/114))

### ❤️ Contributors

- Daniel Roe <daniel@roe.dev>
- Mazel <me@loicmazuel.com>
- Waleed Khaled ([@Waleed-KH](http://github.com/Waleed-KH))
- Thomas Lamant ([@tmlmt](http://github.com/tmlmt))

## v0.5.3

[compare changes](https://github.com/unjs/changelogen/compare/v0.5.2...v0.5.3)

## v0.5.2

[compare changes](https://github.com/unjs/changelogen/compare/v0.5.1...v0.5.2)


### 🚀 Enhancements

- Resolve repository config from git remote ([8401f91](https://github.com/unjs/changelogen/commit/8401f91))
- Load config from `changelog` field in `package.json` ([#88](https://github.com/unjs/changelogen/pull/88))
- Bump pre version ([#70](https://github.com/unjs/changelogen/pull/70))
- Support templates for commit and tag messages ([#68](https://github.com/unjs/changelogen/pull/68))

### 🩹 Fixes

- Handle unset value for `config.repo` ([#72](https://github.com/unjs/changelogen/pull/72))
- **getLastGitTag:** Handle when there are no git tags ([#77](https://github.com/unjs/changelogen/pull/77))

### 💅 Refactors

- Upgrade to `open` v9 ([315cbd0](https://github.com/unjs/changelogen/commit/315cbd0))

### 🏡 Chore

- Update badges and small improvements ([146d1d4](https://github.com/unjs/changelogen/commit/146d1d4))
- Update dev dependencies ([0f44ee9](https://github.com/unjs/changelogen/commit/0f44ee9))

### ❤️ Contributors

- Zhong666 ([@aa900031](http://github.com/aa900031))
- Donald Shtjefni ([@dnldsht](http://github.com/dnldsht))
- Pooya Parsa ([@pi0](http://github.com/pi0))
- Sébastien Chopin <seb@nuxtjs.com>

## v0.5.1

[compare changes](https://github.com/unjs/changelogen/compare/v0.5.0...v0.5.1)
Expand Down
35 changes: 22 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,26 @@

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Github Actions][github-actions-src]][github-actions-href]
[![Codecov][codecov-src]][codecov-href]
[![License][license-src]][license-href]

> Generate Beautiful Changelogs using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
Generate Beautiful Changelogs using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)

## Quick Start

Generate changelog in markdown format and show in console:
Generate a changelog in Markdown format and display in the console:

```sh
npx changelogen@latest
```

Generate changelog, bump version in `package.json` automatically and update `CHANGELOG.md` (without commit)
Generate a changelog, bump the version in `package.json` and update `CHANGELOG.md` (without commit):

```sh
npx changelogen@latest --bump
```

Bump version, update `CHANGELOG.md` and make a git commit and tag:
Bump the version, update `CHANGELOG.md` and make a git commit and tag:

```sh
npx changelogen@latest --release
Expand All @@ -40,15 +40,24 @@ npx changelogen@latest [...args] [--dir <dir>]
- `--dir`: Path to git repository. When not provided, **current working directory** will be used as as default.
- `--output`: Changelog file name to create or update. Defaults to `CHANGELOG.md` and resolved relative to dir. Use `--no-output` to write to console only.
- `--bump`: Determine semver change and update version in `package.json`.
- `--release`. Bumps version in `package.json` and creates commit and git tags using local `git`. You can disable commit using `--no-commit` and tag using `--no-tag`.
- `--release`. Bumps version in `package.json` and creates commit and git tags using local `git`. You can disable commit using `--no-commit` and tag using `--no-tag`. You can enable the automatic push of the new tag and release commit to your git repository by adding `--push`.
- `--publish`. Publishes package as a new version on `npm`. You will need to set authorisation tokens separately via `.npmrc` or environment variables.
- `--publishTag` Use custom npm tag for publishing (Default is `latest`)
- `--nameSuffix`: Adds suffix to package name (Example: `--nameSuffix canary` renames `foo` to `foo-canary`)
- `--versionSuffix`: Adds suffix to package version. When set without value or to `true`, uses date + commit hash as commit
- `--canary`. Shortcut to `--bump --versionSuffix` (`--nameSuffix` will be also added if arg has a string value).
- `-r`: Release as specific version.
- `--major`: Bump as a semver-major version
- `--minor`: Bump as a semver-minor version
- `--patch`: Bump as a semver-patch version
- `--premajor`: Bump as a semver-premajor version, can set id with string.
- `--preminor`: Bump as a semver-preminor version, can set id with string.
- `--prepatch`: Bump as a semver-prepatch version, can set id with string.
- `--prerelease`: Bump as a semver-prerelease version, can set id with string.

### `changelogen gh release`

Changelogen has built-in functionality to sync with with Github releases!
Changelogen has built-in functionality to sync with with Github 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.

Expand All @@ -69,7 +78,7 @@ By default in unauthenticated mode, changelogen will open a browser link to make

## Configuration

Configuration is loaded by [unjs/c12](https://github.com/unjs/c12) from cwd. You can use either `changelog.json`, `changelog.{ts,js,mjs,cjs}`, `.changelogrc` or use the `changelog` field in `package.json`.
Configuration is loaded by [unjs/c12](https://github.com/unjs/c12) from cwd. You can use either `changelog.config.json`, `changelog.config.{ts,js,mjs,cjs}`, `.changelogrc` or use the `changelog` field in `package.json`.

See [./src/config.ts](./src/config.ts) for available options and defaults.

Expand All @@ -88,11 +97,11 @@ Published under [MIT License](./LICENSE).

<!-- Badges -->

[npm-version-src]: https://img.shields.io/npm/v/changelogen?style=flat-square
[npm-version-src]: https://img.shields.io/npm/v/changelogen?style=flat&colorA=18181B&colorB=F0DB4F
[npm-version-href]: https://npmjs.com/package/changelogen
[npm-downloads-src]: https://img.shields.io/npm/dm/changelogen?style=flat-square
[npm-downloads-src]: https://img.shields.io/npm/dm/changelogen?style=flat&colorA=18181B&colorB=F0DB4F
[npm-downloads-href]: https://npmjs.com/package/changelogen
[github-actions-src]: https://img.shields.io/github/workflow/status/unjs/changelogen/ci/main?style=flat-square
[github-actions-href]: https://github.com/unjs/changelogen/actions?query=workflow%3Aci
[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/changelogen/main?style=flat-square
[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/changelogen/main?style=flat&colorA=18181B&colorB=F0DB4F
[codecov-href]: https://codecov.io/gh/unjs/changelogen
[license-src]: https://img.shields.io/github/license/unjs/changelogen.svg?style=flat&colorA=18181B&colorB=F0DB4F
[license-href]: https://github.com/unjs/changelogen/blob/main/LICENSE
50 changes: 26 additions & 24 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
{
"name": "changelogen",
"version": "0.5.1",
"version": "0.5.4",
"description": "Generate Beautiful Changelogs using Conventional Commits",
"repository": "unjs/changelogen",
"license": "MIT",
"sideEffects": false,
"type": "module",
"exports": {
".": {
"types": "./dist/index.d.ts",
"import": "./dist/index.mjs",
"require": "./dist/index.cjs"
}
Expand All @@ -32,33 +33,34 @@
"test": "pnpm lint && vitest run --coverage"
},
"dependencies": {
"c12": "^1.1.2",
"colorette": "^2.0.19",
"consola": "^2.15.3",
"c12": "^1.4.2",
"colorette": "^2.0.20",
"consola": "^3.2.3",
"convert-gitmoji": "^0.1.3",
"execa": "^7.0.0",
"execa": "^7.1.1",
"mri": "^1.2.0",
"node-fetch-native": "^1.0.2",
"ofetch": "^1.0.1",
"open": "^8.4.2",
"pathe": "^1.1.0",
"pkg-types": "^1.0.2",
"node-fetch-native": "^1.2.0",
"ofetch": "^1.1.1",
"open": "^9.1.0",
"pathe": "^1.1.1",
"pkg-types": "^1.0.3",
"scule": "^1.0.0",
"semver": "^7.3.8",
"yaml": "^2.2.1"
"semver": "^7.5.4",
"std-env": "^3.3.3",
"yaml": "^2.3.1"
},
"devDependencies": {
"@types/node": "^18.14.2",
"@types/semver": "^7.3.13",
"@vitest/coverage-c8": "^0.29.2",
"eslint": "^8.35.0",
"eslint-config-unjs": "^0.1.0",
"jiti": "^1.17.1",
"prettier": "^2.8.4",
"@types/node": "^20.4.1",
"@types/semver": "^7.5.0",
"@vitest/coverage-v8": "^0.33.0",
"eslint": "^8.44.0",
"eslint-config-unjs": "^0.2.1",
"jiti": "^1.19.1",
"prettier": "^2.8.8",
"standard-version": "^9.5.0",
"typescript": "^4.9.5",
"unbuild": "^1.1.2",
"vitest": "^0.29.2"
"typescript": "^5.1.6",
"unbuild": "^1.2.1",
"vitest": "^0.33.0"
},
"packageManager": "pnpm@7.28.0"
}
"packageManager": "pnpm@8.6.6"
}

0 comments on commit c3652ac

Please sign in to comment.