Skip to content

chore(docs): include --commentWithSha option in example workflows #503

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Aslemammad merged 2 commits into from
May 1, 2026
Merged

chore(docs): include --commentWithSha option in example workflows #503

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6126e7d
trigger second ci
AmirSa12 Apr 30, 2026
b51bea1
chore: update readme
AmirSa12 May 1, 2026
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
20 changes: 16 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,16 +206,28 @@ With `--comment=create`, each commit would generate a comment for itself, useful

And `--comment=off` would turn off comments for maintainers who prefer minimal pull requests.

> `--commentWithSha` specify whether to replace the pr number with sha commit in the generated comments.
> `--commentWithSha` specifies whether to replace the PR number with the commit SHA in the generated comments.

With `--commentWithSha`:

```sh
pnpm exec pkg-pr-new publish --commentWithSha
```

Generated comments use commit SHA URLs:

```sh
npm i https://pkg.pr.new/tinybench@a832a55
```

Without `--commentWithSha`:

```sh
pnpm exec pkg-pr-new publish
```

Generated comments use PR number URLs:

```sh
npm i https://pkg.pr.new/tinybench@123
```
Expand Down Expand Up @@ -274,7 +286,7 @@ jobs:
- name: Build
run: pnpm build

- run: pnpm exec pkg-pr-new publish
- run: pnpm exec pkg-pr-new publish --commentWithSha
```

#### Release approved pull requests only:
Expand Down Expand Up @@ -321,7 +333,7 @@ jobs:
- name: Install dependencies
run: pnpm install

- run: pnpm exec pkg-pr-new publish
- run: pnpm exec pkg-pr-new publish --commentWithSha
```

> Releasing approved pull requests is the recommended way of having continuous releases. This ensures users always install approved and safe packages.
Expand Down Expand Up @@ -382,7 +394,7 @@ jobs:
run: pnpm build

- id: publish
run: pnpm exec pkg-pr-new publish
run: pnpm exec pkg-pr-new publish --commentWithSha

e2e-test:
runs-on: ubuntu-latest
Expand Down
Loading