Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,22 +66,34 @@ the first `github-gh` version; Forgejo visual-evidence upload uses the
Install the Patchmill CLI globally, then start with the onboarding flow:

```sh
npm install -g @rochecompaan/patchmill
npm install -g patchmill

patchmill init
patchmill doctor
patchmill triage --dry-run
```

If you prefer not to install Patchmill globally, use the scoped package name
with `npx`:
If you prefer not to install Patchmill globally, use `npx`:

```sh
npx @rochecompaan/patchmill init
npx @rochecompaan/patchmill doctor
npx @rochecompaan/patchmill triage --dry-run
npx patchmill init
npx patchmill doctor
npx patchmill triage --dry-run
```

### Migrating from `@rochecompaan/patchmill`

The scoped npm package `@rochecompaan/patchmill` is deprecated. Install the
unscoped package instead:

```sh
npm uninstall -g @rochecompaan/patchmill
npm install -g patchmill
```

For one-off usage, replace `npx @rochecompaan/patchmill ...` with
`npx patchmill ...`.

### Try Patchmill on a disposable demo repository

Before pointing Patchmill at a production repository, create a disposable Team
Expand Down
2 changes: 1 addition & 1 deletion bin/release-config.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ test("release-please config manages the root node package and Nix version", () =

assert.deepEqual(config.packages?.["."], {
"release-type": "node",
"package-name": "@rochecompaan/patchmill",
"package-name": "patchmill",
"include-component-in-tag": false,
"extra-files": [{ type: "generic", path: "nix/package.nix" }],
});
Expand Down
Loading
Loading