Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
timotheeguerin committed Feb 24, 2024
1 parent db72009 commit 0a4ca3d
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,27 @@ chronus goal is to provide changelog management. It was heavily inspired by [cha
- Design to be able to plug in different monorepo(changesets also does that), source control system as a plugin system(only git added but left room for more).
- Change can be defined in custom categories that allow more meaningful grouping of changes in the changelog. See [Change kinds doc](./docs/change-kinds.md)

## Requirements
## Documentation

- Node 16+
- pnpm 7.5.2+
- [CLI](cli.md)

Chronus functionalities:

- [Configure change kinds](change-kinds.md) _Use a different set of change kinds from `major`, `minor`, `patch`_

## Develop

- [CLI](cli.md)

Chronus functionalities:

- [Configure change kinds](change-kinds.md) _Use a different set of change kinds from `major`, `minor`, `patch`_

### Requirements

- Node LTS
- `pnpm`

[Click here to release current changes](https://github.com/timotheeguerin/chronus/pull/new/publish/auto-release)

This project uses [pnpm workspaces](https://pnpm.io/workspaces) to manage multiple packages.
Expand Down
33 changes: 33 additions & 0 deletions docs/cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Chronus CLI

## `chronus add`

Add a new change description

## `chronus verify`

Verify that the packages with changes from the `baseBranch` have all been described.

## `chronus status`

This command will show the current status of the changes in the workspace. This is basically a summary of what `chronus version` will do if run.

This command takes the same options as [`chronus version`](#chronus-version).

## `chronus version`

Apply the change description and bump version of packages. By default this will respect the version policies configured(see [version policies](version-policies.md)).

### Options

#### `--ignore-policies`

This allows to ignore the [version policies](version-policies.md) and bump the packages independently. This can be useful in the `lockStep` policies when doing a hotfix.

#### `--only`

Only bumps the packages specified. This can be useful if wanting to only release certain packages. This command will extract the change descriptions for the specified packages and bump the version of those packages. If a change applied to a package is not specified in the `--only` option it will be ignored. If a change is specified in both it will be applied and the packages included in the `only` array will be removed from the change description file.

```bash
chronus version --only @my-scope/my-package1 --only @my-scope/my-package2
```
7 changes: 7 additions & 0 deletions docs/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Chronus Documentation

- [CLI](cli.md)

Chronus functionalities:

- [Configure change kinds](change-kinds.md) _Use a different set of change kinds from `major`, `minor`, `patch`_
5 changes: 5 additions & 0 deletions docs/version-policies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Chronus Version Policies

By default each package is versioned independentely. This means if you describe a change for package `a` it will only bump the version of `a` and any package depending on `a` that would need a release to include the new version of `a`.

TODO

0 comments on commit 0a4ca3d

Please sign in to comment.