Skip to content

Commit

Permalink
docs(bump): disable bump commit
Browse files Browse the repository at this point in the history
  • Loading branch information
ABWassim authored and oknozor committed Mar 8, 2024
1 parent b03d66e commit 12df7a2
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/website/config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,19 @@ The config reference list all value that can be set in the `cog.toml` file at th
disable_changelog = true
```

### `disable_bump_commit`

- Type: `boolean`
- Optional: `true`
- Default value: `false`
- Description: Cocogitto will not create a bump commit and will instead tag the latest commit.
- Example:
```toml
disable_bump_commit = true
```
- Also see:
* [User guide -> Disable bump commit creation](../guide/#disable-bump-commit-creation)

## Changelog

### `path`
Expand Down
16 changes: 16 additions & 0 deletions docs/website/guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1039,6 +1039,22 @@ Date: Tue Mar 7 15:06:18 2023 +0200
By default, Cocogitto will abort bump if there are uncommited or untracked changes. You can change this behavior using the `skip_untracked` configuration in the `cog.toml` file or the `--skip-untracked` option of the `bump` command. If so, the warning will be printed to `stderr` and the bump will continue.
## Disable bump commit creation
When bumping by default, Cocogitto will create a commit that will include the Changelog(s), the tag(s) and any file updated in the `pre_bump_hooks`.
**Example with a monorepo** :
```bash
❯ git log
commit xxx (HEAD -> main, tag: 0.1.0, tag: one-0.1.0)
Author: John Doe <jon.doe@unknown.com>
Date: Tue Mar 7 15:06:18 2023 +0200
chore(version): bump packages
```
To disable its creation, you can use the `disable_bump_commit` configuration in the `cog.toml` or the `--disable-bump-commit` option of the `cog bump` command. In that case, Cocogitto will create the tag(s) on the latest commit and will not commit the files mentionned above. They will have to be manually commited, for example using the `post_bump_hooks`.
## Get the current version
It's sometime needed to display the current version for scripting purpose.
Expand Down

0 comments on commit 12df7a2

Please sign in to comment.