Skip to content

Commit 1b9687f

Browse files
bluwyakinocccbeeequeueAndaristmelanieseltzer
authored
Add new docs site (changesets#1979)
* Add a docs site for `changesets` (changesets#1512) Co-authored-by: bluwy <[email protected]> * Update docs * Remove docsearch dependencies * Adjust colors * Move pages * Improve code blocks * Add group icons * Add head tags * Fix lint error * Apply suggestions from code review Co-authored-by: Adam Haglund <[email protected]> * Simplify main readme * Add Netlify stuff * Update picomatch links * packageManager with h4sh * update local node version * Fix lint * Rewrite intro pages - rewrite getting-started - rewrite concepts -> origins - rewrite common-questions -> faq - delete what-are-changesets (covered in getting-started) - delete dictionary (explain everything inline where possible) * Fix site build * Tweak styles * Improve faq * Update automating-changesets * Update acknowledgements * Update config page * Improve getting-started * Sync code groups * Update cli * Update CLI page * Automate CLI page * Rename origins to why * Rename technical decisions * Move experimental options to config page * Add changeset file icon * Update fixed and linked packages docs * Flatten guide folder * Re-order sections * Update why * Update changelog format * Add customize commit page * Rewrite prereleases * Use generator for changelog and commit * Separate versioning and publishing guide * Publish first time * Update snapshot releases * Fix git tag * Remove versioning-apps because it's clunky * Add backport guide * Fix netlify build * Update og description * Update readme * Update `snapshot.useCalculatedVersion` docs * Fix install * clarify and explain publishing new packages and their dist-tags * reorder package managers * add note regarding pnpm * try to clarify separate-branch prerelease flow make seperate-branch flow easier to distinguish re-order parts for clarity * clarify that `exit` should be run on the separate branch * Fix lint * Add pm info and commit-short docs * Update CLI page * Document `publishConfig.directory` fix changesets#733 * Add simple section for deleting package fix changesets#1416 * Document nightly usecase and pkg.pr.new fix changesets#1091 * Document accidental new package publish fix changesets#756 Co-authored-by: Melanie Seltzer <[email protected]> * Update git-tag docs * docs: make init command interactive (changesets#2088) * Add packages pages * docs: create page for GitHub generator package (changesets#2127) * Add warnings for old docs pages * Update changelog github docs * Add more popular-ish packages docs * Tweak wording * Add basic migration page * docs: update and enhance comparison to other tools (changesets#2126) * update pnpm * update vitepress * add changes from changesets#2150 Co-Authored-By: Emmet Moore <[email protected]> * Add blog pages and og images (changesets#2154) * remove unnecessary property * Add private packages docs Co-authored-by: Emelia Smith <[email protected]> * Update as beyond npm --------- Co-authored-by: Akino <[email protected]> Co-authored-by: Adam Haglund <[email protected]> Co-authored-by: Mateusz Burzyński <[email protected]> Co-authored-by: Melanie Seltzer <[email protected]> Co-authored-by: Felix Schneider <[email protected]> Co-authored-by: Emmet Moore <[email protected]> Co-authored-by: Emelia Smith <[email protected]>
1 parent fd7724a commit 1b9687f

67 files changed

Lines changed: 3875 additions & 482 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@ dist/
44
node_modules/
55
.env
66
*error.log
7+
/site/.vitepress/cache/

‎.node-version‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v22.9.0
1+
v24

‎README.md‎

Lines changed: 4 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -21,102 +21,11 @@
2121
<br/>
2222

2323
[![Open on npmx.dev](https://npmx.dev/api/registry/badge/version/@changesets/cli?name=true)](https://npmx.dev/package/@changesets/cli)
24-
[![Open on npmx.dev](https://npmx.dev/api/registry/badge/version/@changesets/cli?color=229fe4&value=View+changelog&label=+)](./packages/cli/CHANGELOG.md)
24+
[![View changelog](https://npmx.dev/api/registry/badge/version/@changesets/cli?color=229fe4&value=View+changelog&label=+)](./packages/cli/CHANGELOG.md)
2525
[![pkg.pr.new](https://pkg.pr.new/badge/changesets/changesets)](https://pkg.pr.new/~/changesets/changesets)
2626

27-
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.
27+
Changesets is designed to help manage and describe changes, all the way through to publishing. It lets contributors declare how their changes should be released, and it'll handle updating package versions, changelogs, and publishing based on the provided changesets.
2828

29-
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.
29+
Changesets has a focus on solving these problems for monorepos, keeping packages that rely on each other up to date, as well as making it easy to make changes to groups of packages. Conceptually, the workflow is also beneficial for single package repos.
3030

31-
## How do we do that?
32-
33-
A `changeset` is an intent to release a set of packages at particular [semver bump types](https://semver.org/) with a summary of the changes made.
34-
35-
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.
36-
37-
## How do I get started?
38-
39-
If you just want to jump in to using changesets, the [Intro to using changesets](./docs/intro-to-using-changesets.md) and [@changesets/cli](./packages/cli/README.md) docs are where you should head.
40-
41-
If you want a detailed explanation of the concepts behind changesets, or to understand how you would build on top
42-
of changesets, check out our [detailed-explanation](./docs/detailed-explanation.md).
43-
44-
We also have a [dictionary](./docs/dictionary.md).
45-
46-
## Integrating with CI
47-
48-
While changesets can be an entirely manual process, we recommend integrating it with how your CI works.
49-
50-
To check that PRs contain a changeset, we recommend using [the changeset bot](https://github.com/apps/changeset-bot), or if you want to fail builds on a changesets failure, run `yarn changeset status` in CI.
51-
52-
To make releasing easier, you can use [this changesets github action](https://github.com/changesets/action) to automate creating versioning pull requests, and optionally publishing packages.
53-
54-
## Documentation
55-
56-
- [Intro to using changesets](./docs/intro-to-using-changesets.md)
57-
- [Detailed explanation](./docs/detailed-explanation.md)
58-
- [Common questions](./docs/common-questions.md)
59-
- [Adding a changeset](./docs/adding-a-changeset.md)
60-
- [Automating changesets](./docs/automating-changesets.md)
61-
- [Checking for changesets](./docs/checking-for-changesets.md)
62-
- [Command line options](./docs/command-line-options.md)
63-
- [Config file options](./docs/config-file-options.md)
64-
- [Decisions](./docs/decisions.md)
65-
- [Dictionary](./docs/dictionary.md)
66-
- [Fixed packages](./docs/fixed-packages.md)
67-
- [Linked packages](./docs/linked-packages.md)
68-
- [Modifying changelog format](./docs/modifying-changelog-format.md)
69-
- [Prereleases](./docs/prereleases.md)
70-
- [Problems publishing in monorepos](./docs/problems-publishing-in-monorepos.md)
71-
- [Snapshot releases](./docs/snapshot-releases.md)
72-
- [Versioning applications and other non-npm packages](./docs/versioning-apps.md)
73-
- [Experimental Options](./docs/experimental-options.md)
74-
75-
## Cool Projects already using Changesets for versioning and changelogs
76-
77-
- [atlaskit](https://atlaskit.atlassian.com)
78-
- [emotion](https://emotion.sh/docs/introduction)
79-
- [keystone](https://keystonejs.com)
80-
- [react-select](https://react-select.com/home)
81-
- [XState](https://xstate.js.org)
82-
- [pnpm](https://pnpm.io)
83-
- [tinyhttp](https://github.com/talentlessguy/tinyhttp)
84-
- [Firebase Javascript SDK](https://github.com/firebase/firebase-js-sdk)
85-
- [Formik](https://github.com/jaredpalmer/formik)
86-
- [MobX](https://github.com/mobxjs/mobx)
87-
- [Nhost](https://github.com/nhost/nhost)
88-
- [verdaccio](https://verdaccio.org)
89-
- [Chakra UI](https://chakra-ui.com)
90-
- [Astro](https://astro.build)
91-
- [Biome](https://biomejs.dev)
92-
- [SvelteKit](https://kit.svelte.dev)
93-
- [Hydrogen](https://hydrogen.shopify.dev)
94-
- [react-pdf](https://github.com/diegomura/react-pdf)
95-
- [GraphQL Code Generator](https://github.com/dotansimha/graphql-code-generator)
96-
- [GraphQL Yoga](https://github.com/dotansimha/graphql-yoga)
97-
- [GraphQL-Mesh](https://github.com/Urigo/graphql-mesh)
98-
- [GraphiQL](https://github.com/graphql/graphiql)
99-
- [wagmi](https://github.com/wagmi-dev/wagmi)
100-
- [refine](https://github.com/pankod/refine)
101-
- [Modern Web](https://modern-web.dev)
102-
- [Atomizer](https://github.com/acss-io/atomizer)
103-
- [Medusa](https://github.com/medusajs/medusa)
104-
- [OpenZeppelin Contracts](https://github.com/OpenZeppelin/openzeppelin-contracts)
105-
- [Block Protocol](https://github.com/blockprotocol/blockprotocol)
106-
- [Remix](https://remix.run/)
107-
- [Clerk](https://github.com/clerk/javascript)
108-
- [Hey API](https://github.com/hey-api/openapi-ts)
109-
- [neverthrow](https://github.com/supermacro/neverthrow)
110-
- [Apollo Client](https://github.com/apollographql/apollo-client)
111-
- [Adobe Spectrum CSS](https://github.com/adobe/spectrum-css)
112-
- [Adobe Spectrum Web Components](https://github.com/adobe/spectrum-web-components)
113-
- [React Email](https://react.email)
114-
115-
<!-- NOTE: we currently only accept new entries with at least 1000 GitHub stars -->
116-
117-
# Thanks/Inspiration
118-
119-
- [bolt](https://github.com/boltpkg/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.
120-
- [Atlassian](https://www.atlassian.com/) - 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](https://atlaskit.atlassian.com).
121-
- [lerna-semantic-release](https://github.com/atlassian/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.
122-
- [Thinkmill](https://www.thinkmill.com.au) - For sponsoring the focused open sourcing of this project, and the version two rearchitecture.
31+
Visit https://changesets.dev to learn more.

‎docs/adding-a-changeset.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
> [!WARNING]
2+
> This documentation is outdated. View the up-to-date version at https://changesets.dev/faq#how-do-i-add-a-changeset
3+
14
# Adding a changeset
25

36
Hi! You might be here because a person or a bot has asked you to 'add a changeset' to a project. Let's walk through adding a changeset. But first, what is a changeset?

‎docs/automating-changesets.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
> [!WARNING]
2+
> This documentation is outdated. View the up-to-date version at https://changesets.dev/guide/automating
3+
14
# Automating Changesets
25

36
While changesets are designed to work with a fully manual process, it also provides tools to help automate these releases. These can be broken into two major decisions:

‎docs/checking-for-changesets.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
> [!WARNING]
2+
> This documentation is outdated. View the up-to-date version at https://changesets.dev/guide/automating#how-do-i-ensure-pull-requests-have-changesets
3+
14
# Checking for changesets
25

36
Using `@changesets/cli`, there is a `status` command. See the docs for it in the

‎docs/command-line-options.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
> [!WARNING]
2+
> This documentation is outdated. View the up-to-date version at https://changesets.dev/guide/cli
3+
14
# Command line options
25

36
The command line for changesets is the main way of interacting with it. There are 4 main commands. If you are looking for how we recommend you setup and manage changesets with the commands, check out our [intro to using changesets](./intro-to-using-changesets.md)

‎docs/common-questions.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
> [!WARNING]
2+
> This documentation is outdated. View the up-to-date version at https://changesets.dev/faq
3+
14
# Common Questions
25

36
A quick list of common questions you might want answered to understand what changesets is doing, without going into minutiae or workflow.

‎docs/config-file-options.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
> [!WARNING]
2+
> This documentation is outdated. View the up-to-date version at https://changesets.dev/guide/config
3+
14
# Configuring Changesets
25

36
Changesets has a minimal amount of configuration options. Mostly these are for when you need to change the default workflows. These are stored in `.changeset/config.json`. Our default config is:

‎docs/decisions.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
> [!WARNING]
2+
> This documentation is outdated. View the up-to-date version at https://changesets.dev/guide/technical-decisions
3+
14
# Decisions
25

36
This file is a discussion of some of the rules and design decisions that have gone into making changesets. The goal of all of these has been to make the experience of using changesets easy, while still providing the maximum value possible.

0 commit comments

Comments
 (0)