diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 3e75479..29affe2 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,5 +1,7 @@ # Contributing +[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org) + Thank you for investing your time in contributing to this project. If you are new to contributing to open source projects, the following resources may be helpful: - [Set up Git](https://docs.github.com/en/get-started/git-basics/set-up-git) @@ -44,5 +46,5 @@ The release process has been automated using [Python Semantic Release](https://p It is recommended to have `pre-commit` installed on your local end before pushing commits. Please make sure you already [Set Up a Development Environment](#setting-up-a-development-environment) before running the following command: ```shell -pre-commit install +poetry run pre-commit install ``` diff --git a/.github/workflows/continuous-delivery.yml b/.github/workflows/continuous-delivery.yml index cc1ff94..692720f 100644 --- a/.github/workflows/continuous-delivery.yml +++ b/.github/workflows/continuous-delivery.yml @@ -44,7 +44,7 @@ jobs: - name: Setup | Install Commitlint if: github.event_name == 'pull_request' run: | - pip install commitlint + pip install commitlint==1.13.3 - name: Evaluate | Validate PR Title if: github.event_name == 'pull_request' @@ -52,9 +52,10 @@ jobs: commitlint "${{ github.event.pull_request.title }}" - name: Action | Validate Commit Messages - uses: opensource-nepal/commitlint@v1.3.1 + uses: opensource-nepal/commitlint@v1.13.3 release: + if: github.event_name == 'push' runs-on: ubuntu-latest needs: linting concurrency: diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 5c7954f..8a2bdcc 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,5 +1,5 @@ repos: - repo: https://github.com/opensource-nepal/commitlint - rev: v1.3.0 + rev: v1.13.3 hooks: - id: commitlint diff --git a/README.md b/README.md index 2c01c7d..e45328e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Smarty Notebook +[![Continuous Delivery](https://github.com/SiegeSailor/Smarty-Notebook/actions/workflows/continuous-delivery.yml/badge.svg)](https://github.com/SiegeSailor/Smarty-Notebook/actions/workflows/continuous-delivery.yml) + This repository contains Jupyter Notebooks that use the [Smarty Cloud API](https://www.smarty.com/docs/cloud) for various common tasks. Each notebook is designed to be self-contained and easy to use: - [x] Fetch U.S. ZIP+4 Code by Address @@ -30,7 +32,7 @@ Follow the steps below to set up your local environment for development. > eval "$(pyenv init - zsh)" > # ===> Poetry > fpath+=~/.zfunc -> export PATH="/Users/user/.local/bin:$PATH" +> export PATH="$HOME/.local/bin:$PATH" > # ===> Auto Completion > autoload -Uz compinit && compinit > ``` diff --git a/poetry.lock b/poetry.lock index 613af9c..848fa7d 100644 --- a/poetry.lock +++ b/poetry.lock @@ -215,14 +215,14 @@ files = [ [[package]] name = "commitlint" -version = "1.3.1" +version = "1.13.3" description = "commitlint is a pre-commit hook designed to lint your commit messages according to the Conventional Commits standard." optional = false python-versions = ">=3.10" groups = ["dev", "lint"] files = [ - {file = "commitlint-1.3.1-py3-none-any.whl", hash = "sha256:02024a64a785c7b5f2c6accb33415efb61d428b90e0231480ac49b8b07624520"}, - {file = "commitlint-1.3.1.tar.gz", hash = "sha256:2a0123636bd12cb47f96034af0711d302403e80e47bac815f26c495420929d53"}, + {file = "commitlint-1.13.3-py3-none-any.whl", hash = "sha256:330a9aa892b0bca9d671c5cd059755d9d48468f35095efe1be09ba667085b3f7"}, + {file = "commitlint-1.13.3.tar.gz", hash = "sha256:e92522e064010ae85b825b73923760c0e4ff34954859fec4976f3e86a342ea30"}, ] [[package]]