From 5c61050b98499bb86935d391a18d85fe2797f87b Mon Sep 17 00:00:00 2001 From: Ben Donnelly Date: Thu, 7 Sep 2023 13:38:54 +0100 Subject: [PATCH 1/2] chore(docs): add fmt check and update CONTRIBUTING.md --- .github/workflows/on_push.yml | 14 ++++++++++++++ .gitignore | 1 + .idea/.gitignore | 3 +++ CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ Makefile | 2 +- README.md | 7 ++++--- docs/docs/index.md | 5 ++++- 7 files changed, 57 insertions(+), 5 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/.github/workflows/on_push.yml b/.github/workflows/on_push.yml index 55065f1..2a12e03 100644 --- a/.github/workflows/on_push.yml +++ b/.github/workflows/on_push.yml @@ -87,3 +87,17 @@ jobs: - name: Check vendor run: make vendor-check + + lint: + name: Lint & Format + runs-on: ubuntu-latest + steps: + - name: Set up Go 1.20 + uses: actions/setup-go@v3 + with: + go-version: 1.20.x + + - name: Check out code + uses: actions/checkout@v3 + + - run: make check-fmt diff --git a/.gitignore b/.gitignore index d24bf09..b702d0b 100644 --- a/.gitignore +++ b/.gitignore @@ -12,3 +12,4 @@ private-key.key /vendor /pkg/.patched-proto y.output +report.xml diff --git a/.idea/.gitignore b/.idea/.gitignore index 13566b8..25a0572 100644 --- a/.idea/.gitignore +++ b/.idea/.gitignore @@ -6,3 +6,6 @@ # Datasource local storage ignored files /dataSources/ /dataSources.local.xml +kubernetes-settings.xml +protoeditor.xml +inspectionProfiles/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..70bb53b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing + +Deep uses GitHub to mange reviews of pull requests: + +- If you have a trivial fix or improvement, go ahead and create a pull request. +- If you plan to do something more involved, discuss you ideas on the relevant GitHub issue. + +# Dependency Management + +We use Go modules to manage dependencies on external packages. This requires a working Go environment with version 1.18 +or greater and git installed. + +To add or update a new dependency, use the `go get` command: + +```bash +# Pick the latest tagged release. +go get example.com/some/module/pkg + +# Pick a specific version +go get example.com/some/module/pkg@vX.Y.Z +``` + +Before submitting please run the following to verify that all dependencies and proto definitions are consistent. + +```bash +make vendor-check +``` + +Additionally, this project uses [`gofumpt`](https://github.com/mvdan/gofumpt) to format the style of the go code. Ensure that `make fmt` has been run before +submitting. diff --git a/Makefile b/Makefile index 10f80e3..5cc44e5 100644 --- a/Makefile +++ b/Makefile @@ -95,7 +95,7 @@ exe-debug: .PHONY: fmt check-fmt fmt: echo $(FILES_TO_FMT) - @gofmt -s -w $(FILES_TO_FMT) + @gofumpt -l -w . @goimports -w $(FILES_TO_FMT) check-fmt: fmt diff --git a/README.md b/README.md index a3a586b..1d3ddee 100644 --- a/README.md +++ b/README.md @@ -74,11 +74,12 @@ Here is a quick summary of the features and supported options: - :heavy_check_mark: AWS: Tested with EKS and S3 - :warning: GCS: Support is available, but it is not tested - :warning: Azure: Support is available, but it is not tested - - :x: Distributed Mode: This is not available yet - only single binary support is currently working - - :warning: Multi Tenancy: Support is available, but it has not been tested + - :heavy_check_mark: Distributed Mode: This is available and working + - :heavy_check_mark: Multi Tenancy: This is available and working + - :heavy_check_mark: Helm: [helm chart](https://github.com/intergral/deep-helm) deployments are available - :x: DeepQL: Initial steps are complete, but it is not available yet. - Language Support: - - :heavy_check_mark: [Java](https://github.com/intergral/deep-java-client) - The agent is available and released as version 1.0.0 + - :heavy_check_mark: [Java](https://github.com/intergral/deep-java-client) - The agent is available and released as version 1.1.0 - :heavy_check_mark: [Python](https://github.com/intergral/deep-python-client) - The Agent is available and released as version 1.0.0 - Other languages (Ruby, Go, Node, .Net) are planned but not started. diff --git a/docs/docs/index.md b/docs/docs/index.md index 20b0be7..ad75a64 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -15,6 +15,10 @@ To use deep you need to deploy the service, there are a few options for this: Once the service is deployed you will need to setup a client and connect Grafana to the service. +## Helm +To use deep with Helm see our dedicated project and site: +[github](intergral/deep-helm) + ### Grafana To connect grafana to DEEP you will need to install the deep plugins. @@ -31,4 +35,3 @@ available clients are: - [github](intergral/deep-python-client) - [github](intergral/deep-java-client) -- [github](intergral/deep-java-client) From 8286fb4a43ee16620044c236e95217742de69780 Mon Sep 17 00:00:00 2001 From: Ben Donnelly Date: Thu, 7 Sep 2023 13:48:19 +0100 Subject: [PATCH 2/2] chore(docs): fix typo --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 70bb53b..c93ca9f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing -Deep uses GitHub to mange reviews of pull requests: +Deep uses GitHub to manage reviews of pull requests: - If you have a trivial fix or improvement, go ahead and create a pull request. - If you plan to do something more involved, discuss you ideas on the relevant GitHub issue.