Package detail

@changesets/git

changesets5.7mMIT3.0.4

Some git helpers that changesets use to get information

readme

A tool to manage versioning and changelogs
with a focus on multi-package repositories

The changesets workflow is designed to help when people are making changes, all the way through to publishing. It lets contributors declare how their changes should be released, then we automate updating package versions, and changelogs, and publishing new versions of packages based on the provided information.

Changesets has a focus on solving these problems for multi-package repositories, and keeps packages that rely on each other within the multi-package repository up-to-date, as well as making it easy to make changes to groups of packages.

How do we do that?

A changeset is an intent to release a set of packages at particular semver bump types with a summary of the changes made.

The @changesets/cli package allows you to write changeset files as you make changes, then combine any number of changesets into a release, that flattens the bump-types into a single release per package, handles internal dependencies in a multi-package-repository, and updates changelogs, as well as release all updated packages from a mono-repository with one command.

How do I get started?

If you just want to jump in to using changesets, the Intro to using changesets and @changesets/cli docs are where you should head.

If you want a detailed explanation of the concepts behind changesets, or to understand how you would build on top of changesets, check out our detailed-explanation.

We also have a dictionary.

Integrating with CI

While changesets can be an entirely manual process, we recommend integrating it with how your CI works.

To check that PRs contain a changeset, we recommend using the changeset bot, or if you want to fail builds on a changesets failure, run yarn changeset status in CI.

To make releasing easier, you can use this changesets github action to automate creating versioning pull requests, and optionally publishing packages.

Documentation

Cool Projects already using Changesets for versioning and changelogs

Thanks/Inspiration

bolt - Brought us a strong concept of how packages in a mono-repo should be able to interconnect, and provided the initial infrastructure to get inter-package information.
Atlassian - The original idea/sponsor of the changesets code, and where many of the ideas and processes were fermented. It was originally implemented by the team behind atlaskit.
lerna-semantic-release - put down many of the initial patterns around updating packages within a multi-package-repository, and started us thinking about how to manage dependent packages.
Thinkmill - For sponsoring the focused open sourcing of this project, and the version two rearchitecture.

changelog

@changesets/git

3.0.4

Patch Changes

#1636 f73f84a Thanks @Netail! - Correctly resolve new changesets with since option when the .changeset directory is not directly in the git root

3.0.3

Patch Changes

#1620 b15e629 Thanks @Netail! - Make sure that git diff always returns the paths relative to the git root in case diff.relative has been set to true in the git config

3.0.2

Patch Changes

#1487 7323704 Thanks @bluwy! - Bump micromatch dependency to ^4.0.8 to prevent installing version with vulnerability
#1514 962ab91 Thanks @nicoalonsop! - Update spawndamnit to fix cross-spawn vulnerability

3.0.1

Patch Changes

#1445 52c302a Thanks @bluwy! - Remove unused @babel/runtime dependency

3.0.0

Major Changes

#1185 a971652 Thanks @Andarist! - package.json#exports have been added to limit what (and how) code might be imported from the package.

Patch Changes

Updated dependencies [a971652]:
- @changesets/errors@0.2.0
- @changesets/types@6.0.0

2.0.0

Major Changes

#1029 598136a Thanks @Andarist! - getCommitsThatAddFiles accepts an options object argument now where you can use cwd option.
```
-getCommitsThatAddFiles(paths, cwd);
+getCommitsThatAddFiles(paths, { cwd });
```
#1029 598136a Thanks @Andarist! - getCurrentCommitId and getCommitsThatAddFiles return full commit hashes now instead of short ones. You can get short ones by using the short: true option.
#1029 598136a Thanks @Andarist! - Previously deprecated getCommitThatAddsFile has been removed while getCommitsThatAddFiles is still available.

Minor Changes

#1033 521205d Thanks @Andarist! - getChangedPackagesSinceRef accepts now a new changedFilePatterns option. It can be used to determine which packages should be classified as changed. You can pass an array of glob patterns to it.

Patch Changes

Updated dependencies [521205d]:
- @changesets/types@5.2.1

1.5.0

Minor Changes

#662 8c08469 Thanks @JakeGinnivan! - Add tagExists & remoteTagExists git helpers

Patch Changes

Updated dependencies [8c08469]:
- @changesets/types@5.2.0

1.4.1

Patch Changes

#889 f64bc1b Thanks @jakubmazanec! - Fixed getCurrentCommitId so that the returned value doesn't contain quotation marks on some Windows machines.

1.4.0

Minor Changes

#858 dd9b76f Thanks @dotansimha! - Added a new helper function: getCurrentCommitId

Patch Changes

Updated dependencies [dd9b76f]:
- @changesets/types@5.1.0

1.3.2

Patch Changes

#770 eb86652 Thanks @alizeait! - getChangedFilesSince and getChangedPackagesSinceRef will now return the correct absolute paths of the changed files when the passed cwd is different from the repository's root.
Updated dependencies [c87eba6]:
- @changesets/types@5.0.0

1.3.1

Patch Changes

