Skip to content

Commit

Permalink
ci: add format check on repository root
Browse files Browse the repository at this point in the history
  • Loading branch information
marcalexiei committed Nov 17, 2024
1 parent 253e0a8 commit 3e276b6
Show file tree
Hide file tree
Showing 11 changed files with 74 additions and 51 deletions.
28 changes: 14 additions & 14 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,51 +34,51 @@ body:
required: false
- type: input
id: tuono-version
attributes:
attributes:
label: Tuono version
placeholder: "[e.g. 0.4.0]"
placeholder: '[e.g. 0.4.0]'
validations:
required: false
- type: input
id: os-version
attributes:
attributes:
label: OS
placeholder: "[e.g. MacOS, Windows]"
placeholder: '[e.g. MacOS, Windows]'
validations:
required: false
- type: input
id: browser-version
attributes:
attributes:
label: Browser
placeholder: "[e.g. chrome, safari]"
placeholder: '[e.g. chrome, safari]'
validations:
required: false
- type: input
id: node-version
attributes:
attributes:
label: Node version
placeholder: "[e.g. 20.0.0]"
placeholder: '[e.g. 20.0.0]'
validations:
required: false
- type: input
id: rust-version
attributes:
attributes:
label: Rust version
placeholder: "[e.g. 1.79.0]"
placeholder: '[e.g. 1.79.0]'
validations:
required: false
- type: input
id: create-version
attributes:
attributes:
label: Crate version
placeholder: "[e.g. 1.78.0]"
placeholder: '[e.g. 1.78.0]'
validations:
required: false
- type: input
id: node-package-manager-version
attributes:
attributes:
label: Node Package Manger version
placeholder: "[e.g. pnpm: 9.5.0] "
placeholder: '[e.g. pnpm: 9.5.0] '
validations:
required: false
- type: textarea
Expand Down
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,3 @@ body:
description: Add any other context or screenshots about the feature request here.
validations:
required: false

2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Context & Description

<!--
Thank you for your Pull Request.
Thank you for your Pull Request.
Explain the context and why you're making that change. What is the problem
you're trying to solve? If a new feature is being added, describe the intended
Expand Down
31 changes: 31 additions & 0 deletions .github/workflows/repo-root-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Repo root CI
# All workflows are triggered based on specific paths,
# the root repository is something that is not applicable to rust nor typescript
# so it has been moved in a standalone workflow

on:
push:
paths:
- '.github/**'
- './*'
pull_request:
paths:
- '.github/**'
- './*'

jobs:
build-and-test:
if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name
name: Check format
timeout-minutes: 15
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Install NodeJS Dependencies
uses: ./.github/actions/install-node-dependencies

- name: Test project
run: pnpm repo:root:format
1 change: 1 addition & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"$schema": "https://json.schemastore.org/prettierrc",
"semi": false,
"singleQuote": true,
"trailingComma": "all"
Expand Down
22 changes: 11 additions & 11 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best, not just for us as individuals, but for the
- Focusing on what is best, not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
- The use of sexualized language or imagery, and sexual attention or
Advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct that could reasonably be considered inappropriate in a
- Other conduct that could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities
Expand Down Expand Up @@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
Expand Down
5 changes: 4 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,21 @@

# How to Contribute to Tuono

## Contributions
## Contributions

Any feature contribution or suggestion is strongly appreciated.
Since the current project size, there isn't yet a defined way to start a discussion. Consider [opening a new issue](https://github.com/Valerioageno/tuono/issues/new/choose)
or to reach me using my email address, [[email protected]](mailto:[email protected]). I'm also available on Twitter (X); DM @valerioageno.

## Bugs

**Did you find a bug?**

- Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/Valerioageno/tuono/issues).
- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/Valerioageno/tuono/issues/new/choose). Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

**Did you write a patch that fixes a bug?**

- Open a new GitHub pull request with the patch.
- Ensure the PR description clearly describes the problem and solution. Include the relevant issue number, if applicable.
- The pull requests must pass all the CI pipelines
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"docs:format": "turbo format --filter=documentation",
"docs:format:check": "turbo format:check --filter=documentation",
"docs:types": "turbo types --filter=documentation",
"repo:root:format": "prettier ./*.{json,md} ./.github/** --write",
"check-all": "turbo build lint format:check types"
},
"author": "Valerio Ageno",
Expand Down
4 changes: 1 addition & 3 deletions renovate.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"config:recommended"
],
"extends": ["config:recommended"],
"ignorePaths": ["**/benches/**"]
}
2 changes: 1 addition & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"resolveJsonModule": true,
"skipLibCheck": true,
"strict": true,
"target": "ES2020",
"target": "ES2020"
},
"include": [".eslintrc.cjs", "prettier.config.js"],
"exclude": ["node_modules"]
Expand Down
28 changes: 9 additions & 19 deletions turbo.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,21 @@
"$schema": "https://turbo.build/schema.json",
"tasks": {
"lint": {
"dependsOn": [
"^build"
]
},
"dependsOn": ["^build"]
},
"format": {},
"format:check": {},
"types": {
"dependsOn": [
"^build"
]
},
"format:check": {},
"types": {
"dependsOn": ["^build"]
},
"test": {},
"test:watch": {},
"build": {
"outputs": [
"dist/**"
],
"dependsOn": [
"^build"
]
"outputs": ["dist/**"],
"dependsOn": ["^build"]
},
"dev": {
"dependsOn": [
"^build"
]
"dependsOn": ["^build"]
}
}
}

0 comments on commit 3e276b6

Please sign in to comment.