From 726a433f59f48ce431048bb75aad35a743724cb4 Mon Sep 17 00:00:00 2001 From: Victor Castell <0x@vcastellm.xyz> Date: Wed, 19 Jun 2024 14:50:36 +0000 Subject: [PATCH] ci: commit linting workflow Add commit linting workflow and PR title check. --- .github/PULL_REQUEST_TEMPLATE.md | 39 ---------------------------- .github/workflows/lint-pr.yml | 31 ++++++++++++++++++++++ .github/workflows/security-build.yml | 2 +- sonar-project.properties | 14 +--------- 4 files changed, 33 insertions(+), 53 deletions(-) create mode 100644 .github/workflows/lint-pr.yml diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index fc5259ce..dcee3469 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,44 +1,5 @@ -# Pull Request Template - ## Description Please include a summary of the change and which issue is fixed. Also, include relevant motivation and context. List any dependencies that are required for this change. Fixes # (issue) - -## Type of change - -Please delete options that are not relevant. - -- [ ] Bug fix (non-breaking change which fixes an issue) -- [ ] New feature (non-breaking change which adds functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) -- [ ] This change requires a documentation update - -## How Has This Been Tested? - -Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. - -- [ ] Test A -- [ ] Test B - -## Checklist: - -Before you submit your pull request, please make sure you have completed the following: - -- [ ] I have followed the [contributing guidelines](CONTRIBUTING.md). -- [ ] My code follows the style guidelines of this project and I have run `lint` to ensure the code style is valid -- [ ] I have performed a self-review of my own code -- [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation -- [ ] My changes generate no new warnings -- [ ] I have added tests that prove my fix is effective or that my feature works -- [ ] New and existing unit tests pass locally with my changes - -## Screenshots (if appropriate): - -Include any screenshots that will help explain your changes. - -## Additional context - -Add any other context about the pull request here. diff --git a/.github/workflows/lint-pr.yml b/.github/workflows/lint-pr.yml new file mode 100644 index 00000000..780405d7 --- /dev/null +++ b/.github/workflows/lint-pr.yml @@ -0,0 +1,31 @@ +name: Checking PR semantic + +on: + pull_request: + types: [opened, synchronize, reopened] + +permissions: + contents: read + pull-requests: read + statuses: write + +jobs: + title: + name: Validate PR title + runs-on: ubuntu-latest + steps: + - uses: amannn/action-semantic-pull-request@v5 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + ignoreLabels: | + release + + commits: + name: Validate PR commits + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - uses: wagoid/commitlint-github-action@v6 diff --git a/.github/workflows/security-build.yml b/.github/workflows/security-build.yml index 247a0e3d..a4def677 100644 --- a/.github/workflows/security-build.yml +++ b/.github/workflows/security-build.yml @@ -2,7 +2,7 @@ name: Security Build on: push: branches: - - master # or the name of your main branch + - main # or the name of your main branch workflow_dispatch: {} pull_request: types: [opened, synchronize, reopened] diff --git a/sonar-project.properties b/sonar-project.properties index 03ba6b4f..973e1bc7 100644 --- a/sonar-project.properties +++ b/sonar-project.properties @@ -1,14 +1,2 @@ -sonar.projectKey= +sonar.projectKey=0xPolygon_cdk 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