update branding properties

trunk-io · Nov 28, 2021 · 01dd20f · 01dd20f
1 parent 17bafc5
commit 01dd20f
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 19 deletions.
diff --git a/.github/workflows/pr.yaml b/.github/workflows/pr.yaml
@@ -20,4 +20,4 @@ jobs:
           key: trunk-${{ runner.os }}
 
       - name: Trunk Check
-        uses: trunk-io/trunk-action@v0.2.1-alpha
+        uses: trunk-io/trunk-action@v0.3.0-beta
diff --git a/.trunk/trunk.yaml b/.trunk/trunk.yaml
@@ -1,14 +1,11 @@
 version: 0.1
 cli:
-  version: 0.1.33-alpha
-  sha256:
-    darwin_x86_64: f1ee343cc08c7646711b3553b055198f3052b03114544df65367d94cec0fc4e9
-    linux_x86_64: 2ff4574f4e1d93162a3b2243c9e6f8926edb85885adc297e169495c0801e84cb
+  version: 0.2.0-alpha
 lint:
   enabled:
     - actionlint@1.6.8
     - gitleaks@7.6.1
-    - markdownlint@0.29.0
-    - prettier@2.4.1
+    - markdownlint@0.30.0
+    - prettier@2.5.0
     - shellcheck@0.8.0
     - shfmt@3.4.0
diff --git a/action.yaml b/action.yaml
@@ -2,6 +2,10 @@ name: Trunk Check
 author: trunk.io
 description: The official trunk.io GitHub action
 
+branding:
+  icon: check
+  color: orange
+
 inputs:
   trunk-path:
     description: Path to Trunk Launcher
@@ -16,14 +20,18 @@ runs:
   steps:
     - name: Locate trunk
       shell: bash
-      run: ${GITHUB_ACTION_PATH}/locate_trunk.sh
+      run: |
+        # Locate trunk
+        ${GITHUB_ACTION_PATH}/locate_trunk.sh
       env:
         INPUTS_TRUNK_PATH: ${{ inputs.trunk-path }}
 
     - name: Run trunk check on pull request
       if: ${{ github.event_name == 'pull_request' || github.event_name == 'pull_request_target' }}
       shell: bash
-      run: ${GITHUB_ACTION_PATH}/pull_request.sh
+      run: |
+        # Run trunk check on pull request
+        ${GITHUB_ACTION_PATH}/pull_request.sh
       env:
         GITHUB_EVENT_PULL_REQUEST_BASE_SHA: ${{ github.event.pull_request.base.sha }}
         GITHUB_EVENT_PULL_REQUEST_HEAD_SHA: ${{ github.event.pull_request.head.sha }}
@@ -35,7 +43,9 @@ runs:
     - name: Run trunk check on all
       if: ${{ github.event_name != 'pull_request' && github.event_name != 'pull_request_target' }}
       shell: bash
-      run: ${GITHUB_ACTION_PATH}/all.sh
+      run: |
+        # Run trunk check on all
+        ${GITHUB_ACTION_PATH}/all.sh
       env:
         GITHUB_REPOSITORY: ${{ github.repository }}
         GITHUB_SHA: ${{ github.sha }}
@@ -45,4 +55,6 @@ runs:
     - name: Cleanup temporary files
       if: ${{ always() }}
       shell: bash
-      run: ${GITHUB_ACTION_PATH}/cleanup.sh
+      run: |
+        # Cleanup temporary files
+        ${GITHUB_ACTION_PATH}/cleanup.sh
diff --git a/readme.md b/readme.md
@@ -9,15 +9,18 @@
   <a href="https://trunk.io">
     <img src="https://github.com/trunk-io/trunk-action/actions/workflows/pr.yaml/badge.svg"/>
   </a>
+  <a href="https://marketplace.visualstudio.com/items?itemName=Trunk.io">
+    <img src="https://img.shields.io/visual-studio-marketplace/i/Trunk.io?logo=visualstudiocode"/>
+  </a>
   <a href="https://slack.trunk.io">
-    <img src="https://img.shields.io/badge/slack-community-blue?logo=slack"/>
+    <img src="https://img.shields.io/badge/slack-slack.trunk.io-blue?logo=slack"/>
   </a>
   <a href="https://docs.trunk.io">
-    <img src="https://img.shields.io/badge/docs-7f7fcc?logo=readthedocs&labelColor=555555&logoColor=ffffff"/>
+    <img src="https://img.shields.io/badge/docs.trunk.io-7f7fcc?label=docs&logo=readthedocs&labelColor=555555&logoColor=ffffff"/>
   </a>
 </p>
 
-> 🎉 Trunk is in alpha. We'd appreciate your feedback - stop by the
+> 🎉 Trunk is in beta. We'd appreciate your feedback - stop by the
 > [Trunk Community Slack](https://slack.trunk.io/) and let us know what you think. Thanks!
 
 This action runs [`trunk check`](https://trunk.io), a super powerful meta linter and formatter, showing inline annotations on your PRs for any issues found. Trunk runs just as well locally as on CI, so you can always quickly see lint issues _before_ pushing your changes.
@@ -51,7 +54,7 @@ steps:
   # >>> Install your own deps here (npm install, etc) <<<
 
   - name: Trunk Check
-    uses: trunk-io/trunk-action@v0.2.1-alpha
+    uses: trunk-io/trunk-action@v0.3.0-beta
 ```
 
 (See this repo's [`pr.yaml`](https://github.com/trunk-io/trunk-action/blob/main/.github/workflows/pr.yaml) workflow for further reference)
@@ -71,6 +74,8 @@ If you've setup basic testing on CI, you're already doing this for other CI jobs
 
 We integrate new linters every release. Stop by on [slack](https://slack.trunk.io/) and let us know what you'd like next!
 
+We currently support the following linters.
+
 | Language        | Linters                                                                          |
 | --------------- | -------------------------------------------------------------------------------- |
 | All             | `gitleaks`                                                                       |
@@ -80,13 +85,14 @@ We integrate new linters every release. Stop by on [slack](https://slack.trunk.i
 | C/C++           | `clang-format`, `clang-tidy`                                                     |
 | Cloudformation  | `cfnlint`                                                                        |
 | Docker          | `hadolint`                                                                       |
+| GitHub          | `actionlint`                                                                     |
 | Go              | `gofmt`, `golangci-lint`, `semgrep`                                              |
 | Java            | `semgrep`                                                                        |
 | JS/TS           | `eslint`, `prettier`, `semgrep`                                                  |
 | Markdown        | `markdownlint`                                                                   |
-| Protobuf        | `buf`                                                                            |
+| Protobuf        | `buf-breaking`, `buf-lint`                                                       |
 | Python          | `autopep8`, `bandit`, `black-py`, `flake8`, `isort`, `pylint`, `semgrep`, `yapf` |
-| Ruby            | `semgrep`                                                                        |
+| Ruby            | `brakeman`,`rubocop`,`rufo`, `semgrep`                                           |
 | Rust            | `clippy`, `rustfmt`                                                              |
 | Terraform       | `terraform-fmt`                                                                  |
 
@@ -112,14 +118,14 @@ If you'd like to run multiple Trunk Check jobs on different platforms at the sam
 
 ```yaml
 - name: Trunk Check
-  uses: trunk-io/trunk-action@v0.2.1-alpha
+  uses: trunk-io/trunk-action@v0.3.0-beta
   with:
     label: ${{ runner.os }}
 ```
 
 ## Badge
 
-Add your very own [![](https://github.com/trunk-io/trunk-action/actions/workflows/pr.yaml/badge.svg)](https://trunk.io) !
+Add your very own [![Trunk Check](https://github.com/trunk-io/trunk-action/actions/workflows/pr.yaml/badge.svg)](https://trunk.io) !
 
 Follow [these instructions](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge) to create a workflow status badge. For example: