Skip to content

Commit

Permalink
docs: Mention changelogCommitBodies and add IntelliJ schema setting…
Browse files Browse the repository at this point in the history
…s guide (#721)

* docs: intellij schema, add missing mention of changelogCommitBodies

* link

* wrap

* fix length
  • Loading branch information
mzdm authored Jun 4, 2024
1 parent 5a6ec6f commit 49e7d4c
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 1 deletion.
Binary file added docs/assets/intellij-schema-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions docs/configuration/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -345,3 +345,23 @@ command:
version:
fetchTags: false
```

### changelogCommitBodies

Configuration for including commit bodies in the changelog.

```yaml
command:
version:
changelogCommitBodies:
include: true
onlyBreaking: false
```

#### include

Whether to include commit bodies in the changelog. Defaults to `false`.

#### onlyBreaking

Whether to include only breaking changes in the changelog. Defaults to `true`.
13 changes: 12 additions & 1 deletion docs/ide-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,18 @@ Melos will create an IntelliJ project module for each package in your Melos
workspace, and will create flutter and dart Run configurations for your
`main.dart`s and your package's test suite.

![Generated Run configurations](/assets/intellij-run-configurations.png)
<img src="/assets/intellij-run-configurations.png" alt="Generated Run configurations" height="600"/>

### `melos.yaml`

Autocompletion and validation of `melos.yaml` can be enabled in IntelliJ by
going to `Settings` > `Languages & Frameworks` > `Schemas and DTDs` >
`JSON Schema Mappings` and adding the Melos schema:
- Schema url: https://raw.githubusercontent.com/blaugold/melos-code/main/melos.yaml.schema.json
- Schema version: JSON Schema version 7
- File: Select `melos.yaml`

<img src="/assets/intellij-schema-settings.png" alt="Schema settings" width="800"/>

## VS Code

Expand Down

0 comments on commit 49e7d4c

Please sign in to comment.