auri - npm Package Compare versions

Comparing version 0.9.4 to 1.0.0-next.3

CHANGELOG.md

 # auri
 
-## 0.9.4
+## 1.0.0-next.2
 
-### Patch changes
-
-- Fix Git checkout
-
-## 0.9.3
-
-### Patch changes
-
-- Fix Git checkout
-
-## 0.9.2
-
-### Patch changes
-
-- Fix changelog format ([#77](https://github.com/pilcrowOnPaper/auri/pull/77))
-
-## 0.9.1
-
-### Patch changes
-
-- Fix GitHub releases
-
-## 0.9.0
-
-### Minor changes
-
-- Breaking: Generate GitHub releases on publish ([#73](https://github.com/pilcrowOnPaper/auri/pull/73))
-
-## 0.8.1
-
-### Patch changes
-
-- Add PR numbers to changelogs ([#68](https://github.com/pilcrowOnPaper/auri/pull/68))
-- Fix Git bug ([#69](https://github.com/pilcrowOnPaper/auri/pull/69))
-
-## 0.8.0
-
-### Minor changes
-
-- Breaking: Reset project to only support monolith repositories
-
-## 0.7.4
-
-### Patch changes
-
-- [#64](https://github.com/pilcrowOnPaper/auri/pull/64) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Fix `auri.publish_setup` script not running
-
-## 0.7.3
-
-### Patch changes
-
-- [#62](https://github.com/pilcrowOnPaper/auri/pull/62) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Fix `auri.format` not getting called
-
-## 0.7.2
-
-### Patch changes
-
-- [#59](https://github.com/pilcrowOnPaper/auri/pull/59) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Fix published version detection
-
-## 0.7.1
-
-### Patch changes
-
-- [#56](https://github.com/pilcrowOnPaper/auri/pull/56) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Fix `publish` command
-
-## 0.7.0
-
-### Minor changes
-
-- [#49](https://github.com/pilcrowOnPaper/auri/pull/49) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : [Breaking] Remove `auri.publish`
-
-  - Replaced with `auri.build`
-
-  - All packages are published using `pnpm publish`
-
-### Patch changes
-
-- [#53](https://github.com/pilcrowOnPaper/auri/pull/53) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Fix `pull` attributes not being read
-
-- [#55](https://github.com/pilcrowOnPaper/auri/pull/55) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Fix Github request error
-
-## 0.7.0-beta.0
-
-### Minor changes
-
-- [#49](https://github.com/pilcrowOnPaper/auri/pull/49) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : [Breaking] Remove `auri.publish`
-
-  - Replaced with `auri.build`
-
-  - All packages are published using `pnpm publish`
-
-## 0.6.0
-
-### Minor changes
-
-- [#46](https://github.com/pilcrowOnPaper/auri/pull/46) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Add release config
-
-  - Support beta releases
-
-- [#46](https://github.com/pilcrowOnPaper/auri/pull/46) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Add `pull` as an optional changeset property
-
-## 0.6.0-beta.2
-
-### Minor changes
-
-- [#44](https://github.com/pilcrowOnPaper/auri/pull/44) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Add `pull` as an optional changeset property
-
-## 0.6.0-beta.1
-
-### Patch changes
-
-- [#41](https://github.com/pilcrowOnPaper/auri/pull/41) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Fix `prepare` command erroring if release config was missing
-
-- [#43](https://github.com/pilcrowOnPaper/auri/pull/43) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Fix `prepare` script generating wrong version
-
-- [#41](https://github.com/pilcrowOnPaper/auri/pull/41) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Update readme
-
-## 0.6.0-beta.0
-
-### Minor changes
-
-- [#37](https://github.com/pilcrowOnPaper/auri/pull/37) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Add release config
-
-  - Support beta releases
-
-## 0.5.4
-
-### Patch changes
-
-- [#35](https://github.com/pilcrowOnPaper/auri/pull/35) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Properly format error message and exit
-
-## 0.5.3
-
-### Patch changes
-
-- [#33](https://github.com/pilcrowOnPaper/auri/pull/33) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Write stdout to console after running command
-
-## 0.5.2
-
-### Patch changes
-
-- [#31](https://github.com/pilcrowOnPaper/auri/pull/31) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Fix `list` command
-
-## 0.5.1
-
-### Patch changes
-
-- [#29](https://github.com/pilcrowOnPaper/auri/pull/29) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Fix deploy command
-
-## 0.5.0
-
-### Minor changes
-
-- [#27](https://github.com/pilcrowOnPaper/auri/pull/27) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : [Breaking] Replace `scripts.format` and `scripts.publish_setup` with `scripts["auri.format"]` and `scripts["auri.publish_setup"]` inside package.json
-
-- [#27](https://github.com/pilcrowOnPaper/auri/pull/27) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Add `auri.deploy`
-
-## 0.4.1
-
-### Patch changes
-
-- By [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Fix publish script not working for nested packages
-
-## 0.4.0
-
-### Minor changes
-
-- By [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Add `list` command and properly handle `!` ignore items
-
-## 0.3.3
-
-### Patch changes
-
-- By [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Add `ignore` config
-
-## 0.3.2
-
-### Patch changes
-
-- By [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Fix publish script running publish command twice
-
-## 0.3.1
-
-### Patch changes
-
-- By [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Fix publish command
-
-## 0.3.0
-
-### Minor changes
-
-- By [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Fix issue with file system API
-
-## 0.2.6
-
-### Patch changes
-
-- By [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Improve debug mode
-
-## 0.2.5
-
-### Patch changes
-
-- By [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : more debug
-
-## 0.2.4
-
-### Patch changes
-
-- By [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Add `scripts.publish_setup`
-
-## 0.2.3
-
-### Patch changes
-
-- By [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Add debug mode
-
-## 0.2.2
-
-### Patch changes
-
-- By [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Add instructions on repository settings
-
-## 0.2.1
-
-### Patch changes
-
-- [#14](https://github.com/pilcrowOnPaper/auri/pull/14) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Better error messages
-
-## 0.2.0
-
-### Minor changes
-
-- [#12](https://github.com/pilcrowOnPaper/auri/pull/12) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Don't publish if package doesn't exist on NPM
-
-### Patch changes
-
-- [#12](https://github.com/pilcrowOnPaper/auri/pull/12) by [@pilcrowOnPaper](https://github.com/pilcrowOnPaper) : Link to author in changelog
-
-## 0.1.0
-
-### Minor changes
-
-- By @pilcrowOnPaper : publish!
+- Fix git

dist/index.js

@@ -35,2 +35,2 @@ import { publish } from "./scripts/publish.js";
 }
-process.exit();
+throw new Error(`Unknown command: ${args[0]}`);

dist/scripts/prepare.js

@@ -25,2 +25,3 @@ import fs from "fs/promises";
     }
+    await initGit();
     const currentVersion = parseVersion(packageMeta.version);
@@ -53,2 +54,3 @@ if (currentVersion.next !== null) {
         commitChanges("main");
+        execute("git checkout main"); // reset branch
         let releaseRequestBody = "";
@@ -129,2 +131,3 @@ for (const changeset of changesets) {
     commitChanges("main");
+    execute("git checkout main"); // reset branch
     let releaseRequestBody = "";
@@ -172,2 +175,3 @@ if (minorChangesets.length > 0) {
     }
+    await initGit();
     const minorChangesets = [];
@@ -235,2 +239,3 @@ const patchChangesets = [];
     commitChanges(`v${majorVersion}`);
+    execute(`git checkout v${majorVersion}`); // reset branch
     let releaseRequestBody = "";
@@ -267,2 +272,3 @@ if (minorChangesets.length > 0) {
     }
+    await initGit();
     let nextVersion;
@@ -326,2 +332,3 @@ if (currentVersion.major === majorVersion && currentVersion.next !== null) {
     commitChanges(`v${majorVersion}`);
+    execute(`git checkout v${majorVersion}`); // reset branch
     let releaseRequestBody = "";
@@ -387,7 +394,9 @@ for (const changeset of changesets) {
 }
-async function commitChanges(branch) {
+async function initGit() {
     const user = await getGitUser();
-    execute("npx prettier -w CHANGELOG.md package.json");
     execute(`git config --global user.name "${user.name}"`);
     execute(`git config --global user.email "${user.email}"`);
+}
+function commitChanges(branch) {
+    execute("npx prettier -w CHANGELOG.md package.json");
     execute(`git checkout -b ${branch}.auri`);
@@ -397,3 +406,2 @@ execute("git add .");
     execute("git push -f -u origin HEAD");
-    execute(`git checkout ${branch}`);
 }

package.json

 {
 	"name": "auri",
-	"version": "0.9.4",
+	"version": "1.0.0-next.3",
 	"description": "Organize package changes and releases",
@@ -5,0 +5,0 @@ "main": "/dist/index.js",

README.md

 # Auri
 
-Organize package changes and releases.
+Organize package changes and releases in monolith repositories.
 
@@ -18,1 +18,89 @@ ```
 ```
+
+## Prerequisites
+
+Auri is intentionally opinionated and intended for certain repositories:
+
+- Single monolith repository
+- Uses prettier
+- Package be built and published with: `npm run build && npm publish`
+- The package's `package.json` is in the repository root
+- No monorepos
+- No pre-releases for patch/minor versions
+
+## Setup
+
+Install Auri via NPM and update your repository.
+
+### 1. Generate access tokens
+
+You'll will need an NPM automation access token (classic) and a GitHub token with the following permissions:
+
+- `repo`
+- `user:email`
+
+### 2. Create GitHub workflow
+
+Create a GitHub workflow that runs on every push. The NPM token should be named `NODE_AUTH_TOKEN` and the GitHub token as `AURI_GITHUB_TOKEN`.
+
+```yaml
+# .github/workflows/publish.yaml
+name: "Publish package"
+on: [push]
+
+env:
+  AURI_GITHUB_TOKEN: ${{secrets.AURI_GITHUB_TOKEN}}
+  NODE_AUTH_TOKEN: ${{secrets.NODE_AUTH_TOKEN}}
+
+jobs:
+  publish-package:
+    name: Publish package with Auri
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup actions
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.ref }}
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          registry-url: "https://registry.npmjs.org/"
+          cache: "npm"
+      - name: Prepare release
+        run: npm run auri prepare ${{ github.ref_name }}
+      - name: Publish package
+        run: npm run auri publish ${{ github.ref_name }}
+```
+
+## Instructions
+
+### Basics
+
+When you create a new pull request, run `pnpm auri add` to create a new changeset. Use `add patch` for patch changes and `add minor` for minor changes.
+
+```
+npx auri patch
+```
+
+This will create a new markdown file inside the `.changesets` directory. Write a concise summary of your changes. A single PR may include multiple (or zero) changesets. Each changeset might look something like this:
+
+```
+Fix: Stop deleting operating system at midnight
+```
+
+When you merge this to `main` or `master` branch, Auri will detect your changes and create a new "Release request" as a pull request. When you merge this request, your `package.json` and `CHANGELOG.md` will be updated, and new version of your package will be published to NPM.
+
+### Versioned branches
+
+Auri works by creating dedicated branches for each major version. For example, `main` will be for v3, `v2` for v2, and `v4` for experimental v4. This means you can maintain multiple major versions at once. Versioned branches be in the format of `v<integer>`.
+
+### Next versions
+
+Whenever you create a versioned branch for a major version once above the version in `main`, it will publish packages with a "next" tag. These versions are your betas/alphas/prereleases and looks like `3.0.0-beta.16`. When working with "next", all your changesets must use `next`:
+
+```
+npx auri next
+```
+
+Once you merge the branch into `main`, Auri will automatically release a stable version. If you want to keep working on the previous version, make sure you create a versioned branch for it before merging.

No alert changes

Improved metrics

Lines of code

831

increased by0.97%

Number of lines in readme file

106

increased by488.89%

Worsened metrics

Total package byte prevSize

37072

decreased by-7.71%

No dependency changes