diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 8b37ee2..ac141ad 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -113,7 +113,7 @@ Another line of really good description ``` ## Pull Request Guideline -Okay you finished your work committed all your changes to your branch. Time to create a pull request. +Okay, you finished your work and committed all your changes to your branch. Time to create a pull request. Refer to the general pull request [guideline](https://opensource.guide/how-to-contribute/#opening-a-pull-request) from GitHub. What to consider when raising a Pull Request: 1. **Pull Request Naming** @@ -124,10 +124,8 @@ What to consider when raising a Pull Request: GitHub assigns reviewers based on the [CODEOWNERS](CODEOWNERS) file. Add more reviewers if needed. Do not remove reviewers from the PR. Ask the repository owner for updates to the code owners. 4. **Evaluate the Action Workflow Results** - The following workflows are included in every repository: - - **[Coding Convention Check](workflows/00-Check-Code-Convention.yml)**: Analyzes the code formatting and fails if any rules are broken. - - **[Firmware Build](workflows/02-Build-Firmware.yml)**: Builds the firmware inside the [Dockerfile](../Dockerfile). - - **[Secret Scanner](workflows/04-TruffleHog-Security-Scan.yml)**: Runs the TruffleHog security scanner to look for API keys and committed secrets. + The following workflows are included in this repository: + - **[Unit tests and Coverage Report](workflows/unittest-and-coverage.yml)**: Runs the unit tests and generates the coverage report. Total coverage should remain in the high 90s. ### As a Reviewer diff --git a/.github/rulesets/Silabs-basic-public-ruleset.json b/.github/rulesets/Silabs-basic-public-ruleset.json deleted file mode 100644 index 3fb4e6b..0000000 --- a/.github/rulesets/Silabs-basic-public-ruleset.json +++ /dev/null @@ -1,60 +0,0 @@ -{ - "id": 2684086, - "name": "Main and release branches are protected", - "target": "branch", - "source_type": "Repository", - "source": "SiliconLabsSoftware/devs-template-public", - "enforcement": "active", - "conditions": { - "ref_name": { - "exclude": [], - "include": [ - "refs/heads/release/**/*", - "refs/heads/master", - "refs/heads/main" - ] - } - }, - "rules": [ - { - "type": "deletion" - }, - { - "type": "non_fast_forward" - }, - { - "type": "pull_request", - "parameters": { - "required_approving_review_count": 1, - "dismiss_stale_reviews_on_push": true, - "require_code_owner_review": true, - "require_last_push_approval": true, - "required_review_thread_resolution": true, - "automatic_copilot_code_review_enabled": true, - "allowed_merge_methods": [ - "merge", - "squash", - "rebase" - ] - } - }, - { - "type": "creation" - }, - { - "type": "required_signatures" - } - ], - "bypass_actors": [ - { - "actor_id": null, - "actor_type": "OrganizationAdmin", - "bypass_mode": "always" - }, - { - "actor_id": 5, - "actor_type": "RepositoryRole", - "bypass_mode": "always" - } - ] -} \ No newline at end of file diff --git a/.github/rulesets/Silabs-basic-ruleset-internal.json b/.github/rulesets/Silabs-basic-ruleset-internal.json deleted file mode 100644 index f7ca134..0000000 --- a/.github/rulesets/Silabs-basic-ruleset-internal.json +++ /dev/null @@ -1,55 +0,0 @@ -{ - "id": 4076935, - "name": "Main and release branches are protected", - "target": "branch", - "source_type": "Repository", - "source": "SiliconLabsSoftware/devs-template", - "enforcement": "active", - "conditions": { - "ref_name": { - "exclude": [], - "include": [ - "~DEFAULT_BRANCH", - "refs/heads/main", - "refs/heads/master", - "refs/heads/release/**" - ] - } - }, - "rules": [ - { - "type": "deletion" - }, - { - "type": "non_fast_forward" - }, - { - "type": "pull_request", - "parameters": { - "required_approving_review_count": 1, - "dismiss_stale_reviews_on_push": true, - "require_code_owner_review": true, - "require_last_push_approval": true, - "required_review_thread_resolution": true, - "automatic_copilot_code_review_enabled": true, - "allowed_merge_methods": [ - "merge", - "squash", - "rebase" - ] - } - } - ], - "bypass_actors": [ - { - "actor_id": null, - "actor_type": "OrganizationAdmin", - "bypass_mode": "always" - }, - { - "actor_id": 5, - "actor_type": "RepositoryRole", - "bypass_mode": "always" - } - ] -} \ No newline at end of file diff --git a/.github/workflows/unittest-and-coverage.yml b/.github/workflows/unittest-and-coverage.yml index 2a215df..ed0be60 100644 --- a/.github/workflows/unittest-and-coverage.yml +++ b/.github/workflows/unittest-and-coverage.yml @@ -1,6 +1,14 @@ name: Unit tests and Coverage Report on: + push: + branches: + - main + - develop/** + pull_request: + branches: + - main + - develop/** workflow_dispatch: permissions: