Skip to content

Commit

Permalink
fix: correct casing for GitHub (#258)
Browse files Browse the repository at this point in the history
  • Loading branch information
rexxars authored Oct 3, 2024
1 parent d77009e commit b7a871a
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ With pkg.pr.new, each of your commits and pull requests will trigger an instant

- 🚀 Instant Builds
- 🍕 No Need for NPM Access
- 🛠️ Github Workflows Friendly
- 🛠️ GitHub Workflows Friendly
- 📦️ No Configuration
- 🔩 Single Command
- ✉️ Pull Request Comments
Expand Down Expand Up @@ -84,7 +84,7 @@ Feel free to add your project or company here to join the pkg.pr.new family :)

## Setup

First [install the Github Application](https://github.com/apps/pkg-pr-new).
First [install the GitHub Application](https://github.com/apps/pkg-pr-new).

> [!IMPORTANT]
> Make sure it's installed on the repository before trying to publish a package.
Expand All @@ -102,7 +102,7 @@ npx pkg-pr-new publish './packages/A' './packages/B' # or `npx pkg-pr-new publis
```

> [!IMPORTANT]
> Make sure the pkg-pr-new command runs only once in a defined workflow (that's part of how it avoids spam)! So instead of multiple times running pkg-pr-new for each workspace package, the command should be run one time for all the desired packages using the pattern above.
> Make sure the pkg-pr-new command runs only once in a defined workflow (that's part of how it avoids spam)! So instead of multiple times running pkg-pr-new for each workspace package, the command should be run one time for all the desired packages using the pattern above.
For templates (experimental):

Expand All @@ -121,7 +121,7 @@ For shorter urls, `--compact` can be useful:
npx pkg-pr-new publish --compact './packages/A' './packages/B'
```

> `--compact` requires your package to be a valid (published) package on npm with a specified `repository` field in the package.json! See [this](https://docs.npmjs.com/cli/v7/configuring-npm/package-json#repository). pkg.pr.new is case sensitive, if the Github owner is `PuruVJ`, the package.json `repository` field should not have `puruvj`.
> `--compact` requires your package to be a valid (published) package on npm with a specified `repository` field in the package.json! See [this](https://docs.npmjs.com/cli/v7/configuring-npm/package-json#repository). pkg.pr.new is case sensitive, if the GitHub owner is `PuruVJ`, the package.json `repository` field should not have `puruvj`.
With `--compact`:

Expand Down
2 changes: 1 addition & 1 deletion packages/backend/server/routes/multipart/create.post.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export default eventHandler(async (event) => {
throw createError({
statusCode: 401,
message:
"Try doing multipart uploads from a github workflow! Also make sure you install https://github.com/apps/pkg-pr-new Github app on the repo",
"Try doing multipart uploads from a github workflow! Also make sure you install https://github.com/apps/pkg-pr-new GitHub app on the repo",
});
}
const workflowData = (await workflowsBucket.getItem(workflowKey))!;
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/server/routes/publish.post.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ export default eventHandler(async (event) => {
throw createError({
statusCode: 401,
message:
"Try publishing from a github workflow! Also make sure you install https://github.com/apps/pkg-pr-new Github app on the repo",
"Try publishing from a github workflow! Also make sure you install https://github.com/apps/pkg-pr-new GitHub app on the repo",
});
}

Expand Down
2 changes: 1 addition & 1 deletion packages/cli/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ const main = defineCommand({

if (!process.env.TEST && process.env.GITHUB_ACTIONS !== "true") {
console.error(
"Continuous Releases are only available in Github Actions.",
"Continuous Releases are only available in GitHub Actions.",
);
process.exit(1);
}
Expand Down

0 comments on commit b7a871a

Please sign in to comment.