From 2b4d363b11f3c90f030adcf430b33ec48992b801 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Mon, 17 Jun 2024 14:40:52 -0700 Subject: [PATCH] docs: added CI and basic repo structure --- .github/dependabot.yml | 6 ++++ .github/pull_request_template.md | 11 +++++++ .github/workflows/gitleaks.yml | 35 +++++++++++++++++++++++ .gitignore | 4 +++ Makefile | 5 ++++ README.md | 17 +++++++++-- docs/CONTRIBUTION.md | 3 ++ static/images/spectrocloud-logo-light.svg | 21 ++++++++++++++ 8 files changed, 100 insertions(+), 2 deletions(-) create mode 100644 .github/dependabot.yml create mode 100644 .github/pull_request_template.md create mode 100644 .github/workflows/gitleaks.yml create mode 100644 .gitignore create mode 100644 Makefile create mode 100644 docs/CONTRIBUTION.md create mode 100644 static/images/spectrocloud-logo-light.svg diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..6fff16c --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,6 @@ +version: 2 +updates: + - package-ecosystem: github-actions + directory: "/" + schedule: + interval: monthly diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..f1d3ced --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,11 @@ +## Describe the Change + + + +This PR .... + +## Jira Tickets + + + +🎫 [Jira Ticket]() diff --git a/.github/workflows/gitleaks.yml b/.github/workflows/gitleaks.yml new file mode 100644 index 0000000..8cebf33 --- /dev/null +++ b/.github/workflows/gitleaks.yml @@ -0,0 +1,35 @@ +name: GitLeaks +on: [pull_request] + +concurrency: + group: gitleaks-${{ github.ref }} + cancel-in-progress: true + +jobs: + gitleaks-scan: + runs-on: ubuntu-latest + container: + image: gcr.io/spectro-dev-public/bulwark/gitleaks:latest + env: + REPO: ${{ github.event.repository.name }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GITLEAKS_CONFIG: config.toml + steps: + - name: run-bulwark-gitleaks-scan + shell: sh + env: + BRANCH: ${{ github.head_ref || github.ref_name }} + run: /workspace/bulwark -name CodeSASTGitLeaks -target $REPO -tags "branch:$BRANCH,options:--log-opts origin..HEAD" + + - name: check-result + shell: sh + run: | + resultPath=./$REPO/gitleaks.json + cat $resultPath | grep -v \"Match\"\: | grep -v \"Secret\"\: + total_failed_tests=`cat $resultPath | grep \"Fingerprint\"\: | wc -l` + if [ "$total_failed_tests" -gt 0 ]; then + echo "GitLeaks validation check failed with above findings..." + exit 1 + else + echo "GitLeaks validation check passed" + fi diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3a3fc2d --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +.cache/ +.DS_Store +.vale/styles/*.zip +node_modules/ \ No newline at end of file diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..50e0e24 --- /dev/null +++ b/Makefile @@ -0,0 +1,5 @@ + + + +help: ## Display this help + @awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[0m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST) diff --git a/README.md b/README.md index e47fdca..c309740 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,15 @@ -# spectro-vale-pkg -A custom Vale package containing rules and standards that adhere to the Spectro Cloud Style Guide + + +# Spectro Cloud Vale Package + +![Spectro Cloud logo with docs inline](/static/img/spectrocloud-logo-light.svg) + +This repository contains the Vale package for Spectro Cloud documentation. The package includes custom rules and configurations to ensure consistency and quality across the documentation. The package is based of the [Spectro Cloud style guide](https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro+Cloud+Internal+Style+Guide) and best practices. + +## Usage + +TBD + +## Contribution + +Please refer to the [Contribution Guide](docs/CONTRIBUTION.md) for more information on how to contribute to this repository. diff --git a/docs/CONTRIBUTION.md b/docs/CONTRIBUTION.md new file mode 100644 index 0000000..d41b510 --- /dev/null +++ b/docs/CONTRIBUTION.md @@ -0,0 +1,3 @@ +# Contribution + +TBD diff --git a/static/images/spectrocloud-logo-light.svg b/static/images/spectrocloud-logo-light.svg new file mode 100644 index 0000000..43fd25e --- /dev/null +++ b/static/images/spectrocloud-logo-light.svg @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + + + + + +