From 2b3348410ac1435ca879c0dd21dcc5da6cad6ba6 Mon Sep 17 00:00:00 2001 From: simon Date: Wed, 18 Nov 2020 00:19:34 +0100 Subject: [PATCH] docs: add default commitlints and adapt instructions --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3ac1e3cb9..102a24e27 100644 --- a/README.md +++ b/README.md @@ -37,12 +37,22 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v1 - - name: Install Dependencies - run: npm install @commitlint/config-conventional - uses: JulienKode/pull-request-name-linter-action@v0.2.0 ``` -**Note**: make sure you install your dependencies that commitlint use +## About `extends` in your config file + +(copied from https://github.com/wagoid/commitlint-github-action/blob/master/README.md ;-), as this also applies to this action. thanks!) +This is a [`Docker` action](https://github.com/actions/toolkit/blob/e2adf403d6d14a9ca7474976ccaca20f72ff8209/docs/action-types.md#why-would-i-choose-a-docker-action), and was made like this so that you can run it with minimum setup, regardless of your repo's environment. It comes packed with the most famous shared configurations that you can use in your commitlint config's `extends` field: + +- [@commitlint/config-angular](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-angular) +- [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) +- [@commitlint/config-lerna-scopes](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-lerna-scopes) +- [@commitlint/config-patternplate](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-patternplate) +- [conventional-changelog-lint-config-canonical](https://github.com/gajus/conventional-changelog-lint-config-canonical) +- [commitlint-config-jira](https://github.com/Gherciu/commitlint-jira) + +Apart from the shared configurations that are included by default, you can also include extra dependencies for other configs and plugins that you want to use. ## Example