Skip to content

Commit

Permalink
Update intent for CQ (#377)
Browse files Browse the repository at this point in the history
  • Loading branch information
gewenyu99 authored Nov 15, 2024
1 parent 925f99d commit 175bef1
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion code-quality/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ Maintaining consistency in open-source repos is hard. That's why Trunk Code Qual

### How do I get started?

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Trunk CLI</strong></td><td>Initialize Code Quality in your projects using the Trunk CLI.</td><td></td><td><a href="setup-and-installation/initialize-trunk.md">initialize-trunk.md</a></td></tr><tr><td><strong>IDE Integration</strong></td><td>Initialize Code Quality in your projects using a VSCode extension.</td><td></td><td><a href="ide-integration/">ide-integration</a></td></tr><tr><td><strong>Web App</strong></td><td>Setup Code Quality to run on PRs and report nightly with the Trunk Web App</td><td></td><td><a href="https://app.trunk.io/login?intent=check">https://app.trunk.io/login?intent=check</a></td></tr></tbody></table>
<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Trunk CLI</strong></td><td>Initialize Code Quality in your projects using the Trunk CLI.</td><td></td><td><a href="setup-and-installation/initialize-trunk.md">initialize-trunk.md</a></td></tr><tr><td><strong>IDE Integration</strong></td><td>Initialize Code Quality in your projects using a VSCode extension.</td><td></td><td><a href="ide-integration/">ide-integration</a></td></tr><tr><td><strong>Web App</strong></td><td>Setup Code Quality to run on PRs and report nightly with the Trunk Web App</td><td></td><td><a href="https://app.trunk.io/login?intent=code+quality">https://app.trunk.io/login?intent=code+quality</a></td></tr></tbody></table>
8 changes: 4 additions & 4 deletions code-quality/ci-setup/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ description: Automate your code quality enforcement with just a few clicks.

# GitHub Integration

Trunk Code Quality has the ability to post its results to the [Trunk Code Quality web app](https://app.trunk.io/login?intent=check). This will enable you to view your repository's Code Quality history over time so you can track the trend of issues in your code, as well as browse the issues in your repository to help you understand which issues should be prioritized to fix.
Trunk Code Quality has the ability to post its results to the [Trunk Code Quality web app](https://app.trunk.io/login?intent=code+quality). This will enable you to view your repository's Code Quality history over time so you can track the trend of issues in your code, as well as browse the issues in your repository to help you understand which issues should be prioritized to fix.

## Connect your Trunk organization to GitHub

Sign up at [app.trunk.io](https://app.trunk.io), create a Trunk organization, and connect it to your repositories. You will need to grant the following [GitHub App permissions](../../administration/github-app-permissions.md).
Sign up at [app.trunk.io](https://app.trunk.io/login?intent=code+quality), create a Trunk organization, and connect it to your repositories. You will need to grant the following [GitHub App permissions](../../administration/github-app-permissions.md).

{% @supademo/embed demoId="HXyBmoBn0_OX9Xite2fqd" url="https://app.supademo.com/demo/HXyBmoBn0_OX9Xite2fqd" %}

Expand Down Expand Up @@ -45,7 +45,7 @@ This allows you to build confidence in the code health of your repositories:
* You will be alerted quickly in a [Heartbleed-type](https://heartbleed.com/) event, giving you assurances about whether or not a newly discovered vulnerability affects any of your repositories, and
* You can monitor how many Code Quality issues exist in each of your repositories and make data-driven decisions about prioritizing efforts to reduce tech debt

If you don't want Trunk Code Quality to scan your repository on a daily cadence or notify you, you can turn it off in [your repository's settings](https://app.trunk.io/login?intent=check).
If you don't want Trunk Code Quality to scan your repository on a daily cadence or notify you, you can turn it off in [your repository's settings](https://app.trunk.io/login?intent=code+quality).

<figure><img src="../../.gitbook/assets/Screenshot 2023-08-23 173119.png" alt=""><figcaption><p>Trunk Code Quality showing all the issues present in trunk-demo1/sass</p></figcaption></figure>

Expand Down Expand Up @@ -87,7 +87,7 @@ This can be helpful if Code Quality is flagging known issues in a given PR that

</details>

If you don't want Trunk Code Quality to run on pull requests, turn it off in [your repository's settings](https://app.trunk.io/login?intent=check).
If you don't want Trunk Code Quality to run on pull requests, turn it off in [your repository's settings](https://app.trunk.io/login?intent=code+quality).

### Uploading Results

Expand Down
8 changes: 4 additions & 4 deletions code-quality/ci-setup/github-integration.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Nightly Report

Trunk Code Quality has the ability to post its results to the [Trunk Code Quality web app](https://app.trunk.io/login?intent=check). This will enable you to view your repository's Code Quality history over time so you can track the trend of issues in your code, as well as browse the issues in your repository to help you understand which issues should be prioritized to fix.
Trunk Code Quality has the ability to post its results to the [Trunk Code Quality web app](https://app.trunk.io/login?intent=code+quality). This will enable you to view your repository's Code Quality history over time so you can track the trend of issues in your code, as well as browse the issues in your repository to help you understand which issues should be prioritized to fix.

### Connect your Trunk organization to GitHub

Sign up at [app.trunk.io](https://app.trunk.io), create a Trunk organization, and connect it to your repositories. You will need to grant the following GitHub App permissions.
Sign up at [app.trunk.io](https://app.trunk.io/login?intent=code+quality), create a Trunk organization, and connect it to your repositories. You will need to grant the following GitHub App permissions.

{% @supademo/embed demoId="HXyBmoBn0_OX9Xite2fqd" url="https://app.supademo.com/demo/HXyBmoBn0_OX9Xite2fqd" %}

Expand All @@ -26,7 +26,7 @@ If you would like to receive notifications for new issues Trunk finds in your re

Trunk Code Quality will automatically run on your repos with a Trunk configuration present when you install the GitHub app. This will work similar to what's shown in the [Prevent New Issues](../setup-and-installation/prevent-new-issues.md) page.

Check out [this example](https://github.com/trunk-io/plugins/pull/424/checks?check\_run\_id=15730277425) in our `plugins` repository. If you don't want Trunk Code Quality to run on pull requests, turn it off in [your repository's settings](https://app.trunk.io/login?intent=check).
Check out [this example](https://github.com/trunk-io/plugins/pull/424/checks?check\_run\_id=15730277425) in our `plugins` repository. If you don't want Trunk Code Quality to run on pull requests, turn it off in [your repository's settings](https://app.trunk.io/login?intent=code+quality).

#### Scanning your repository

Expand All @@ -37,7 +37,7 @@ This allows you to build confidence in the code health of your repositories:
* You will be alerted quickly in a [Heartbleed-type](https://heartbleed.com/) event, giving you assurances about whether or not a newly discovered vulnerability affects any of your repositories, and
* You can monitor how many Code Quality issues exist in each of your repositories and make data-driven decisions about prioritizing efforts to reduce tech debt

If you don't want Trunk Code Quality to scan your repository on a daily cadence or notify you, you can turn it off in [your repository's settings](https://app.trunk.io/login?intent=check).
If you don't want Trunk Code Quality to scan your repository on a daily cadence or notify you, you can turn it off in [your repository's settings](https://app.trunk.io/login?intent=code+quality).

#### **Get Slack notifications about new issues in your repository**

Expand Down
2 changes: 1 addition & 1 deletion code-quality/ci-setup/manual-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ You can also explicitly set the upstream branch if needed via `--upstream`, but
After your first upload to the Trunk Web App _without_ the Trunk GitHub App installed, you'll see the web app populate and be aware of the repo you uploaded from. We don't send or store your repo in the Trunk backend, see [security.md](../security.md "mention") for more info.
{% endhint %}

Trunk Code Quality has the ability to post its results to [app.trunk.io](https://app.trunk.io). This will enable you to view your repository's Code Quality history over time so you can track the trend of issues in your code, as well as browse the issues in your repository to help you understand which issues should be prioritized to fix.
Trunk Code Quality has the ability to post its results to [app.trunk.io](https://app.trunk.io/login?intent=code+quality). This will enable you to view your repository's Code Quality history over time so you can track the trend of issues in your code, as well as browse the issues in your repository to help you understand which issues should be prioritized to fix.

In order to keep the data up-to-date, you should upload Trunk Code Quality results regularly in an automated fashion. Depending on the size of your repository and the linters you have configured to run, running Trunk Code Quality on your whole repository may take a while. Because this run may take a while, we recommend uploading Trunk Code Quality results once daily. However, the system supports uploading results for every commit, so the granularity of upload is up to you.

Expand Down
2 changes: 1 addition & 1 deletion code-quality/overview/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Trunk Code Quality speeds up PR iteration by showing the _same_ results locally

#### **Lack of team visibility into the repo's health**

Trunk Code Quality improves team communication by providing a [web app](https://app.trunk.io/login?intent=check) for repo stats and [Slack notifications](../../administration/integration-for-slack.md), ensuring everyone on the team is aware of the current health of your repo.
Trunk Code Quality improves team communication by providing a [web app](https://app.trunk.io/login?intent=code+quality) for repo stats and [Slack notifications](../../administration/integration-for-slack.md), ensuring everyone on the team is aware of the current health of your repo.

### Components

Expand Down

0 comments on commit 175bef1

Please sign in to comment.