Skip to content

Commit b11f171

Browse files
konardclaude
andcommitted
fix: exclude .changeset from Spotless markdown formatting
The flexmark formatter in Spotless breaks the YAML frontmatter format used by changesets (---/content/---). Exclude .changeset/** from markdown formatting to preserve the changeset file format. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent b3ed472 commit b11f171

File tree

4 files changed

+27
-31
lines changed

4 files changed

+27
-31
lines changed

.changeset/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ Each changeset file has two parts:
3939

4040
1. **Frontmatter** (between `---` markers):
4141
- Package name and version bump type (major, minor, or patch)
42-
4342
2. **Description**:
4443
- Clear description of what changed
4544
- Use present tense ("Add feature" not "Added feature")
@@ -76,3 +75,4 @@ Add async delay function with CompletableFuture support for non-blocking operati
7675
- Be concise but descriptive in your descriptions
7776
- The bump type determines the version number change
7877
- Multiple changesets are automatically merged during release
78+

CONTRIBUTING.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,20 +30,17 @@ Thank you for your interest in contributing! This document provides guidelines a
3030
git clone https://github.com/YOUR_USERNAME/java-ai-driven-development-pipeline-template.git
3131
cd java-ai-driven-development-pipeline-template
3232
```
33-
3433
2. **Verify Java and Maven versions**:
3534

3635
```bash
3736
java --version # Should be 17+
3837
mvn --version # Should be 3.8+
3938
```
40-
4139
3. **Install dependencies and build**:
4240

4341
```bash
4442
mvn clean install
4543
```
46-
4744
4. **Install pre-commit hooks** (optional but recommended):
4845

4946
```bash
@@ -77,7 +74,6 @@ git checkout -b feature/your-feature-name
7774
mvn spotbugs:check # Static analysis
7875
mvn test # Unit tests
7976
```
80-
8177
4. Create a changeset (see [Changesets](#changesets))
8278
5. Commit your changes:
8379

@@ -221,7 +217,6 @@ Each changeset has two parts:
221217

222218
1. **Frontmatter** (between `---` markers):
223219
- Package name and version bump type (major, minor, or patch)
224-
225220
2. **Description**:
226221
- Clear description of what changed
227222
- Use present tense ("Add feature" not "Added feature")
@@ -288,11 +283,11 @@ Releases are automated through GitHub Actions using the changeset workflow.
288283

289284
### Release Modes (via workflow_dispatch)
290285

291-
| Mode | Description |
292-
|------|-------------|
293-
| `changeset` | Release based on pending changesets (default) |
294-
| `instant` | Direct version bump without changesets |
295-
| `changeset-pr` | Create a PR with a new changeset |
286+
| Mode | Description |
287+
|----------------|-----------------------------------------------|
288+
| `changeset` | Release based on pending changesets (default) |
289+
| `instant` | Direct version bump without changesets |
290+
| `changeset-pr` | Create a PR with a new changeset |
296291

297292
### Manual Release
298293

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -163,11 +163,11 @@ Description of the changes made.
163163

164164
### Automated Workflows
165165

166-
| Trigger | Actions |
167-
|-----------------|--------------------------------------------------|
168-
| Pull Request | Lint, format check, tests, changeset validation |
169-
| Push to main | All checks + auto-release if changesets present |
170-
| Manual dispatch | Changeset, instant, or changeset-pr mode |
166+
| Trigger | Actions |
167+
|-----------------|-------------------------------------------------|
168+
| Pull Request | Lint, format check, tests, changeset validation |
169+
| Push to main | All checks + auto-release if changesets present |
170+
| Manual dispatch | Changeset, instant, or changeset-pr mode |
171171

172172
### Test Matrix
173173

@@ -188,11 +188,11 @@ The release process uses a **changeset-based workflow** similar to JavaScript's
188188

189189
### Release Modes (via workflow_dispatch)
190190

191-
| Mode | Description |
192-
|----------------|----------------------------------------------|
193-
| `changeset` | Release based on pending changesets (default)|
194-
| `instant` | Direct version bump without changesets |
195-
| `changeset-pr` | Create a PR with a new changeset |
191+
| Mode | Description |
192+
|----------------|-----------------------------------------------|
193+
| `changeset` | Release based on pending changesets (default) |
194+
| `instant` | Direct version bump without changesets |
195+
| `changeset-pr` | Create a PR with a new changeset |
196196

197197
## Configuration
198198

@@ -217,16 +217,16 @@ Key sections to customize:
217217

218218
## Scripts Reference
219219

220-
| Script | Purpose |
221-
|-------------------------------|-----------------------------------------|
222-
| `check-file-size.mjs` | Validate files don't exceed 1000 lines |
223-
| `bump-version.mjs` | Bump semantic version in pom.xml |
224-
| `collect-changelog.mjs` | Collect changesets into CHANGELOG.md |
225-
| `create-github-release.mjs` | Create GitHub release |
226-
| `create-manual-changeset.mjs` | Create a new changeset file |
227-
| `merge-changesets.mjs` | Merge multiple changesets into one |
228-
| `validate-changeset.mjs` | Validate changeset format |
229-
| `version-and-commit.mjs` | Full release workflow |
220+
| Script | Purpose |
221+
|-------------------------------|----------------------------------------|
222+
| `check-file-size.mjs` | Validate files don't exceed 1000 lines |
223+
| `bump-version.mjs` | Bump semantic version in pom.xml |
224+
| `collect-changelog.mjs` | Collect changesets into CHANGELOG.md |
225+
| `create-github-release.mjs` | Create GitHub release |
226+
| `create-manual-changeset.mjs` | Create a new changeset file |
227+
| `merge-changesets.mjs` | Merge multiple changesets into one |
228+
| `validate-changeset.mjs` | Validate changeset format |
229+
| `version-and-commit.mjs` | Full release workflow |
230230

231231
## Design Decisions
232232

pom.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,7 @@
180180
</includes>
181181
<excludes>
182182
<exclude>node_modules/**</exclude>
183+
<exclude>.changeset/**</exclude>
183184
</excludes>
184185
<flexmark/>
185186
</markdown>

0 commit comments

Comments
 (0)