Skip to content

Commit

Permalink
Merge branch 'master' into eng-523
Browse files Browse the repository at this point in the history
  • Loading branch information
eshaan-deepsource authored Jan 10, 2024
2 parents b00bf82 + 735b51b commit ee44403
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 14 deletions.
9 changes: 2 additions & 7 deletions .github/workflows/syncer.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ on:
- v*

env:
SYNC_ENDPOINT: ${{ secrets.SYNC_ENDPOINT_DEV }}
DATASYNC_SECRET: ${{ secrets.DATASYNC_SECRET_DEV }}
SYNC_ENDPOINT: ${{ secrets.SYNC_ENDPOINT }}
DATASYNC_SECRET: ${{ secrets.DATASYNC_SECRET }}

jobs:
sync_analyzers:
Expand All @@ -17,11 +17,6 @@ jobs:
- uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.sha }}

- name: Tailscale
uses: tailscale/github-action@v1
with:
authkey: ${{ secrets.TAILSCALE_AUTHKEY }}

- name: Send sync signal
run: |
Expand Down
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
# DeepSource Community Analyzers

Hub of all open-sourced third-party static analyzers supported by DeepSource.
Hub of all open-source third-party static analyzers supported by DeepSource. Usage docs can be found at [docs.deepsource.com/docs/community-analyzers](https://docs.deepsource.com/docs/community-analyzers)

## Supported Analyzers

| Analyzer name | Latest version | Language / Technology |
| :---------------------------------------------------------------------------- | :------------- | :--------------------- |
| [Azure/bicep](https://github.com/Azure/bicep) | v0.20.4 | Azure Resource Manager |
| [stackrox/kube-linter](https://github.com/stackrox/kube-linter) | 0.6.4 | Kubernetes, Helm |
| [aws-cloudformation/cfn-lint](https://github.com/aws-cloudformation/cfn-lint) | 0.83.3 | AWS CloudFormation |
| [dart-lang/linter](https://github.com/dart-lang/sdk/tree/main/pkg/linter) | 3.2.0 | Dart, Flutter |
Expand Down Expand Up @@ -47,6 +46,7 @@ The following are very important to sync analyzers with DeepSource:
3. `CI` directory:

Put example configs of all CIs under this directory. These worlflow / CI configs should run the analyzer, create a sarif report and send it to DeepSource.

Each file should be names as `<provider>.<extention>`. Example: `github.yml`, `circleci.yml`, etc.`

4. `utils` directory:
Expand All @@ -61,6 +61,8 @@ For example, please check out `analyzers/kube-linter/utils`.

Push a tag after merging all the changes to the default (master) branch. The `Sync community analyzers` workflow triggers on tag pushes matching `v*` and will sync the analyzers and their issues with DeepSource.

> Note: This action will be done by a member of the DeepSource team; contributors need not create a tag.
### Running tests

- Create and activate a virtual environment
Expand All @@ -82,7 +84,3 @@ extension.
### Type Checking

Run `mypy .`

## Maintenance Guide

...
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ version = 1

[[analyzers]]
name = "kube-linter"
type = "community"
2 changes: 1 addition & 1 deletion analyzers/kube-linter/CI/github-actions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ jobs:
curl https://deepsource.io/cli | sh
# Send the report to DeepSource
./bin/deepsource report --analyzer kube-linter --value-file ./kube-linter.sarif
./bin/deepsource report --analyzer kube-linter --analyzer-type community --value-file ./kube-linter.sarif
# Ensure the workflow eventually fails if files did not pass kube-linter checks.
- name: Verify kube-linter-action succeeded
Expand Down

0 comments on commit ee44403

Please sign in to comment.