Skip to content

Commit

Permalink
docs: update README to reflect API changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Patrick Mirwald committed Aug 15, 2024
1 parent bc57185 commit b92fee9
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,8 @@ version | Package version | -
packageName | Package name | -
buildInformationOverwriteMode | octo build-information OverwriteMode | -
pushOverwriteMode | octo push OverwriteMode | -
buildInformationAddition | Customize the final octopus build-information before uploading | -
gitlabCi | Default `buildInformationAddition` implementation adding context from the CI environment for Gitlab CI. Also sets `commitLinkBaseUrl`. | false
buildInformationAddition | Customize the final octopus build-information before uploading | {}
gitlab | Default `buildInformationAddition` implementation adding context from the CI environment for Gitlab CI. Also sets `commitLinkBaseUrl`. | not applied
httpLogLevel | configures the http logging while using the Octopus API | `HttpLoggingInterceptor.Level.NONE`
issueTrackerName | When parsing issues the target issue tracker name is needed. Currently only `Jira` supported | **optional/none**
parseCommitsForJiraIssues | Enable Jira Issue parsing. This needs the changelog generation enabled to parse the commits there. | **optional/none**
Expand All @@ -110,19 +110,20 @@ apiKey.set(provider {
```

To customize the build information, use the `buildInformationAddition` block:

```kotlin
buildInformationAddition {
Id.set("custom-id")
BuildEnvironment.set("CI")
buildInformationAddition.set({
Id = "custom-id"
// Add other properties as needed
}
})

```

For GitLab CI integration, set the `gitlabCi` property to `true`:
For GitLab CI integration, set the `gitlab` block:
```kotlin
gitlabCi.set(true)
gitlab {
Id = "custom-id"
// Add other properties as needed
}
```

### task specific configuration
Expand Down

0 comments on commit b92fee9

Please sign in to comment.