-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
db72009
commit 0a4ca3d
Showing
4 changed files
with
62 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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`_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |