Skip to content

feat: add sync variant#11729

Merged
ematipico merged 3 commits intomainfrom
feat/cli-hook-command
Aug 28, 2024
Merged

feat: add sync variant#11729
ematipico merged 3 commits intomainfrom
feat/cli-hook-command

Conversation

@ematipico
Copy link
Copy Markdown
Member

@ematipico ematipico commented Aug 15, 2024

Changes

Closes #10876

I added a "sync" variant to the command. This will be useful to the extension too.

This is flagged as minor, because it adds new information.

Testing

Existing CI should pass. Should I create a test? 🤔

Docs

withastro/docs#9110

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Aug 15, 2024

🦋 Changeset detected

Latest commit: d5ba3eb

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

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

@github-actions github-actions bot added pkg: astro Related to the core `astro` package (scope) pr: docs A PR that includes documentation for review semver: minor Change triggers a `minor` release labels Aug 15, 2024
Copy link
Copy Markdown
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.

@ematipico ematipico added this to the 4.15 milestone Aug 15, 2024
Copy link
Copy Markdown
Member

@florian-lefebvre florian-lefebvre left a comment

Choose a reason for hiding this comment

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

LGTM, may break a few integrations

@ematipico
Copy link
Copy Markdown
Member Author

LGTM, may break a few integrations

How? :|

Maybe because they use a switch of command?

@florian-lefebvre
Copy link
Copy Markdown
Member

yes, command have been holding 3 possible values for so long that maybe some conditions will be broken. That being said, I don't see a better way than this so up to integrations authors to update

Copy link
Copy Markdown
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Quick suggestion for the changeset @ematipico ! When something new is added, I always like starting with "Adds" because that's the biggest clue that this is new, something you could check out, but not necessary and shouldn't break anything.

Also, I saw the conversation here about whether or not some projects might be relying on the fact that there have been exactly three options previously. If you felt it was necessary or helpful, you could consider adding another paragraph with a single line just saying something like:

If your integration previously relied on knowing how many variants existed for the `command` property, you must update your logic to account for this new option.

if you feel like that's a common enough thing!

@florian-lefebvre
Copy link
Copy Markdown
Member

I think it's useful to add such paragraph

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Copy link
Copy Markdown
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Approving for docs!

@ematipico ematipico merged commit 1c54e63 into main Aug 28, 2024
@ematipico ematipico deleted the feat/cli-hook-command branch August 28, 2024 11:16
@astrobot-houston astrobot-houston mentioned this pull request Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pkg: astro Related to the core `astro` package (scope) pr: docs A PR that includes documentation for review semver: minor Change triggers a `minor` release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

A command field in astro:config:setup returns build value while running check command

4 participants