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.

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

chore(changesets): use changelog-github-compact formatter #61

Merged

Conversation

dominikg
Copy link
Contributor

@dominikg dominikg commented Dec 20, 2023

This is the less verbose github formatter I forked from changesets own, adding links to merged PRs or commits

See https://github.com/sveltejs/vite-plugin-svelte/blob/main/packages/vite-plugin-svelte/CHANGELOG.md for an example

Summary by CodeRabbit

  • Chores
    • Updated the changelog configuration to enhance release documentation with a new plugin and repository specification.

Copy link

changeset-bot bot commented Dec 20, 2023

⚠️ No Changeset found

Latest commit: 4ce16d6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Dec 20, 2023

Walkthrough

The configuration for changelog generation in a project has been updated. Instead of using a single plugin, an array has been introduced, specifying a new plugin along with its configuration, including a repository reference. This update changes how changelogs are created, allowing for repository-specific formatting.

Changes

File Change Summary
.changeset/config.json Updated changelog plugin from a single string to an array with a new plugin and repository configuration.

🐇✨
In the code's quiet burrow, a change does stir,
From a line to an array, the changelog's new fur,
With a hop and a type, the repo's now in sight,
A rabbit's work done, under the moon's soft light. 🌙
✨🐇

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 X ?


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • You can reply to a review comment made by CodeRabbit.
  • You can tag CodeRabbit on specific lines of code or files in the PR by tagging @coderabbitai in a comment.
  • You can tag @coderabbitai in a PR comment and ask one-off questions about the PR and the codebase. Use quoted replies to pass the context for follow-up questions.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

Copy link

netlify bot commented Dec 20, 2023

Deploy Preview for sveltekit-search-params ready!

Name Link
🔨 Latest commit 4ce16d6
🔍 Latest deploy log https://app.netlify.com/sites/sveltekit-search-params/deploys/6582a34d1ae8840008252a8b
😎 Deploy Preview https://deploy-preview-61--sveltekit-search-params.netlify.app/
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 75ba336 and 4ce16d6.
Files ignored due to filter (2)
  • package.json
  • pnpm-lock.yaml
Files selected for processing (1)
  • .changeset/config.json (1 hunks)
Additional comments: 3
.changeset/config.json (3)
  • 3-6: The updated changelog configuration syntax appears correct and follows the JSON array format, including the plugin name and configuration object.

  • 5-5: Verify that the repository paoloricciuti/sveltekit-search-params specified in the changelog configuration is the correct repository for this project's changelog links.

Verification successful

The executed script confirms that the repository paoloricciuti/sveltekit-search-params specified in the .changeset/config.json file matches the origin repository of the current project. Therefore, the changelog configuration is correctly set to generate links to this repository.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Check if the repository mentioned in the configuration is the same as the origin repository of the current project.
git remote get-url origin | grep -q 'paoloricciuti/sveltekit-search-params' && echo "Repository matches." || echo "Repository does not match."

Length of output: 124

* 3-6: Ensure that any scripts, CI/CD pipelines, or tools that depend on the changelog format are updated to handle the new `changelog-github-compact` format.

@paoloricciuti paoloricciuti merged commit a0f6576 into paoloricciuti:master Dec 20, 2023
5 checks passed
@paoloricciuti
Copy link
Owner

Thanks @dominikg !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants