Skip to content

Commit

Permalink
GH workflows: linting, 3rd party license, and doc check (#29)
Browse files Browse the repository at this point in the history
- Added workflow for: lint check, 3rd party license update and doc update.
- Added `BOT_REPO_SCOPED_TOKEN` repo secret for the bot to properly detect changes and auto-commit to repo as part of the GH workflows.

Downgraded generate-license-file from v2 to v1 to match the version in shared workflow (output format is slightly different). I tried to migrate the workflow to latest (v3) but noticed a bug so I submitted an issue report in their repo: TobyAndToby/generate-license-file#250. Once that is done, the workflow version and the local devDep version of generate-license-file can be updated

J=CLIP-100
TEST=auto

see that the workflows ran as expected as checks under this PR
  • Loading branch information
yen-tt authored Dec 6, 2023
1 parent af16c6c commit d5ce02d
Show file tree
Hide file tree
Showing 13 changed files with 302 additions and 191 deletions.
7 changes: 7 additions & 0 deletions .github/workflows/run-linting.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
name: Run Linter

on: pull_request

jobs:
linting:
uses: yext/slapshot-reusable-workflows/.github/workflows/run-linting.yml@v1
9 changes: 9 additions & 0 deletions .github/workflows/update-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: Check and Update Repo's documenation

on: pull_request

jobs:
call_update_docs:
uses: yext/slapshot-reusable-workflows/.github/workflows/update_docs.yml@v1
secrets:
REPO_SCOPED_TOKEN: ${{ secrets.BOT_REPO_SCOPED_TOKEN }}
9 changes: 9 additions & 0 deletions .github/workflows/update-third-party-notices.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: Check and Update Third Party Notices

on: pull_request

jobs:
call_notices_check:
uses: yext/slapshot-reusable-workflows/.github/workflows/third_party_notices_check.yml@v1
secrets:
REPO_SCOPED_TOKEN: ${{ secrets.BOT_REPO_SCOPED_TOKEN }}
16 changes: 6 additions & 10 deletions THIRD-PARTY-NOTICES
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
This file was generated with the generate-license-file npm package!
https://www.npmjs.com/package/generate-license-file

The following npm package may be included in this product:
The following NPM package may be included in this product:

- [email protected]

Expand Down Expand Up @@ -31,7 +28,7 @@ SOFTWARE.

-----------

The following npm package may be included in this product:
The following NPM package may be included in this product:

- [email protected]

Expand Down Expand Up @@ -61,7 +58,7 @@ SOFTWARE.

-----------

The following npm package may be included in this product:
The following NPM package may be included in this product:

- [email protected]

Expand All @@ -71,7 +68,7 @@ This package contains the following license and notice below:

-----------

The following npm package may be included in this product:
The following NPM package may be included in this product:

- [email protected]

Expand All @@ -92,7 +89,7 @@ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND

-----------

The following npm package may be included in this product:
The following NPM package may be included in this product:

- [email protected]

Expand Down Expand Up @@ -122,5 +119,4 @@ THE SOFTWARE.

-----------

This file was generated with the generate-license-file npm package!
https://www.npmjs.com/package/generate-license-file
This file was generated with generate-license-file! https://www.npmjs.com/package/generate-license-file
2 changes: 1 addition & 1 deletion docs/chat-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

| Function | Description |
| --- | --- |
| [provideChatCore(config)](./chat-core.providechatcore.md) | Provider for the ChatCore library |
| [provideChatCore(config)](./chat-core.providechatcore.md) | Provider for the ChatCore library. |

## Interfaces

Expand Down
2 changes: 1 addition & 1 deletion docs/chat-core.providechatcore.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## provideChatCore() function

Provider for the ChatCore library
Provider for the ChatCore library.

**Signature:**

Expand Down
Loading

0 comments on commit d5ce02d

Please sign in to comment.