miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 6 Packages Projects Releases Wiki Activity

chore(core): use right GitHub syntax (#14624)

Browse Source
This commit is contained in:
Benjamin Cabanes 2023-01-25 13:56:06 -05:00 committed by GitHub
parent 41fc2ebbed
commit 8d517752d3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
23 changed files with 38 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/ISSUE_TEMPLATE/1-bug.yml vendored
View File

@ -26,7 +26,7 @@ body:
- type: input
id: repo
attributes:
label: Github Repo
label: GitHub Repo
description: |
This is extremely important! If this issue is reproduce-able on https://github.com/nrwl/nx-examples, you may use that as the repo.
If not, please do take a few minutes of your time to create a repo to help us reproduce the issue.

2
docs/generated/packages/workspace/generators/ci-workflow.json
View File

@ -17,7 +17,7 @@
"message": "What is your target CI provider?",
"type": "list",
"items": [
{ "value": "github", "label": "Github Actions" },
{ "value": "github", "label": "GitHub Actions" },
{ "value": "circleci", "label": "Circle CI" },
{ "value": "azure", "label": "Azure DevOps" },
{ "value": "bitbucket-pipelines", "label": "BitBucket Pipelines" },

12
docs/nx-cloud/set-up/github.md
View File

@ -1,8 +1,8 @@
# Enable Github PR Integration
# Enable GitHub PR Integration
## Get Started
The [Nx Cloud Github App](https://github.com/marketplace/official-nx-cloud-app) lets you access the result of every run—with all its logs and build insights—straight from your PR.
The [Nx Cloud GitHub App](https://github.com/marketplace/official-nx-cloud-app) lets you access the result of every run—with all its logs and build insights—straight from your PR.
## Connecting Your Workspace
@ -12,23 +12,23 @@ Once you have installed the Nx Cloud GitHub App, you must link your workspace to
Once on the VCS Integrations setup page, select "GitHub" in the platforms dropdown. You will be prompted to enter the name of your repository.
![Add Github Repository](/nx-cloud/set-up/add-github-repository.png)
![Add GitHub Repository](/nx-cloud/set-up/add-github-repository.png)
### Choosing an Authentication Method
It is easier to configure the Nx Cloud GitHub Integration to use its GitHub App to authenticate, and this method should be preferred for users on Nx Public Cloud. Advanced users, or Nx Enterprise clients may instead wish to generate a personal access token instead.
#### Using the Github App
#### Using the GitHub App
To use the Nx Cloud GitHub App for authentication, select the radio button and then click "Test Connection". This will verify that Nx Cloud can connect to your repo. Upon a successful test, your configuration is saved. Check the CI Platform Considerations section below and if there are no additional instructions for your platform of choice, setup is complete.
![Use Github App for Authentication](/nx-cloud/set-up/use-github-app-auth.png)
![Use GitHub App for Authentication](/nx-cloud/set-up/use-github-app-auth.png)
#### Using a Personal Access Token
To use a Personal Access Token for authentication, one must be generated with proper permissions. The minimum required permissions are shown in the screenshot below.
![Minimum Github Personal Access Token Permissions](/nx-cloud/set-up/minimal-github-access-token.png)
![Minimum GitHub Personal Access Token Permissions](/nx-cloud/set-up/minimal-github-access-token.png)
Once this token is created, select the radio button for providing a personal access token, paste the value, and then click "Test Connection". This will verify that Nx Cloud can connect to your repo. Upon a successful test, your configuration is saved. Check the CI Platform Considerations section below and if there are no additional instructions for your platform of choice, setup is complete.

2
docs/nx-cloud/set-up/record-commands.md
View File

@ -18,6 +18,6 @@ Commands that Nx Cloud stores will appear under your "Runs" view. For easy ident
![nx-cloud record -- yarn nx workspace-lint](/nx-cloud/set-up/record-workspace-lint.png)
If you use the Nx Cloud Github Integration, links to recorded output will also be displayed based on exit code in the summary comment.
If you use the Nx Cloud GitHub Integration, links to recorded output will also be displayed based on exit code in the summary comment.
![Nx Cloud Report](/nx-cloud/set-up/record-report.png)

2
docs/shared/monorepo-nx-enterprise.md
View File

@ -150,7 +150,7 @@ Since Nx allows us to group apps and libs in directories, those directories can
/libs/shared/utils-testing julie,hank
```
If you want to know more about code ownership on Github, please check [the documentation on the `CODEOWNERS` file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).
If you want to know more about code ownership on GitHub, please check [the documentation on the `CODEOWNERS` file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).
## Enforcing Best Practices

2
docs/shared/recipes/plugins/share-your-plugin.md
View File

@ -22,7 +22,7 @@ Nx provides a utility (`nx list`) that lists both core and community plugins. To
- Use the following commit message template: `chore(core): nx plugin submission [PLUGIN_NAME]`
- push your changes, and run `yarn submit-plugin`
> The `yarn submit-plugin` command automatically opens the Github pull request process with the correct template.
> The `yarn submit-plugin` command automatically opens the GitHub pull request process with the correct template.
We will then verify the plugin, offer suggestions or merge the pull request!

4
nx-dev/feature-doc-viewer/src/lib/doc-viewer.tsx
View File

@ -97,7 +97,7 @@ export function DocViewer({
href="https://github.com/nrwl/nx/issues/new?assignees=&labels=type%3A+docs&template=3-documentation.md"
target="_blank"
rel="noreferrer"
title="Report an issue on Github"
title="Report an issue on GitHub"
className="relative inline-flex items-center rounded-l-md border border-slate-200 bg-white px-4 py-2 text-xs font-medium text-slate-600 focus-within:ring-blue-500 hover:bg-slate-50 focus:z-10 focus:outline-none focus:ring-1 dark:border-slate-700 dark:bg-slate-800/60 dark:text-slate-400 dark:focus-within:ring-sky-500 dark:hover:bg-slate-800"
>
Report an issue
@ -113,7 +113,7 @@ export function DocViewer({
].join('/')}
target="_blank"
rel="noreferrer"
title="Edit this page on Github"
title="Edit this page on GitHub"
className="relative -ml-px inline-flex items-center rounded-r-md border border-slate-200 bg-white px-4 py-2 text-xs font-medium text-slate-600 focus-within:ring-blue-500 hover:bg-slate-50 focus:z-10 focus:outline-none focus:ring-1 dark:border-slate-700 dark:bg-slate-800/60 dark:text-slate-400 dark:focus-within:ring-sky-500 dark:hover:bg-slate-800"
>
Edit this page

2
nx-dev/feature-package-schema-viewer/src/lib/content.tsx
View File

@ -135,7 +135,7 @@ export function Content({
href={schemaViewModel.schemaGithubUrl}
target="_blank"
rel="noreferrer"
title="See this schema on Github"
title="See this schema on GitHub"
className="relative -ml-px inline-flex items-center rounded-r-md border border-slate-200 bg-white px-4 py-2 text-xs font-medium text-slate-600 focus-within:ring-blue-500 hover:bg-slate-50 focus:z-10 focus:outline-none focus:ring-1 dark:border-slate-700 dark:bg-slate-800/60 dark:text-slate-400 dark:focus-within:ring-sky-500 dark:hover:bg-slate-800"
>
<svg

2
nx-dev/feature-package-schema-viewer/src/lib/ui/package-reference.tsx
View File

@ -146,7 +146,7 @@ function EmptyList({
target="_blank"
rel="noreferrer"
>
Please be sure to check the Nx roadmap on Github, we are probably
Please be sure to check the Nx roadmap on GitHub, we are probably
working on what you are looking for.
</a>
</div>

2
nx-dev/feature-package-schema-viewer/src/lib/ui/top.layout.tsx
View File

@ -22,7 +22,7 @@ export function TopSchemaLayout({
target="_blank"
rel="noreferrer"
aria-hidden="true"
title="See package on Github"
title="See package on GitHub"
className="relative inline-flex items-center rounded-md border border-slate-200 bg-slate-50 px-4 py-2 text-xs font-medium dark:border-slate-700 dark:bg-slate-800/60"
>
<svg className="mr-2 h-4 w-4" viewBox="0 0 16 16" fill="currentColor">

2
nx-dev/nx-dev-e2e/src/e2e/nx-cloud-documentation.cy.ts
View File

@ -12,7 +12,7 @@ describe('nx-dev: Nx Cloud section', () => {
path: '/nx-cloud/set-up/record-commands',
},
{
title: 'Enable Github PR Integration',
title: 'Enable GitHub PR Integration',
path: '/nx-cloud/set-up/github',
},
{

2
nx-dev/nx-dev/pages/404.tsx
View File

@ -67,7 +67,7 @@ export function FourOhFour(): JSX.Element {
target="_blank"
rel="noreferrer"
className="font-semibold underline"
title="Create a Github issue"
title="Create a GitHub issue"
>
drop us a line
</Link>{' '}

2
nx-dev/nx-dev/pages/500.tsx
View File

@ -44,7 +44,7 @@ export default function FiveOhOh(): JSX.Element {
target="_blank"
rel="noreferrer"
className="font-semibold underline"
title="Create a Github issue"
title="Create a GitHub issue"
>
drop us a line
</Link>{' '}

4
nx-dev/nx-dev/pages/community.tsx
View File

@ -66,12 +66,12 @@ export default function Community(props: CommunityProps): JSX.Element {
<>
<NextSeo
title="Nx Community and Plugin Listing"
description="There are many ways you can connect with the open-source Nx community. The community is rich and dynamic offering Nx plugins and help on multiple platforms like Github, Slack and Twitter"
description="There are many ways you can connect with the open-source Nx community. The community is rich and dynamic offering Nx plugins and help on multiple platforms like GitHub, Slack and Twitter"
openGraph={{
url: 'https://nx.dev' + router.asPath,
title: 'Nx Community and Plugin Listing',
description:
'There are many ways you can connect with the open-source Nx community. The community is rich and dynamic offering Nx plugins and help on multiple platforms like Github, Slack and Twitter',
'There are many ways you can connect with the open-source Nx community. The community is rich and dynamic offering Nx plugins and help on multiple platforms like GitHub, Slack and Twitter',
images: [
{
url: 'https://nx.dev/images/nx-media.jpg',

6
nx-dev/ui-common/src/lib/documentation-header.tsx
View File

@ -121,8 +121,8 @@ export function DocumentationHeader({
),
},
{
name: 'Github',
label: 'Nx is open source, check the code on Github',
name: 'GitHub',
label: 'Nx is open source, check the code on GitHub',
href: 'https://github.com/nrwl/nx?utm_source=nx.dev',
icon: (props: any) => (
<svg
@ -132,7 +132,7 @@ export function DocumentationHeader({
viewBox="0 0 16 16"
{...props}
>
{/*<title>Github</title>*/}
{/*<title>GitHub</title>*/}
<path d="M8 0a8 8 0 0 0-2.53 15.59c.4.07.55-.17.55-.38l-.01-1.49c-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82a7.42 7.42 0 0 1 4 0c1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48l-.01 2.2c0 .21.15.46.55.38A8.01 8.01 0 0 0 16 8a8 8 0 0 0-8-8z" />
</svg>
),

4
nx-dev/ui-common/src/lib/footer.tsx
View File

@ -26,7 +26,7 @@ export function Footer(): JSX.Element {
],
community: [
{ name: 'Twitter', href: 'https://twitter.com/NXdevtools' },
{ name: 'Github', href: 'https://github.com/nrwl/nx/' },
{ name: 'GitHub', href: 'https://github.com/nrwl/nx/' },
{
name: 'Newsletter',
href: 'https://go.nrwl.io/nx-newsletter?utm_source=nx.dev',
@ -75,7 +75,7 @@ export function Footer(): JSX.Element {
},
{
name: 'GitHub',
label: 'Nx is open source, check the code on Github',
label: 'Nx is open source, check the code on GitHub',
href: 'https://github.com/nrwl/nx?utm_source=nx.dev',
icon: (props: any) => (
<svg fill="currentColor" viewBox="0 0 16 16" {...props}>

8
nx-dev/ui-common/src/lib/header.tsx
View File

@ -209,13 +209,13 @@ export function Header(): JSX.Element {
<AlgoliaSearch tiny={true} />
<ThemeSwitcher />
<a
title="Nx is open source, check the code on Github"
title="Nx is open source, check the code on GitHub"
href="https://github.com/nrwl/nx"
target="_blank"
rel="noreferrer"
className="px-3 py-2 opacity-60 hover:opacity-90"
>
<span className="sr-only">Nx on Github</span>
<span className="sr-only">Nx on GitHub</span>
<div className="item-center flex">
<svg
className="h-5 w-5"
@ -306,13 +306,13 @@ export function Header(): JSX.Element {
<div className="items-justified flex flex-shrink-0 justify-center space-x-1 text-sm">
<ThemeSwitcher />
<a
title="Nx is open source, check the code on Github"
title="Nx is open source, check the code on GitHub"
href="https://github.com/nrwl/nx"
target="_blank"
rel="noreferrer"
className="px-3 py-2 opacity-60 hover:opacity-90"
>
<span className="sr-only">Nx on Github</span>
<span className="sr-only">Nx on GitHub</span>
<div className="item-center flex">
<svg className="h-5 w-5" viewBox="0 0 16 16" fill="currentColor">
<path

2
nx-dev/ui-home/src/lib/extensible-and-integrated/github-intergration-tab.tsx
View File

@ -160,7 +160,7 @@ export function GitHubIntegrationTab(): JSX.Element {
<div className="absolute left-12 -bottom-2 mx-auto flex w-full w-auto max-w-none overflow-hidden rounded-xl border border-slate-200 shadow-xl">
<Image
src="/images/github-nxcloud.webp"
alt="Nx Cloud Github app"
alt="Nx Cloud GitHub app"
loading="lazy"
width={715}
height={510}

6
nx-dev/ui-home/src/lib/newsletter.tsx
View File

@ -53,8 +53,8 @@ export function Newsletter(): JSX.Element {
),
},
{
name: 'Github',
label: 'Nx is open source, check the code on Github',
name: 'GitHub',
label: 'Nx is open source, check the code on GitHub',
href: 'https://github.com/nrwl/nx?utm_source=nx.dev',
icon: (props: any) => (
<svg
@ -63,7 +63,7 @@ export function Newsletter(): JSX.Element {
xmlns="http://www.w3.org/2000/svg"
{...props}
>
{/*<title>Github</title>*/}
{/*<title>GitHub</title>*/}
<path d="M8 0a8 8 0 0 0-2.53 15.59c.4.07.55-.17.55-.38l-.01-1.49c-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82a7.42 7.42 0 0 1 4 0c1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48l-.01 2.2c0 .21.15.46.55.38A8.01 8.01 0 0 0 16 8a8 8 0 0 0-8-8z" />
</svg>
),

2
nx-dev/ui-markdoc/src/lib/tags/github-repository.schema.ts
View File

@ -7,7 +7,7 @@ export const githubRepository: Schema = {
url: {
type: 'String',
required: true,
description: 'The url of the Github repository',
description: 'The url of the GitHub repository',
},
},
};

2
packages/nx/src/project-graph/affected/locators/npm-packages.spec.ts
View File

@ -339,7 +339,7 @@ describe('getTouchedNpmPackages', () => {
);
}).not.toThrowError();
expect(logger.warn).toHaveBeenCalledWith(
'The affected projects might have not been identified properly. The package(s) changed-test-pkg-name-1, changed-test-pkg-name-2 were not found. Please open an issue in Github including the package.json file.'
'The affected projects might have not been identified properly. The package(s) changed-test-pkg-name-1, changed-test-pkg-name-2 were not found. Please open an issue in GitHub including the package.json file.'
);
});
});

2
packages/nx/src/project-graph/affected/locators/npm-packages.ts
View File

@ -68,7 +68,7 @@ export const getTouchedNpmPackages: TouchedProjectLocator<
logger.warn(
`The affected projects might have not been identified properly. The package(s) ${missingTouchedNpmPackages.join(
', '
)} were not found. Please open an issue in Github including the package.json file.`
)} were not found. Please open an issue in GitHub including the package.json file.`
);
}
return touched;

2
packages/workspace/src/generators/ci-workflow/schema.json
View File

@ -14,7 +14,7 @@
"message": "What is your target CI provider?",
"type": "list",
"items": [
{ "value": "github", "label": "Github Actions" },
{ "value": "github", "label": "GitHub Actions" },
{ "value": "circleci", "label": "Circle CI" },
{ "value": "azure", "label": "Azure DevOps" },
{ "value": "bitbucket-pipelines", "label": "BitBucket Pipelines" },