chore: trunk ignore changelog due to release-plz

[Gowiem]

what

• Adds changelog to be ignored by trunk

why

• Release-please manages our changelog and trunk will fail because release-please isn't following prettier or markdownlint rules

references

• See chore(main): release 0.2.1 terraform-spacelift-automation#10 for where this originally came up

Summary by CodeRabbit

• New Features

  • Added an ignore rule for linters on the CHANGELOG.md file to streamline management.

• Documentation

  • Updated configuration file to reflect the new ignore rule for specific linters.

[coderabbitai]

Walkthrough

The changes in this pull request involve modifications to the .trunk/trunk.yaml configuration file. A new section has been added under the lint category to ignore specific linters for the CHANGELOG.md file. The linters prettier and markdownlint are now excluded for this file, which is managed by release-please. The overall structure and organization of the configuration file remain unchanged.

Changes

File	Change Summary
.trunk/trunk.yaml	Added ignore rule for CHANGELOG.md to exclude prettier and markdownlint linters.

Poem

In the trunk, a change so bright,
Linters set aside, a welcome sight.
For CHANGELOG.md, they take a break,
Managed by release-please, for goodness' sake!
A tidy file, with rules in place,
Configuration smiles, a happy space! 🎉

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a89284a and cc7382b.

📒 Files selected for processing (1)

• .trunk/trunk.yaml (1 hunks)

🔇 Additional comments (1)

.trunk/trunk.yaml (1)

37-40: LGTM! Well-structured ignore rule with clear documentation.

The implementation correctly excludes the CHANGELOG.md file from prettier and markdownlint checks, which aligns with the PR objective since release-please manages this file with its own formatting.

Let's verify the configuration:

✅ Verification successful

Configuration verified and correctly implemented

The trunk.yaml configuration is properly structured with the ignore rule for CHANGELOG.md, and the CHANGELOG.md file exists in the repository. The configuration will successfully prevent prettier and markdownlint from processing the changelog, allowing release-please to manage it independently.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify trunk configuration and ensure CHANGELOG.md is properly ignored

# Check if the ignore rule is properly parsed
trunk check --config-only 2>&1 | grep -A 2 "ignore:"

# Verify CHANGELOG.md is listed in ignored files
trunk list-files --ignored-files 2>&1 | grep "CHANGELOG.md"

Length of output: 102

---

Script:

#!/bin/bash
# Let's verify the trunk configuration structure and CHANGELOG.md handling differently

# Check if trunk.yaml exists and view its content
cat .trunk/trunk.yaml

# Check if CHANGELOG.md exists
ls CHANGELOG.md 2>/dev/null

# Look for any other trunk ignore configurations
rg -l "ignore.*CHANGELOG.md" .trunk/

Length of output: 1424

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[oycyc]

The title release-"plz" looks so funny to me 😆

[Gowiem]

@oycyc haha yeah, I had it written as release-please, but then realized the commit message may be too long and that was a way to shorten it 😅