From c59d4e15ffe552276892a8f6c67f4b86d48f9eca Mon Sep 17 00:00:00 2001 From: Tomas Sebestik Date: Wed, 28 Jun 2023 13:41:49 +0200 Subject: [PATCH] docs(contributor_guide): Update install pre-commit instructions --- .gitlab/dangerjs/aiGenerateGitMessage.js | 10 ++++++---- .gitlab/dangerjs/mrCommitsCommitMessage.js | 11 +++++++---- .pre-commit-config.yaml | 2 +- docs/en/contribute/install-pre-commit-hook.rst | 2 +- 4 files changed, 15 insertions(+), 10 deletions(-) diff --git a/.gitlab/dangerjs/aiGenerateGitMessage.js b/.gitlab/dangerjs/aiGenerateGitMessage.js index 1335f7ec70..1ce39d0351 100644 --- a/.gitlab/dangerjs/aiGenerateGitMessage.js +++ b/.gitlab/dangerjs/aiGenerateGitMessage.js @@ -1,7 +1,9 @@ -const { minimumSummaryChars } = require("./mrCommitsConstants.js"); -const { maximumSummaryChars } = require("./mrCommitsConstants.js"); -const { maximumBodyLineChars } = require("./mrCommitsConstants.js"); -const { allowedTypes } = require("./mrCommitsConstants.js"); +const { + minimumSummaryChars, + maximumSummaryChars, + maximumBodyLineChars, + allowedTypes, +} = require("./mrCommitsConstants.js"); const { gptStandardModelTokens } = require("./mrCommitsConstants.js"); const { ChatPromptTemplate } = require("langchain/prompts"); diff --git a/.gitlab/dangerjs/mrCommitsCommitMessage.js b/.gitlab/dangerjs/mrCommitsCommitMessage.js index a8aee53fb5..ac87b32c69 100644 --- a/.gitlab/dangerjs/mrCommitsCommitMessage.js +++ b/.gitlab/dangerjs/mrCommitsCommitMessage.js @@ -1,7 +1,9 @@ -const { minimumSummaryChars } = require("./mrCommitsConstants.js"); -const { maximumSummaryChars } = require("./mrCommitsConstants.js"); -const { maximumBodyLineChars } = require("./mrCommitsConstants.js"); -const { allowedTypes } = require("./mrCommitsConstants.js"); +const { + minimumSummaryChars, + maximumSummaryChars, + maximumBodyLineChars, + allowedTypes, +} = require("./mrCommitsConstants.js"); /** * Check that commit messages are based on the Espressif ESP-IDF project's rules for git commit messages. @@ -141,6 +143,7 @@ module.exports = async function () { \n**Please consider updating these commit messages** - here are some basic tips:\n${basicTips.join( "\n" )} + \n \`TIP:\` You can install commit-msg pre-commit hook (\`pre-commit install -t pre-commit -t commit-msg\`) to run this check when committing. \n*** `; diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 88dd63d604..0923d3d93c 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -169,7 +169,7 @@ repos: - id: check-copyright args: ['--ignore', 'tools/ci/check_copyright_ignore.txt', '--config', 'tools/ci/check_copyright_config.yaml'] - repo: https://github.com/espressif/conventional-precommit-linter - rev: v1.1.0 + rev: v1.2.0 hooks: - id: conventional-precommit-linter stages: [commit-msg] diff --git a/docs/en/contribute/install-pre-commit-hook.rst b/docs/en/contribute/install-pre-commit-hook.rst index 27e4e730d9..196bfcce35 100644 --- a/docs/en/contribute/install-pre-commit-hook.rst +++ b/docs/en/contribute/install-pre-commit-hook.rst @@ -18,7 +18,7 @@ Install pre-commit hook 1. Go to the IDF Project Directory -2. Run ``pre-commit install --allow-missing-config``. Install hook by this approach will let you commit successfully even in branches without the ``.pre-commit-config.yaml`` +2. Run ``pre-commit install --allow-missing-config -t pre-commit -t commit-msg``. Install hook by this approach will let you commit successfully even in branches without the ``.pre-commit-config.yaml`` 3. pre-commit hook will run automatically when you're running ``git commit`` command