Skip to content

Commit 74f3ef1

Browse files
committed
feat: add probot app and notification workflows
1 parent ba8566e commit 74f3ef1

36 files changed

+169
-106
lines changed

.github/future-release-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ Report issues or suggest features on our [GitHub Issues page](https://github.com
1616

1717
For a complete list of changes, see the [Changelog](https://github.com/BerryBytes/precommit-util/blob/main/CHANGELOG.md).
1818

19-
Thank you for using `Precommit Util`!
19+
Thank you for using `Precommit Util`!

.github/initial-release-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ This is our first release, and we’d love your input! Report issues or suggest
3939

4040
For a complete list of changes, see the [Changelog](https://github.com/berrybytes/Precommit Util/blob/main/CHANGELOG.md).
4141

42-
Thank you for using `Precommit Util`!
42+
Thank you for using `Precommit Util`!

.github/scripts/generate-changelog.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,4 +197,4 @@ if [[ "$*" == *"--notes-only"* ]]; then
197197
exit 0
198198
fi
199199

200-
main "$@"
200+
main "$@"

.github/workflows/releaser.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ on:
44
push:
55
branches:
66
- main
7-
7+
88
workflow_dispatch:
99

1010
concurrency:
@@ -24,15 +24,15 @@ jobs:
2424
uses: actions/checkout@v4
2525
with:
2626
fetch-depth: 0
27-
fetch-tags: true
27+
fetch-tags: true
2828

2929
- name: Install GitHub CLI
3030
run: |
3131
sudo apt-get update
3232
sudo apt-get install -y gh
3333
3434
- name: Install dependencies
35-
run: |
35+
run: |
3636
npm install --global prettier@3.5.3
3737
npm install --global semver
3838

.github/workflows/sync-precommit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020

2121
steps:
2222
- name: Checkout repository
23-
uses: actions/checkout@v4
23+
uses: actions/checkout@v4
2424
with:
2525
fetch-depth: 0
2626
persist-credentials: true

.pre-commit-config.yaml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
repos:
2+
# ==========================================
3+
# Pre-commit default hooks
4+
# ==========================================
5+
- repo: https://github.com/pre-commit/pre-commit-hooks
6+
rev: v4.4.0
7+
hooks:
8+
- id: check-yaml
9+
- id: end-of-file-fixer
10+
- id: trailing-whitespace
11+
- id: check-added-large-files
12+
- id: check-vcs-permalinks
13+
- id: check-symlinks
14+
- id: destroyed-symlinks
15+
- id: pretty-format-json
16+
17+
# ==========================================
18+
# Codespell
19+
# ==========================================
20+
- repo: https://github.com/codespell-project/codespell
21+
rev: v2.2.5
22+
hooks:
23+
- id: codespell
24+
files: ^.*\.(py|c|h|md|rst|yml|go|sh|sql|tf|yaml)$
25+
args: ["--ignore-words-list", "hist,nd,bu,gir,maks"]
26+
27+
# ==========================================
28+
# Gitleaks
29+
# ==========================================
30+
- repo: https://github.com/gitleaks/gitleaks
31+
rev: v8.21.0
32+
hooks:
33+
- id: gitleaks
34+
args: ["detect", "--verbose"]
35+
36+
# ==========================================
37+
# FIXED STYLELINT HOOK (No nodeenv)
38+
# ==========================================
39+
- repo: local
40+
hooks:
41+
- id: stylelint
42+
name: stylelint
43+
entry: npx stylelint --fix
44+
language: system
45+
types: [css, scss]
46+
exclude: "node_modules/|dist/|build/"

.prettierrc

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"singleQuote": true,
3+
"trailingComma": "es5",
4+
"tabWidth": 2,
5+
"semi": true,
6+
"printWidth": 100,
7+
"overrides": [
8+
{
9+
"files": "*.html",
10+
"options": {
11+
"parser": "html"
12+
}
13+
},
14+
{
15+
"files": "*.css",
16+
"options": {
17+
"parser": "css"
18+
}
19+
}
20+
],
21+
"ignore": ["node_modules"]
22+
}

.stylelintrc.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"extends": "stylelint-config-standard",
3+
"rules": {
4+
"color-hex-length": "short",
5+
"no-duplicate-selectors": true,
6+
"selector-max-id": 0,
7+
"selector-no-qualifying-type": true
8+
}
9+
}

CONTRIBUTING.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,29 +10,27 @@ Explore these resources to make your contribution effective and aligned with the
1010

1111
### 📥 **Submitting Pull Requests**
1212

13-
Follow the step-by-step guide to submit pull requests:
13+
Follow the step-by-step guide to submit pull requests:
1414
[**Submitting Pull Requests Guide**](docs/content/contributing/submitting-pull-requests.md)
1515

1616
### 🐛 **Submitting Issues**
1717

18-
Learn how to report bugs, propose features, or provide feedback:
18+
Learn how to report bugs, propose features, or provide feedback:
1919
[**Submitting Issues Guide**](docs/content/contributing/submitting-issues.md)
2020

2121
### 🔒 **Submitting Security Issues**
2222

23-
Help us keep Pre-commit Automation Tools secure by reporting vulnerabilities responsibly:
23+
Help us keep Pre-commit Automation Tools secure by reporting vulnerabilities responsibly:
2424
[**Submitting Security Issues Guide**](docs/content/contributing/submitting-security-issues.md)
2525

2626

2727
## **Interested in Becoming a Maintainer?**
2828

29-
If you’re passionate about Pre-commit Automation Tools and want to take a more active role, check out the:
29+
If you’re passionate about Pre-commit Automation Tools and want to take a more active role, check out the:
3030
[**Maintainers Guidelines**](docs/content/contributing/maintainers-guidelines.md)
3131

3232
---
3333

3434
### **Together, We Build Better**
3535

3636
Your contributions help make Pre-commit Automation Tool a robust and thriving project.
37-
38-

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ A comprehensive suite of Git hooks and development environment setup tools that
1414

1515

1616

17-
## Overview
17+
## Overview
1818
This toolkit provides automated setup and enforcement of development best practices through:
1919

2020
- Code formatting and linting
@@ -27,18 +27,18 @@ This toolkit provides automated setup and enforcement of development best practi
2727
- **MacOS:** Above Mac OS X 10.7 Lion
2828

2929
## Prerequisites
30-
- ```sudo``` may be required depending on your system configuration
30+
- ```sudo``` may be required depending on your system configuration
3131
- git (version control)
3232
## Installation Tools
3333
The following tools will be automatically installed during setup:
3434

3535
- asdf (version manager)
36-
- Node.js
37-
- python
36+
- Node.js
37+
- python
3838
- typescript
3939
- black 23.9.1
4040
- Golang
41-
- terraform
41+
- terraform
4242
- tflint 0.39.2
4343
- tfsec 1.28.1
4444
- terraform-docs 0.16.0
@@ -66,19 +66,19 @@ chmod +x precommit-startup.sh
6666
```
6767
4. Choose the pre-commit hooks you want to install:
6868
```
69-
[1] Global pre-commit hooks
69+
[1] Global pre-commit hooks
7070
[2] Golang pre-commit hooks
7171
[3] Python pre-commit hooks
7272
[4] Terraform pre-commit hooks
7373
[5] TypeScript pre-commit hooks
7474
[6] Exit
7575
```
7676
5. Ensure that you provide the correct version of [nodejs/golang/python/terraform] instead of "latest" before proceeding.
77-
6. After installation, the githooks template will be set up globally for all repositories.
77+
6. After installation, the githooks template will be set up globally for all repositories.
7878

79-
7. Note that the setup is only required for new repositories. Existing repositories will not automatically adopt these hooks. To set up the hooks for an existing repository:
79+
7. Note that the setup is only required for new repositories. Existing repositories will not automatically adopt these hooks. To set up the hooks for an existing repository:
8080
- You will need to manually reinitialize the repository with `git init` to apply the template.
81-
81+
8282
OR
8383

8484
- Clone the existing repository to your local machine again to adopt the hooks automatically.
@@ -89,7 +89,7 @@ chmod +x precommit-startup.sh
8989

9090
## Skipping Pre-commit Hooks
9191

92-
To ignore specific pre-commit hooks for a specific file, you can modify the .pre-commit-config.yaml file by adding an `exclude` pattern under the specific hook configuration.
92+
To ignore specific pre-commit hooks for a specific file, you can modify the .pre-commit-config.yaml file by adding an `exclude` pattern under the specific hook configuration.
9393

9494
For example, to exclude the main.yaml file from the check-yaml hook, add the following line to the .pre-commit-config.yaml file:
9595

@@ -103,11 +103,11 @@ repos:
103103
- id: check-yaml
104104
exclude: ^main\.yaml$
105105
```
106-
106+
107107

108108

109109
b. Exclude multiple files (main.yaml and config.yaml are excluded)
110-
110+
111111
```
112112
repos:
113113
- repo: https://github.com/pre-commit/pre-commit-hooks
@@ -142,11 +142,11 @@ repos:
142142

143143
## Maintainers
144144

145-
We embrace an open and inclusive community philosophy. Motivated contributors are encouraged to join the [maintainers' team](docs/content/contributing/maintainers.md).
145+
We embrace an open and inclusive community philosophy. Motivated contributors are encouraged to join the [maintainers' team](docs/content/contributing/maintainers.md).
146146
Learn more about pull request reviews and issue triaging in our [maintainers guide](docs/content/contributing/maintainers-guidelines.md).
147147

148148
## Contributing
149-
Interested in contributing? Refer to our [contributing documentation](CONTRIBUTING.md).
149+
Interested in contributing? Refer to our [contributing documentation](CONTRIBUTING.md).
150150
This project adheres to a [Code of Conduct](CODE_OF_CONDUCT.md), and participation requires compliance with its terms.
151151

152152
---

0 commit comments

Comments
 (0)