This is honestly just a fun side project I'm working on with no intentions of using it in any production-like setting.
It's based on the existing changesets tool, but I wanted to make it more generic and not tied to a specific project.
When you're ready to make a change you can run the changeset add command to produce a changeset file which will contain the type of change being made and a message describing the change.
The changeset can be edited to provide further details and documentation about the change. Anything added will be surfaced to the CHANGELOG.md file when the changeset is consumed.
changeset add --bump-type major --message "Added a new feature" # or simply `changeset add` to prompt for the bump type and message| Argument | Description | Default |
|---|---|---|
--bump-type |
The type of bump to perform | |
--message |
The summary message to include in the changeset |
This is mainly a helper for CI or other scripts, but you can run the changeset get-version command to get the current version of the project.
changeset get
# 1.2.3changeset versionchangeset preview changelogchangeset preview versionA dry run can be performed by passing the --dry-run flag.
This will output the highest version type found in the .changeset directory and the changesets that were found.
This plugin is used to read/write the version to/from a plain file.
The file must be a plain text file with the following format:
1.2.3
Example config file:
{
// Alternatively you can use
// "https://raw.githubusercontent.com/universal-changesets/core/main/changeset-config.schema.json"
// if you want to use the latest schema
"$schema": "https://raw.githubusercontent.com/universal-changesets/core/v1.0.0/changeset-config.schema.json",
"plugin": {
"sha256": "e63c184c019d2198b497ceeaefeb59587da138ca7f78edc34e21332a7cc4b18c",
"url": "gh:universal-changesets/[email protected]"
}
}