auri

Auri

Organize package changes and releases.

npm i -D auri
yarn add -D auri
pnpm add -D auri

Run commands:

npx auri
pnpm exec auri
yarn auri

Set up

1. Create .auri directory
2. Create config.json inside .auri
3. Generate a Github personal access token with the following scopes: repo, user:email
4. Store the token as AURI_GITHUB_TOKEN in Github actions secrets
5. Add auri.publish script to each package's package.json - this will be the command Auri will use to publish
6. Make sure "Read and write permission" is enabled in repository settings > Actions > General > Workflow permissions

Config

repository

Required Full Github repository url.

{
	"repository": "https://github.com/pilcrowOnPaper/auri"
}

scripts

format

Command for formatting code. Will run after Auri updates your changelogs and package.json.

{
	"scripts": {
		"format": "pnpm format"
	}
}

publish_setup

Command to run before any publish command runs.

{
	"scripts": {
		"publish_setup": "pnpm build-dependency"
	}
}

Commands

auri add

Creates a new changeset in .auri directory. A changeset is a markdown file:

---
package: "" # package name (package.json)
type: "" # "major", "minor", "patch" (semver)
---

<!-- changeset content -->

auri prepare

1. Generate changelogs based on changesets
2. Update package.json
3. Delete all changesets
4. Commits all code to auri branch
5. Creates new PR auri => main

auri publish

Compares version of package.json and one in the NPM registry, and runs auri.publish if it differs