Skip to content

Commit 0ee4d42

Browse files
fix casing for product names (vercel#9229)
1 parent 7191ff3 commit 0ee4d42

File tree

13 files changed

+20
-20
lines changed

13 files changed

+20
-20
lines changed

.github/.kodiak.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ notify_on_conflict = false
1717
# Without this, only branches that are passing CI will get updated.
1818
# The benefit of this config is that PRs that we want to automerge, but
1919
# have failed because the test suite is flaky will get stuck, unless someone
20-
# presses the Update Branch button manually, or re-triggers the Github workflow
20+
# presses the Update Branch button manually, or re-triggers the GitHub workflow
2121
# for tests again. This causes delays in getting easy PRs in.
2222
always = true
2323

@@ -28,7 +28,7 @@ always = true
2828
# (i.e. PRs with the "pr: automerge" label, which is configured above).
2929
# This label allows PR authors to keep their PR branch up-to-date without
3030
# opting into Kodiak's automerge feature. This is useful if you want to use
31-
# Github's AutoMerge feature instead.
31+
# GitHub's AutoMerge feature instead.
3232
autoupdate_label = "pr: autoupdate"
3333

3434
[merge.message]

buildcontainer/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This project is rather cookbook combing various projects into one. Special to [o
2020

2121
## Docker
2222

23-
Docker images are available on both [Github](https://ghcr.io/goreleaser/goreleaser-cross) and [Docker hub](https://hub.docker.com/r/goreleaser/goreleaser-cross).
23+
Docker images are available on both [GitHub](https://ghcr.io/goreleaser/goreleaser-cross) and [Docker hub](https://hub.docker.com/r/goreleaser/goreleaser-cross).
2424

2525
Images from version v1.17.4 are multi-arch. Supported host are listed in the table below
2626

docs/repo-docs/core-concepts/internal-packages.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ There are a few important things to notice in this `package.json`:
9595
#### Limitations and tradeoffs
9696

9797
- **Only applicable when consumers do transpiling**: This strategy can only be used when the package is going to be used in tooling that uses a bundler or natively understands TypeScript. The consumer's bundler is responsible for transpiling the TypeScript packages to JavaScript. If your builds or other usages of the package are not able to consume TypeScript, you will need to move to the [Compiled Packages](#compiled-packages) strategy.
98-
- **No TypeScript `paths`**: A library that is being transpiled by its consumer cannot use the `compilerOptions.paths` configuration because TypeScript assumes that source code is being transpiled in the package where it is written. If you're using Typescript 5.4 or later, we recommend [using Node.js subpath imports](https://devblogs.microsoft.com/typescript/announcing-typescript-5-4/#auto-import-support-for-subpath-imports). To learn how, visit [our TypeScript page](/repo/docs/guides/tools/typescript#use-nodejs-subpath-imports-instead-of-typescript-compiler-paths).
98+
- **No TypeScript `paths`**: A library that is being transpiled by its consumer cannot use the `compilerOptions.paths` configuration because TypeScript assumes that source code is being transpiled in the package where it is written. If you're using TypeScript 5.4 or later, we recommend [using Node.js subpath imports](https://devblogs.microsoft.com/typescript/announcing-typescript-5-4/#auto-import-support-for-subpath-imports). To learn how, visit [our TypeScript page](/repo/docs/guides/tools/typescript#use-nodejs-subpath-imports-instead-of-typescript-compiler-paths).
9999
- **Turborepo cannot cache a build for a Just-in-Time Package**: Because the package doesn't have its own `build` step, it can't be cached by Turborepo. This tradeoff may make sense for you if you want to keep configuration to a minimum and are okay with the build times for your applications.
100100

101101
### Compiled Packages

docs/repo-docs/crafting-your-repository/structuring-a-repository.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ Using exports this way provides three major benefits:
318318
[The `imports` field](https://nodejs.org/api/packages.html#imports) gives you a way to create subpaths to other modules within your package. You can think of these like "shortcuts" to write simpler import paths that are more resilient to refactors that move files. To learn how, visit [the TypeScript page](/repo/docs/guides/tools/typescript#use-nodejs-subpath-imports-instead-of-typescript-compiler-paths).
319319

320320
<Callout type="info">
321-
You may be more familiar with TypeScript's `compilerOptions#paths` option, which accomplishes a similar goal. As of Typescript 5.4, TypeScript can infer subpaths from `imports`, making it a better option since you'll be working with Node.js conventions. For more information, visit [our Typescript guide](/repo/docs/guides/tools/typescript#use-nodejs-subpath-imports-instead-of-typescript-compiler-paths).
321+
You may be more familiar with TypeScript's `compilerOptions#paths` option, which accomplishes a similar goal. As of TypeScript 5.4, TypeScript can infer subpaths from `imports`, making it a better option since you'll be working with Node.js conventions. For more information, visit [our TypeScript guide](/repo/docs/guides/tools/typescript#use-nodejs-subpath-imports-instead-of-typescript-compiler-paths).
322322

323323
</Callout>
324324

docs/repo-docs/guides/generating-code.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ generators within a repo configured with Turborepo.
6363
1. Generators are automatically discovered, loaded, and organized per workspace (no need to manually `load` them within a single configuration file)
6464
2. Generators are automatically run from the root of the workspace where they are defined
6565
3. Generators can be invoked from anywhere within your repo (or outside out it via the [`--root`](/repo/docs/reference/generate#--root-path) flag)
66-
4. Typescript generators are supported with zero configuration
66+
4. TypeScript generators are supported with zero configuration
6767
5. `plop` is not required to be installed as a dependency of your repo
6868

6969
<Callout type="info" title="Known issue">
@@ -82,7 +82,7 @@ You'll be prompted to select an existing generator or to create one if you don't
8282
manually at `turbo/generators/config.ts` (or `config.js`) at the root of your repo - or within _any_ workspace.
8383

8484
<Callout type="info">
85-
If you are using Typescript, you will need to install [the `@turbo/gen`
85+
If you are using TypeScript, you will need to install [the `@turbo/gen`
8686
package](https://github.com/vercel/turborepo/tree/main/packages/turbo-gen) as
8787
a `devDependency` to access the required TS types.
8888
</Callout>

docs/repo-docs/guides/tools/typescript.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ We don't recommend using TypeScript Project References as they introduce both an
321321

322322
### Your editor won't use a package's TypeScript version
323323

324-
`tsserver` is not able to use different Typescript versions for different packages in your code editor. Instead, it will discover a specific version and use that everywhere.
324+
`tsserver` is not able to use different TypeScript versions for different packages in your code editor. Instead, it will discover a specific version and use that everywhere.
325325

326326
This can result in differences between the linting errors that show in your editor and when you run `tsc` scripts to check types. If this is an issue for you, consider [keeping the TypeScript dependency on the same version](/repo/docs/crafting-your-repository/managing-dependencies#keeping-dependencies-on-the-same-version).
327327

docs/src/github.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ export async function updateComment(
5757
export async function createComment(comment: string): Promise<string> {
5858
if (isFork) {
5959
setFailed(
60-
"The action could not create a Github comment because it is initiated from a forked repo. View the action logs for a list of broken links."
60+
"The action could not create a GitHub comment because it is initiated from a forked repo. View the action logs for a list of broken links."
6161
);
6262

6363
return "";
@@ -111,7 +111,7 @@ export async function updateCheckStatus(
111111
if (isFork) {
112112
if (errorsExist) {
113113
setFailed(
114-
"This PR introduces broken links to the docs. The action could not create a Github check because it is initiated from a forked repo."
114+
"This PR introduces broken links to the docs. The action could not create a GitHub check because it is initiated from a forked repo."
115115
);
116116
} else {
117117
console.log("Link validation was successful.");

docs/src/validate-docs-links.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import markdown from "remark-parse";
55
import remarkToRehype from "remark-rehype";
66
import raw from "rehype-raw";
77
import visit from "unist-util-visit";
8-
import GithubSlugger from "github-slugger";
8+
import GitHubSlugger from "github-slugger";
99
import matter from "gray-matter";
1010
import {
1111
COMMENT_TAG,
@@ -57,7 +57,7 @@ type ErrorType = Exclude<keyof Errors, "doc">;
5757
const DOCS_PATH = ".";
5858
const EXCLUDED_HASHES = ["top"];
5959

60-
const slugger = new GithubSlugger();
60+
const slugger = new GitHubSlugger();
6161

6262
// Collect the paths of all .mdx files in the passed directories
6363
async function getAllMdxFilePaths(
@@ -323,7 +323,7 @@ async function validateAllInternalLinks(): Promise<void> {
323323
try {
324324
await updateCheckStatus(errorsExist, commentUrl);
325325
} catch (error) {
326-
setFailed("Failed to create Github check: " + error);
326+
setFailed("Failed to create GitHub check: " + error);
327327
}
328328
} catch (error) {
329329
setFailed("Error validating internal links: " + error);

packages/create-turbo/__tests__/index.test.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ describe("create-turbo", () => {
248248
expect(mockConsole.error).toHaveBeenNthCalledWith(
249249
1,
250250
logger.turboRed(bold(">>>")),
251-
red("Unable to download template from Github")
251+
red("Unable to download template from GitHub")
252252
);
253253
expect(mockConsole.error).toHaveBeenNthCalledWith(
254254
2,

packages/create-turbo/src/commands/create/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ function handleErrors(
4949
process.exit(1);
5050
// handle download errors from @turbo/utils
5151
} else if (err instanceof DownloadError) {
52-
error(red("Unable to download template from Github"));
52+
error(red("Unable to download template from GitHub"));
5353
error(red(err.message));
5454
process.exit(1);
5555
}

packages/top-issues/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# `@turbo/top-issues`
22

3-
This is an internal package that is used by a Github Actions Workflow to post
3+
This is an internal package that is used by a GitHub Actions Workflow to post
44
top issues in `vercel/turbo` to Slack.
55

6-
The code here gets the top issues and writes them to a file. The Github Action
6+
The code here gets the top issues and writes them to a file. The GitHub Action
77
workflow will then take that file and post it to Slack with a marketplace
88
action.

release.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ You need to run `git push --follow-tags` to finish the release.
5757

5858
### Notes
5959

60-
- Github Release Notes are published automatically using the config from [`turborepo-release.yml`][2],
60+
- GitHub Release Notes are published automatically using the config from [`turborepo-release.yml`][2],
6161
triggered by the [`turbo-orchestrator`][3] bot.
6262

6363
## Release `@turbo/repository`

turborepo-tests/integration/tests/run-logging/log-order-github.t

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Setup
22
$ . ${TESTDIR}/../../../helpers/setup_integration_test.sh ordered
33

4-
# Build as if we are in Github Actions
4+
# Build as if we are in GitHub Actions
55
Note that we need to use (re) for lines that start with '> '
66
because otherwise prysk interprets them as multiline commands
77
$ GITHUB_ACTIONS=1 ${TURBO} run build --force
@@ -31,7 +31,7 @@ because otherwise prysk interprets them as multiline commands
3131
Cached: 0 cached, 2 total
3232
Time:\s*[\.0-9]+m?s (re)
3333

34-
# Build as if we are in Github Actions with a task log prefix.
34+
# Build as if we are in GitHub Actions with a task log prefix.
3535
$ GITHUB_ACTIONS=1 ${TURBO} run build --force --log-prefix="task" --filter=util
3636
\xe2\x80\xa2 Packages in scope: util (esc)
3737
\xe2\x80\xa2 Running build in 1 packages (esc)

0 commit comments

Comments
 (0)