Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove node and husky and add commitizen #24

Merged
merged 2 commits into from
Feb 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions .github/workflows/semantic-release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,12 @@ jobs:
uses: actions/setup-node@v4
with:
node-version: '23'
cache: npm

- name: Disable Husky
run: |
echo "HUSKY=0" >> "${GITHUB_ENV}"

- name: Install dependencies
run: npm ci
- name: Install semantic-release
run: yarn add semantic-release

- name: Run Semantic Release
env:
HUSKY: 0 # Ensure Husky is disabled
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: npx semantic-release
...
146 changes: 3 additions & 143 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,150 +1,10 @@
# Created by https://www.toptal.com/developers/gitignore/api/visualstudiocode,helm,node
# Edit at https://www.toptal.com/developers/gitignore?templates=visualstudiocode,helm,node
# Created by https://www.toptal.com/developers/gitignore/api/helm,visualstudiocode
# Edit at https://www.toptal.com/developers/gitignore?templates=helm,visualstudiocode

### Helm ###
# Chart dependencies
**/charts/*.tgz

### Node ###
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# vuepress v2.x temp and cache directory
.temp

# Docusaurus cache and generated files
.docusaurus

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

### Node Patch ###
# Serverless Webpack directories
.webpack/

# Optional stylelint cache

# SvelteKit build / generate output
.svelte-kit

### VisualStudioCode ###
.vscode/*
!.vscode/settings.json
Expand All @@ -164,4 +24,4 @@ dist
.history
.ionide

# End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,helm,node
# End of https://www.toptal.com/developers/gitignore/api/helm,visualstudiocode
5 changes: 0 additions & 5 deletions .husky/commit-msg

This file was deleted.

3 changes: 0 additions & 3 deletions .husky/pre-commit

This file was deleted.

7 changes: 7 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
---
repos:
- repo: local
hooks:
- id: commitizen
name: commitizen-check
entry: cz check --commit-msg-file
language: system
stages: [commit-msg]
- repo: "https://github.com/pre-commit/pre-commit-hooks"
rev: "v5.0.0"
hooks:
Expand Down
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,29 @@ helm install <my-release> web3-helm-charts/<chart-name>

Replace `<chart-name>` with the name of the chart you want to deploy.

## Commitizen

To ensure consistent commit messages, we use Commitizen.
Please follow these steps to set it up:

1. Install Commitizen globally:

```bash
pip3 install commitizen --break-system-packages
```

2. Install the required dependencies:

```bash
git config --unset-all core.hooksPath
```

3. Install the pre-commit hooks:

```bash
pre-commit install --hook-type commit-msg
```

## Contributing

We welcome contributions! Please follow these steps to contribute:
Expand Down
Loading