Skip to content

Commit

Permalink
Update docs/input/docs/reference/configuration.md
Browse files Browse the repository at this point in the history
  • Loading branch information
HHobeck committed Feb 22, 2024
1 parent 38d40f3 commit 589e353
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions docs/input/docs/reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,25 +31,22 @@ found that is generally what is needed when using GitFlow.
To see the effective configuration (defaults and overrides), you can run
`gitversion /showConfig`.

To create your config file just type `gitversion init` in your repo directory,
after [installing][installing]. A minimal `GitVersion.yml` configuration file will be
created. Modify this to suit your needs.

## Global configuration

Following supported workflow configurations are available in GitVersion and can be referenced by the workflow property:
The following supported workflow configurations are available in GitVersion and can be referenced by the workflow property:
- GitFlow (GitFlow/v1)
- GitHubFlow (GitHubFlow/v1)
- TrunkBased (TrunkBased/v1)

Example of using a TrunkBased workflow with a different tag-prefix:
Example of using a `TrunkBased` workflow with a different `tag-prefix`:

```yaml
workflow: TrunkBased/v1
tag-prefix: '[abc]'
```
The build-in configuration for the `GitFlow` workflow (`workflow: GitFlow/v1`) looks like:
The built-in configuration for the `GitFlow` workflow (`workflow: GitFlow/v1`) looks like:

```yaml
assembly-versioning-scheme: MajorMinorPatch
Expand Down Expand Up @@ -205,7 +202,7 @@ is-release-branch: false
is-main-branch: false
```

The supported build-in configuration for the `GitHubFlow` workflow (`workflow: GitHubFlow/v1`) looks like:
The supported built-in configuration for the `GitHubFlow` workflow (`workflow: GitHubFlow/v1`) looks like:

```yaml
assembly-versioning-scheme: MajorMinorPatch
Expand Down Expand Up @@ -309,7 +306,7 @@ is-release-branch: false
is-main-branch: false
```

The supported build-in configuration for the `TrunkBased` workflow (`workflow: TrunkBased/v1`) looks like:
The supported built-in configuration for the `TrunkBased` workflow (`workflow: TrunkBased/v1`) looks like:

```yaml
assembly-versioning-scheme: MajorMinorPatch
Expand Down

0 comments on commit 589e353

Please sign in to comment.