Updated dependencies [27a5a82]:
- @changesets/types@4.1.0

1.3.0

Minor Changes

#725 77c1cef Thanks @RoystonS, @Andarist! - New public utilities have been added: deepenCloneBy and isRepoShallow.

1.2.1

Patch Changes

#667 fe8db75 Thanks @fz6m! - Upgraded @manypkg/get-packages dependency to fix getting correct packages in pnpm workspaces with exclude rules.
Updated dependencies [9a993ba]:
- @changesets/types@4.0.2

1.2.0

Minor Changes

#634 2b49c39 Thanks @joeldenning! - A new getAllTags utility has been added.

1.1.2

Patch Changes

Updated dependencies [e89e28a]:
- @changesets/types@4.0.1

1.1.1

Patch Changes

Updated dependencies [de2b4a5]:
- @changesets/types@4.0.0

1.1.0

Minor Changes

24d7bc9 #495 Thanks @RoystonS! - Automatically deepen shallow clones in order to determine the correct commit at which changesets were added.
24d7bc9 #495 Thanks @RoystonS! - Deprecate the getCommitThatAddsFile function. It's replaced with a bulk getCommitsThatAddFiles operation which will safely deepen a shallow repo whilst processing multiple filenames simultaneously.

1.0.6

Patch Changes

1dd3117 #418 Thanks @jonathanmorley! - Don't return paths for unchanged packages
Updated dependencies [a57d163]:
- @changesets/types@3.1.1

1.0.5

Patch Changes

89f0c49 #352 Thanks @MichaelKapustey! - Previously packages nested inside of other packages would show both the nested package and the outer package as changed. Now, only the nested package will show as changed.
09f62f9 #355 Thanks @acheronfail! - Fix an issue where refs that didn't exist were silently ignored
Updated dependencies [2b49d66]:
- @changesets/types@3.0.0

1.0.4

Patch Changes

aa840db #336 Thanks @MichaelKapustey! - Changed packages detection fixed on Windows.

1.0.3

Patch Changes

1706fb7 #321 Thanks @mitchellhamilton! - Fix TypeScript declarations
Updated dependencies [1706fb7]:
- @changesets/errors@0.1.4
- @changesets/types@2.0.1

1.0.2

Patch Changes

Updated dependencies [011d57f]:
- @changesets/types@2.0.0

1.0.1

Patch Changes

04ddfd7 #305 Thanks @Noviny! - Add link to changelog in readme
b49e1cf #306 Thanks @Andarist! - Ignore node_modules when glob searching for packages. This fixes an issue with package cycles.
Updated dependencies [04ddfd7, e56928b]:
- @changesets/errors@0.1.3
- @changesets/types@1.0.1

1.0.0

Major Changes

cc8c921 #290 Thanks @mitchellhamilton! - Use @manypkg/get-packages instead of get-workspaces in getChangedPackagesSinceRef. This means getChangedPackagesSinceRef now returns Promise<Package[]>(where Package is from @manypkg/get-packages) rather than Promise<Workspace[]>(where Workspace is from get-workspaces). The notable change is that config was renamed to packageJson and the package objects don't have a name field(use packageJson.name instead).

Patch Changes

Updated dependencies [41e2e3d, cc8c921, cc8c921, 2363366]:
- @changesets/types@1.0.0

0.4.0

Minor Changes

fe0d9192 #236 Thanks @Andarist! - Read also pnpm workspace packages when searching for packages.

Patch Changes

Updated dependencies [fe0d9192, fe0d9192]:
- get-workspaces@0.6.0

0.3.0

Minor Changes

bca8865 #221 Thanks @mitchellhamilton! - Removed getChangedPackagesSinceMaster and getChangedChangesetFilesSinceMaster and replace them with getChangedPackagesSinceRef and getChangedChangesetFilesSinceRef. The new methods along with getChangedFilesSince also now require arguments as an object with cwd and ref properties to avoid accidentally passing cwd as ref and vice versa

0.2.5

Patch Changes

b17ed74 #216 Thanks @mitchellhamilton! - Get commit from the creation of a changeset rather than the last modification

0.2.4

Patch Changes

Updated dependencies [8f0a1ef, 8f0a1ef, 8f0a1ef]:

0.2.3

Patch Changes

Updated dependencies [94de7c1]:
- @changesets/errors@0.1.0

0.2.2

Patch Changes

89c0894 #167 Thanks @Noviny! - Fix broken sinceMaster arg - which was not working with v2 changesets

0.2.1

Patch Changes

8c43fa0 #155 Thanks @Noviny! - Add Readme
0320391 #163 Thanks @Noviny! - Reordered dependencies in the package json (this should have no impact)
Updated dependencies [8c43fa0, 1ff73b7]:
- @changesets/types@0.3.0

0.2.0

Minor Changes

296a6731 - Safety bump: Towards the end of preparing changesets v2, there was a lot of chaos - this bump is to ensure every package on npm matches what is found in the repository.

Patch Changes

Updated dependencies [296a6731]:
- get-workspaces@0.5.0
- @changesets/types@0.2.0