Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cleanup the tasks section in the README #82

Merged
merged 1 commit into from
Oct 25, 2021
Merged

cleanup the tasks section in the README #82

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 64 additions & 38 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ A Gradle plugin that provides tasks and helper methods to simplify working with
- [`getChangelog`](#getchangelog)
- [Extension Methods](#extension-methods)
- [`get`](#get)
- [`getOrNull`](#getOrNull)
- [`getOrNull`](#getornull)
- [`getUnreleased`](#getunreleased)
- [`getLatest`](#getlatest)
- [`getAll`](#getall)
Expand Down Expand Up @@ -103,7 +103,7 @@ changelog {
Plugin can be configured with the following properties set in the `changelog {}` closure:

| Property | Description | Default value |
| ----------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|-------------------------|----------------------------------------------------------------------------|-------------------------------------------------------------------------------|
| **`version`** | Current version. By default, global project's version is used. | `project.version` |
| `groups` | List of groups created with a new Unreleased section. | `["Added", "Changed", "Deprecated", "Removed", "Fixed", "Security"]` |
| `header` | `String` or `Provider` that returns current header value. | `provider { "[${version.get()}]" }` |
Expand All @@ -120,13 +120,36 @@ Plugin can be configured with the following properties set in the `changelog {}`

The plugin introduces the following tasks:

| Task | Description |
| --------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `getChangelog` | Retrieves changelog for the specified version. |
| `initializeChangelog` | Creates new changelog file with Unreleased section and empty groups. |
| `patchChangelog` | Updates the unreleased section to the given version. Requires *unreleased* section to be present in the changelog file. |
| Task | Description |
|-----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|
| [`getChangelog`](#getchangelog) | Retrieves changelog for the specified version. |
| [`initializeChangelog`](#initializechangelog) | Creates new changelog file with Unreleased section and empty groups. |
| [`patchChangelog`](#patchchangelog) | Updates the unreleased section to the given version. Requires *unreleased* section to be present in the changelog file. |


### `getChangelog`
Retrieves changelog for the specified version.

#### Options

| Option | Description |
|----------------|----------------------------------------------------|
| `--no-header` | Skips the first version header line in the output. |
| `--unreleased` | Returns Unreleased change notes. |

#### Examples

```bash
$ ./gradlew getChangelog --console=plain -q --no-header

### Added
- Initial project scaffold
- GitHub Actions to automate testing and deployment
- Kotlin support
```

### `initializeChangelog`
Creates new changelog file with Unreleased section and empty groups.

#### Examples

Expand All @@ -149,41 +172,44 @@ $ cat CHANGELOG.md
### Security
```

### `getChangelog`
### `patchChangelog`
Updates the unreleased section to the given version. Requires *unreleased* section to be present in the changelog file.

#### Options

| Option | Description |
| --------------- | -------------------------------------------------- |
| `--no-header` | Skips the first version header line in the output. |
| `--unreleased` | Returns Unreleased change notes. |
| Option | Description |
|------------------|---------------------------------------------------------|
| `--release-note` | Adds custom release note to the latest changelog entry. |

#### Examples

```bash
$ ./gradlew getChangelog --console=plain -q --no-header

$ cat CHANGELOG.md
## [Unreleased]
### Added
- Initial project scaffold
- GitHub Actions to automate testing and deployment
- Kotlin support
```

### `patchChangelog`

#### Options
- A based new feature

$ ./gradlew patchChangelog
$ cat CHANGELOG.md

| Option | Description |
| ---------------- | ------------------------------------------------------- |
| `--release-note` | Adds custom release note to the latest changelog entry. |
## [Unreleased]
### Added

#### Examples
## [1.0.0]
### Added
- A based new feature
```

```bash
$ ./gradlew patchChangelog --release-note=- Foo
$ cat CHANGELOG.md
## [Unreleased]
### Added
- This note will get overridden by the `--release-note`

$ ./gradlew patchChangelog --release-note='- Foo'
$ cat CHANGELOG.md
## [Unreleased]
### Added

## [1.0.0]
- Foo
Expand All @@ -207,9 +233,9 @@ It is possible to specify the *unreleased* section with setting the `${changelog

#### Parameters

| Parameter | Type | Description | Default value |
| ----------- | --------- | -------------------- | ---------------------- |
| `version` | `String` | Change note version. | `${changelog.version}` |
| Parameter | Type | Description | Default value |
|-----------|----------|----------------------|------------------------|
| `version` | `String` | Change note version. | `${changelog.version}` |

#### Examples

Expand Down Expand Up @@ -237,9 +263,9 @@ Same as `get`, but returns `null` instead of throwing `MissingVersionException`.

#### Parameters

| Parameter | Type | Description | Default value |
| ----------- | --------- | -------------------- | ---------------------- |
| `version` | `String` | Change note version. | `${changelog.version}` |
| Parameter | Type | Description | Default value |
|-----------|----------|----------------------|------------------------|
| `version` | `String` | Change note version. | `${changelog.version}` |

### `getUnreleased`

Expand Down Expand Up @@ -337,14 +363,14 @@ It provides a couple of properties and methods that allow altering the output fo

### Properties

| Name | Type | Description |
| --------- | --------- | ----------------------- |
| `version` | `String` | Change note version. |
| Name | Type | Description |
|-----------|----------|----------------------|
| `version` | `String` | Change note version. |

### Methods

| Name | Description | Returned type |
| ------------------- | ------------------------------ | ------------- |
|---------------------|--------------------------------|---------------|
| `noHeader()` | Excludes header part. | `this` |
| `noHeader(Boolean)` | Includes/excludes header part. | `this` |
| `getHeader()` | Returns header text. | `String` |
Expand All @@ -356,7 +382,7 @@ It provides a couple of properties and methods that allow altering the output fo
## Helper Methods

| Name | Description | Returned type |
| -------------------------------------- | -------------------------------------------------------------- | ------------- |
|----------------------------------------|----------------------------------------------------------------|---------------|
| `date(pattern: String = "yyyy-MM-dd")` | Shorthand for retrieving the current date in the given format. | `String` |
| `markdownToHTML(input: String)` | Converts given Markdown content to HTML output. | `String` |
| `markdownToPlainText(input: String)` | Converts given Markdown content to Plain Text output. | `String` |
Expand Down