From d5eddb089367f0784e2b376df10c3c25d1622c00 Mon Sep 17 00:00:00 2001 From: Will Button Date: Thu, 14 Dec 2023 12:06:34 -0600 Subject: [PATCH] initial commit --- .github/CODEOWNERS | 30 +-------------------------- .github/workflows/security-build.yml | 6 ++++-- .gitignore | 0 README.md | 31 +++++++--------------------- sonar-project.properties | 16 ++------------ 5 files changed, 14 insertions(+), 69 deletions(-) create mode 100644 .gitignore diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 847bd84..cfab344 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,30 +1,2 @@ -# This is a comment. +* @devops @searce -# Each line is a file pattern followed by one or more owners. - -# These owners will be the default owners for everything in the repo. -* @default-owner - -# Order is important. The last matching pattern has the most precedence. - -# To set ownership of a particular folder, add a line like this: -/docs/ @documentation-team - -# To set ownership of all .js files in the src/js/ directory, add a line like this: -/src/js/*.js @js-developers - -# You can also specify individual users. This will make @octocat the owner of any .md files at the root of the repository: -/*.md @octocat - -# In this example, @doctocat owns any files in the /apps/ directory and any of its subdirectories. -/apps/ @doctocat - -# The `@backend-team` team owns any files in the `/api/` directory in the root of your repository and any of its subdirectories. -/api/ @backend-team - -# The `@frontend-team` team owns any files in the `/web/` directory in the root of your repository and any of its subdirectories. -/web/ @frontend-team - -# Add this line at the end of the file to always require pull request reviews -# when someone on the team is not an owner and the pull request modifies code owned by the team. -* @global-owner diff --git a/.github/workflows/security-build.yml b/.github/workflows/security-build.yml index 247a0e3..a431ac5 100644 --- a/.github/workflows/security-build.yml +++ b/.github/workflows/security-build.yml @@ -2,11 +2,13 @@ name: Security Build on: push: branches: - - master # or the name of your main branch + - main # or the name of your main and preferred branches + - dev + - staging # or the name of your main and preferred branches workflow_dispatch: {} pull_request: types: [opened, synchronize, reopened] - + jobs: sonarcloud: name: SonarCloud diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md index 0dac8a7..93c9d07 100644 --- a/README.md +++ b/README.md @@ -3,36 +3,21 @@ [![Coverage][Coverage-badge]][Sonar-url] [![Vulnerabilities][Vulnerability-badge]][Sonar-url] -# 0xPolygon GitHub Template -This repo serves as a template for new repositories in the 0xPolygon organization. - -# Action Items -The following actions are required once you create a new repository from this repo: -- Update this README. Complete the sections to reflect your project -- Update `CODEOWNERS` file -- Update `sonar-project.properties` by adding your Sonar project key provided by the Security Team -- Update badges to reflect your project (badges are located at the bottom of this README) -- Ensure you are using Issue and PR Templates - -## About The Project - +# 0xPolygon Pipelines +This repo serves as the repository for shared pipelines across the Polygon organization. To learn more about using +shared pipelines, please see the [Shared Pipelines Documentation](https://docs.github.com/en/actions/creating-actions/sharing-actions-and-workflows-with-your-organization). ### Built With -[![Node.js 18][Language-badge]][Language-url] - +![Static Badge](https://img.shields.io/badge/alcohol-sarcasm-8A2BE2?logo=polygon) ## Getting Started ### Local Development -### Database - -### Installation - ## Usage -Use this space to show useful examples of how a project can be used. Additional screenshots, code examples, and demos work well in this space. This is incredibly useful for support personnel when responding to issues related to your application. +TODO ## Contributing @@ -49,8 +34,6 @@ This is the place to document your delivery workflow. For example: ![Email][Email-badge] ![Slack][Slack-badge] -[![Production URL][Production-badge]][Production-url] -[![Staging URL][Staging-badge]][Staging-url] @@ -60,8 +43,8 @@ This is the place to document your delivery workflow. For example: [Sonar-url]: https://sonarqube.polygon.technology/dashboard?id=TODO [Language-badge]: https://img.shields.io/badge/Nodejs-18.0-informational [Language-url]: https://nodejs.org/en -[Email-badge]: https://img.shields.io/badge/Email-team_email_address-informational?logo=gmail -[Slack-badge]: https://img.shields.io/badge/Slack-team_ChannelName-informational?logo=slack +[Email-badge]: https://img.shields.io/badge/Email-devops@polygon.technology-informational?logo=gmail +[Slack-badge]: https://img.shields.io/badge/Slack-team_devops-informational?logo=slack [Production-badge]: https://img.shields.io/badge/Production_URL-polygon.technology-informational [Production-url]: https://link.to/prod [Staging-badge]: https://img.shields.io/badge/Staging_URL-staging.polygon.technology-informational diff --git a/sonar-project.properties b/sonar-project.properties index 03ba6b4..303d284 100644 --- a/sonar-project.properties +++ b/sonar-project.properties @@ -1,14 +1,2 @@ -sonar.projectKey= -sonar.organization=0xpolygon - -# This is the name and version displayed in the SonarCloud UI. -#sonar.projectName=cdk-validium-node -#sonar.projectVersion=1.0 - - -# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows. -#sonar.sources=. -#sonar.exclusions=. - -# Encoding of the source code. Default is default system encoding -#sonar.sourceEncoding=UTF-8 +sonar.projectKey=0xPolygon_pipelines #replace with repository name +sonar.organization=0xpolygon #replace with github org name