summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoris Roovers <joris.roovers@gmail.com>2023-05-10 11:35:24 +0200
committerGitHub <noreply@github.com>2023-05-10 11:35:24 +0200
commitff0fbae8745a7fe52592eec14fc2ce70d3914bd1 (patch)
tree270bc1e213c6193e8ddc1a1534b43b4dae3d220d
parenta19e7d88c3edb145c56af983bdc64be38b36511f (diff)
Update all URLs to point to new docs (#493)
- Replace old URLs with new doc URLs in code, README, CHANGELOG. Critical old URLs, for example those printed by gitlint itself in the past, will keep working and redirect to the new URL. - Ensure all links are https (no http) - Fix incorrect top-level doc URL path for user defined rules (rename getting_started.md to index.md). - Replace few accidental uses of jorisroovers.com/gitlint with jorisroovers.github.io/gitlint - Re-enable strict mode in mkdocs
-rw-r--r--.github/ISSUE_TEMPLATE/issue-template.md2
-rw-r--r--.gitlint2
-rw-r--r--CHANGELOG.md76
-rw-r--r--CONTRIBUTING.md2
-rw-r--r--README.md8
-rw-r--r--docs/configuration/cli.md2
-rw-r--r--docs/configuration/general_options.md2
-rw-r--r--docs/configuration/gitlint_file.md4
-rw-r--r--docs/contributing/contrib_rules.md2
-rw-r--r--docs/demos/scenario.txt2
-rw-r--r--docs/index.md2
-rw-r--r--docs/javascript/extra.js10
-rw-r--r--docs/rules/contrib_rules.md2
-rw-r--r--docs/rules/index.md2
-rw-r--r--docs/rules/named_rules.md2
-rw-r--r--docs/rules/user_defined_rules/index.md (renamed from docs/rules/user_defined_rules/getting_started.md)0
-rw-r--r--examples/gitlint4
-rw-r--r--examples/my_commit_rules.py2
-rw-r--r--examples/my_configuration_rules.py2
-rw-r--r--examples/my_line_rules.py2
-rw-r--r--gitlint-core/README.md8
-rw-r--r--gitlint-core/gitlint/cli.py2
-rw-r--r--gitlint-core/gitlint/deprecation.py2
-rw-r--r--gitlint-core/gitlint/files/gitlint7
-rw-r--r--gitlint-core/gitlint/rules.py2
-rw-r--r--gitlint-core/gitlint/tests/base.py2
-rw-r--r--gitlint-core/gitlint/tests/rules/test_configuration_rules.py2
-rw-r--r--mkdocs.yml8
-rw-r--r--qa/expected/test_commits/test_ignore_commits_14
29 files changed, 87 insertions, 80 deletions
diff --git a/.github/ISSUE_TEMPLATE/issue-template.md b/.github/ISSUE_TEMPLATE/issue-template.md
index c178614..d2ddab8 100644
--- a/.github/ISSUE_TEMPLATE/issue-template.md
+++ b/.github/ISSUE_TEMPLATE/issue-template.md
@@ -15,7 +15,7 @@ A few quick notes:
- If you can, please include the output of `gitlint --debug` as this includes useful debugging info.
- It's really just me (https://github.com/jorisroovers) maintaining gitlint, and I do so in a hobby capacity. More recently it has become harder for me to find time to maintain gitlint on a regular basis, which in practice means that it might take me a while (sometimes months) to get back to you. Rest assured though, I absolutely read all bug reports as soon as they come in - I just tend to only "work" on gitlint a few times a year.
-- If you're looking to contribute code to gitlint, please start here: http://jorisroovers.github.io/gitlint/contributing/
+- If you're looking to contribute code to gitlint, please start here: https://jorisroovers.github.io/gitlint/contributing/
-->
diff --git a/.gitlint b/.gitlint
index 011b0a3..1a4bb24 100644
--- a/.gitlint
+++ b/.gitlint
@@ -1,5 +1,5 @@
[general]
-# See https://jorisroovers.com/gitlint/configuration/#regex-style-search
+# https://jorisroovers.github.io/gitlint/configuration/general_options/#regex-style-search
regex-style-search=True
# Dependabot tends to generate lines that exceed the default 80 char limit.
diff --git a/CHANGELOG.md b/CHANGELOG.md
index f26f670..09ec650 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -29,9 +29,9 @@ This release was primarily focussed on modernizing gitlint's build and test tool
## Development
- Adopted [hatch](https://hatch.pypa.io/latest/) for project management ([#384](https://github.com/jorisroovers/gitlint/issues/384)).
- This significantly improves the developer workflow, please read the updated [CONTRIBUTING](https://jorisroovers.com/gitlint/contributing/) page.
+ This significantly improves the developer workflow, please read the updated [CONTRIBUTING](https://jorisroovers.github.io/gitlint/contributing/) page.
- Adopted [ruff](https://github.com/charliermarsh/ruff) for linting, replacing pylint ([#404](https://github.com/jorisroovers/gitlint/issues/404))
- - Gitlint now publishes [dev builds on every commit to main](https://jorisroovers.github.io/gitlint/contributing/#dev-builds) ([#429](https://github.com/jorisroovers/gitlint/issues/429))
+ - Gitlint now publishes [dev builds on every commit to main](https://jorisroovers.github.io/gitlint/contributing/releases/#dev-builds) ([#429](https://github.com/jorisroovers/gitlint/issues/429))
- Gitlint now publishes a [`latest_dev` docker image](https://hub.docker.com/r/jorisroovers/gitlint/tags?name=latest_dev) on every commit to main ([#451](https://github.com/jorisroovers/gitlint/issues/452)) ([#452](https://github.com/jorisroovers/gitlint/issues/451))
- Dependencies updated
- Many improvements to the [CI/CD worfklows](https://github.com/jorisroovers/gitlint/tree/main/.github/workflows)
@@ -53,18 +53,18 @@ Special thanks to all contributors for this release - details inline!
## General
- Python 3.11 support
- Last release to support Python 3.6 ([EOL since 2021-12-23](https://endoflife.date/python))
-- **Behavior Change**: In a future release, gitlint will be switching to use `re.search` instead of `re.match` semantics for all rules. Your rule regexes might need updating as a result, gitlint will print a warning if so. [More details are in the docs](https://jorisroovers.com/gitlint/configuration/#regex-style-search). ([#254](https://github.com/jorisroovers/gitlint/issues/254))
+- **Behavior Change**: In a future release, gitlint will be switching to use `re.search` instead of `re.match` semantics for all rules. Your rule regexes might need updating as a result, gitlint will print a warning if so. [More details are in the docs](https://jorisroovers.github.io/gitlint/configuration/#regex-style-search). ([#254](https://github.com/jorisroovers/gitlint/issues/254))
- gitlint no longer uses the [sh](https://amoffat.github.io/sh/) library by default in an attempt to reduce external dependencies. In case of issues, the use of `sh` can be re-enabled by setting the env var `GITLINT_USE_SH_LIB=1`. This fallback will be removed entirely in a future gitlint release. ([#351](https://github.com/jorisroovers/gitlint/issues/351))
## Features
- `--commits` now also accepts a comma-separated list of commit hashes, making it possible to lint a list of non-contiguous commits without invoking gitlint multiple times ([#283](https://github.com/jorisroovers/gitlint/issues/283))
- Improved handling of branches that have no commits ([#188](https://github.com/jorisroovers/gitlint/issues/189)) - thanks [domsekotill](https://github.com/domsekotill)
- Support for `GITLINT_CONFIG` env variable ([#189](https://github.com/jorisroovers/gitlint/issues/188)) - thanks [Notgnoshi](https://github.com/Notgnoshi)
-- Added [a new `gitlint-ci` pre-commit hook](https://jorisroovers.com/gitlint/#gitlint-and-pre-commit-in-ci), making it easier to run gitlint through pre-commit in CI ([#191](https://github.com/jorisroovers/gitlint/issues/191)) - thanks [guillaumelambert](https://github.com/guillaumelambert)
+- Added [a new `gitlint-ci` pre-commit hook](https://jorisroovers.github.io/gitlint/#gitlint-and-pre-commit-in-ci), making it easier to run gitlint through pre-commit in CI ([#191](https://github.com/jorisroovers/gitlint/issues/191)) - thanks [guillaumelambert](https://github.com/guillaumelambert)
## Contrib Rules
- - New [contrib-disallow-cleanup-commits](https://jorisroovers.com/gitlint/contrib_rules/#cc2-contrib-disallow-cleanup-commits) rule ([#312](https://github.com/jorisroovers/gitlint/issues/312)) - thanks [matthiasbeyer](https://github.com/matthiasbeyer)
- - New [contrib-allowed-authors](https://jorisroovers.com/gitlint/contrib_rules/#cc3-contrib-allowed-authors) rule ([#358](https://github.com/jorisroovers/gitlint/issues/358)) - thanks [stauchert](https://github.com/stauchert)
+ - New [contrib-disallow-cleanup-commits](https://jorisroovers.github.io/gitlint/contrib_rules/#cc2-contrib-disallow-cleanup-commits) rule ([#312](https://github.com/jorisroovers/gitlint/issues/312)) - thanks [matthiasbeyer](https://github.com/matthiasbeyer)
+ - New [contrib-allowed-authors](https://jorisroovers.github.io/gitlint/contrib_rules/#cc3-contrib-allowed-authors) rule ([#358](https://github.com/jorisroovers/gitlint/issues/358)) - thanks [stauchert](https://github.com/stauchert)
## User Defined rules
- Gitlint now recognizes `fixup=amend` commits (see related [git documentation](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---fixupamendrewordltcommitgt)), available as `commit.is_fixup_amend_commit=True`
@@ -103,14 +103,14 @@ Special thanks to all contributors for this release, in particular [sigmavirus24
## Features
- `--commit <ref>` flag to more easily lint a single commit message ([#141](https://github.com/jorisroovers/gitlint/issues/141))
-- `--fail-without-commits` flag will force gitlint to fail ([exit code 253](https://jorisroovers.com/gitlint/#exit-codes)) when the target commit range is empty (typically when using `--commits`) ([#193](https://github.com/jorisroovers/gitlint/issues/193))
+- `--fail-without-commits` flag will force gitlint to fail ([exit code 253](https://jorisroovers.github.io/gitlint/#exit-codes)) when the target commit range is empty (typically when using `--commits`) ([#193](https://github.com/jorisroovers/gitlint/issues/193))
## Rules
-- **New Rule**: [ignore-by-author-name](http://jorisroovers.github.io/gitlint/rules/#i4-ignore-by-author-name) allows users to skip linting commit messages made by specific authors
+- **New Rule**: [ignore-by-author-name](https://jorisroovers.github.io/gitlint/rules/builtin_rules/#i4-ignore-by-author-name) allows users to skip linting commit messages made by specific authors
## Bugfixes
- - [contrib-title-conventional-commits (CT1)](https://jorisroovers.com/gitlint/contrib_rules/#ct1-contrib-title-conventional-commits) now properly enforces the commit type ([#185](https://github.com/jorisroovers/gitlint/issues/185))
- - [contrib-title-conventional-commits (CT1)](https://jorisroovers.com/gitlint/contrib_rules/#ct1-contrib-title-conventional-commits) now supports the BREAKING CHANGE symbol "!" ([#186](https://github.com/jorisroovers/gitlint/issues/186))
+ - [contrib-title-conventional-commits (CT1)](https://jorisroovers.github.io/gitlint/contrib_rules/#ct1-contrib-title-conventional-commits) now properly enforces the commit type ([#185](https://github.com/jorisroovers/gitlint/issues/185))
+ - [contrib-title-conventional-commits (CT1)](https://jorisroovers.github.io/gitlint/contrib_rules/#ct1-contrib-title-conventional-commits) now supports the BREAKING CHANGE symbol "!" ([#186](https://github.com/jorisroovers/gitlint/issues/186))
## Development
- Dependencies updated
@@ -153,19 +153,19 @@ Special thanks to all contributors for this release, in particular [mrshu](https
## General
- **IMPORTANT: Gitlint 0.14.x will be the last gitlint release to support Python 2.7 and Python 3.5, as [both are EOL](https://endoflife.date/python) which makes it difficult to keep supporting them.**
- Python 3.9 support
-- [Named Rules](http://jorisroovers.github.io/gitlint/#named-rules) allow users to have multiple instances of the same rule active at the same time. This is useful when you want to enforce the same rule multiple times but with different options ([#113](https://github.com/jorisroovers/gitlint/issues/113), [#66](https://github.com/jorisroovers/gitlint/issues/66))
-- [User-defined Configuration Rules](http://jorisroovers.github.io/gitlint/user_defined_rules/#configuration-rules) allow users to dynamically change gitlint's configuration and/or the commit *before* any other rules are applied.
+- [Named Rules](https://jorisroovers.github.io/gitlint/rules/named_rules/) allow users to have multiple instances of the same rule active at the same time. This is useful when you want to enforce the same rule multiple times but with different options ([#113](https://github.com/jorisroovers/gitlint/issues/113), [#66](https://github.com/jorisroovers/gitlint/issues/66))
+- [User-defined Configuration Rules](https://jorisroovers.github.io/gitlint/rules/user_defined_rules/configuration_rules/) allow users to dynamically change gitlint's configuration and/or the commit *before* any other rules are applied.
- The `commit-msg` hook has been re-written in Python (it contained a lot of Bash before), fixing a number of platform specific issues. Existing users will need to reinstall their hooks (`gitlint uninstall-hook; gitlint install-hook`) to make use of this.
-- Most general options can now be set through environment variables (e.g. set the `general.ignore` option via `GITLINT_IGNORE=T1,T2`). The list of available environment variables can be found in the [configuration documentation](http://jorisroovers.github.io/gitlint/configuration).
+- Most general options can now be set through environment variables (e.g. set the `general.ignore` option via `GITLINT_IGNORE=T1,T2`). The list of available environment variables can be found in the [configuration documentation](https://jorisroovers.github.io/gitlint/configuration).
- Users can now use `self.log.debug("my message")` for debugging purposes in their user-defined rules. Debug messages will show up when running `gitlint --debug`.
-- **Breaking**: User-defined rule id's can no longer start with 'I', as those are reserved for [built-in gitlint ignore rules](http://jorisroovers.github.io/gitlint/rules/#i1-ignore-by-title).
-- New `RegexOption` rule [option type for use in user-defined rules](http://jorisroovers.github.io/gitlint/user_defined_rules/#options). By using the `RegexOption`, regular expressions are pre-validated at gitlint startup and compiled only once which is much more efficient when linting multiple commits.
+- **Breaking**: User-defined rule id's can no longer start with 'I', as those are reserved for [built-in gitlint ignore rules](https://jorisroovers.github.io/gitlint/rules/builtin_rules/#i1-ignore-by-title).
+- New `RegexOption` rule [option type for use in user-defined rules](https://jorisroovers.github.io/gitlint/rules/user_defined_rules/options/). By using the `RegexOption`, regular expressions are pre-validated at gitlint startup and compiled only once which is much more efficient when linting multiple commits.
## Rules
-- **New Rule**: [title-min-length](http://jorisroovers.github.io/gitlint/rules/#t8-title-min-length) enforces a minimum length on titles (default: 5 chars) ([#138](https://github.com/jorisroovers/gitlint/issues/138))
-- **New Rule**: [body-match-regex](http://jorisroovers.github.io/gitlint/rules/#b8-body-match-regex) allows users to enforce that the commit-msg body matches a given regex ([#130](https://github.com/jorisroovers/gitlint/issues/130))
-- **New Rule**: [ignore-body-lines](http://jorisroovers.github.io/gitlint/rules/#i3-ignore-body-lines) allows users to
-[ignore parts of a commit](http://jorisroovers.github.io/gitlint/gitlint/#ignoring-commits) by matching a regex against
+- **New Rule**: [title-min-length](https://jorisroovers.github.io/gitlint/rules/builtin_rules/#t8-title-min-length) enforces a minimum length on titles (default: 5 chars) ([#138](https://github.com/jorisroovers/gitlint/issues/138))
+- **New Rule**: [body-match-regex](https://jorisroovers.github.io/gitlint/rules/builtin_rules/#b8-body-match-regex) allows users to enforce that the commit-msg body matches a given regex ([#130](https://github.com/jorisroovers/gitlint/issues/130))
+- **New Rule**: [ignore-body-lines](https://jorisroovers.github.io/gitlint/rules/builtin_rules/#i3-ignore-body-lines) allows users to
+[ignore parts of a commit](https://jorisroovers.github.io/gitlint/ignoring_commits/) by matching a regex against
the lines in a commit message body ([#126](https://github.com/jorisroovers/gitlint/issues/126))
## Contrib Rules
@@ -203,7 +203,7 @@ the lines in a commit message body ([#126](https://github.com/jorisroovers/gitli
- **Behavior Change**: Revert Commits are now recognized and ignored by default ([#99](https://github.com/jorisroovers/gitlint/issues/99))
## Features
-- `--staged` flag: gitlint can now detect meta-data (such as author details, changed files, etc) of staged/pre-commits. Useful when you use [gitlint's commit-msg hook](https://jorisroovers.github.io/gitlint/#using-gitlint-as-a-commit-msg-hook) or [precommit](https://jorisroovers.github.io/gitlint/#using-gitlint-through-pre-commit) ([#105](https://github.com/jorisroovers/gitlint/issues/105))
+- `--staged` flag: gitlint can now detect meta-data (such as author details, changed files, etc) of staged/pre-commits. Useful when you use [gitlint's commit-msg hook](https://jorisroovers.github.io/gitlint/commit_hooks/) or [precommit](https://jorisroovers.github.io/gitlint/commit_hooks/#pre-commit) ([#105](https://github.com/jorisroovers/gitlint/issues/105))
- New branch properties on `GitCommit` and `GitContext`, useful when writing your own user-defined rules: `commit.branches` and `commit.context.current_branch` ([#108](https://github.com/jorisroovers/gitlint/issues/108))
## Bugfixes
@@ -229,13 +229,13 @@ Special thanks to all contributors for this release, in particular [@rogalksi](h
## Features
-- [Contrib Rules](http://jorisroovers.github.io/gitlint/contrib_rules): community-contributed rules that are disabled
+- [Contrib Rules](https://jorisroovers.github.io/gitlint/contrib_rules): community-contributed rules that are disabled
by default, but can be enabled through configuration. Contrib rules are meant to augment default gitlint behavior by
providing users with rules for common use-cases without forcing these rules on all gitlint users.
- - **New Contrib Rule**: `contrib-title-conventional-commits` enforces the [Conventional Commits](https://www.conventionalcommits.org) spec. Details in our [documentation](http://jorisroovers.github.io/gitlint/contrib_rules/#ct1-contrib-title-conventional-commits).
- - **New Contrib Rule**: `cc1-contrib-requires-signed-off-by` ensures that all commit messages contain a `Sign-Off-By` line. Details in our [documentation](http://jorisroovers.github.io/gitlint/contrib_rules/#cc1-contrib-requires-signed-off-by).
+ - **New Contrib Rule**: `contrib-title-conventional-commits` enforces the [Conventional Commits](https://www.conventionalcommits.org) spec. Details in our [documentation](https://jorisroovers.github.io/gitlint/contrib_rules/#ct1-contrib-title-conventional-commits).
+ - **New Contrib Rule**: `cc1-contrib-requires-signed-off-by` ensures that all commit messages contain a `Sign-Off-By` line. Details in our [documentation](https://jorisroovers.github.io/gitlint/rules/contrib_rules/#cc1-contrib-body-requires-signed-off-by).
- If you're interested in adding new Contrib rules to gitlint, please start by reading the
- [Contributing](http://jorisroovers.github.io/gitlint/contributing/) page. Thanks for considering!
+ [Contributing](https://jorisroovers.github.io/gitlint/contributing/) page. Thanks for considering!
- *Experimental (!)* Windows support: Basic functionality is working, but there are still caveats. For more details, please refer to [#20](https://github.com/jorisroovers/gitlint/issues/20) and the [open issues related to Windows](https://github.com/jorisroovers/gitlint/issues?q=is%3Aissue+is%3Aopen+label%3Awindows).
- Support for `--ignore-stdin` command-line flag to ignore any text send via stdin. ([#56](https://github.com/jorisroovers/gitlint/issues/56), [#89](https://github.com/jorisroovers/gitlint/issues/89))
@@ -272,7 +272,7 @@ Special thanks to [asottile](https://github.com/asottile), [bdrung](https://gith
## Features
- Gitlint now supports [pre-commit.com](https://pre-commit.com).
-[Details in our documentation](http://jorisroovers.github.io/gitlint/#using-gitlint-through-pre-commit)
+[Details in our documentation](https://jorisroovers.github.io/gitlint/commit_hooks/#gitlint-and-pre-commit-in-ci)
([#62](https://github.com/jorisroovers/gitlint/issues/62)).
- Gitlint now has a `--msg-filename` commandline flag that allows you to specify the commit message to lint via
a file ([#39](https://github.com/jorisroovers/gitlint/issues/39)).
@@ -283,10 +283,10 @@ Special thanks to [asottile](https://github.com/asottile), [bdrung](https://gith
## Rules
- **New Rule**: `ignore-by-title` allows users to
-[ignore certain commits](http://jorisroovers.github.io/gitlint/#ignoring-commits) by matching a regex against
+[ignore certain commits](https://jorisroovers.github.io/gitlint/ignoring_commits/) by matching a regex against
a commit message title. ([#54](https://github.com/jorisroovers/gitlint/issues/54), [#57](https://github.com/jorisroovers/gitlint/issues/57)).
- **New Rule**: `ignore-by-body` allows users to
-[ignore certain commits](http://jorisroovers.github.io/gitlint/#ignoring-commits) by matching a regex against
+[ignore certain commits](https://jorisroovers.github.io/gitlint/ignoring_commits/) by matching a regex against
a line in a commit message body.
## Bugfixes
@@ -312,7 +312,7 @@ and [AlexMooney](https://github.com/AlexMooney) for their contributions.
This fixes [#40](https://github.com/jorisroovers/gitlint/issues/40) and
[#42](https://github.com/jorisroovers/gitlint/issues/42).
- **Behavior Change**: Gitlint will now by default
- [ignore squash and fixup commits](http://jorisroovers.github.io/gitlint/#merge-fixup-and-squash-commits)
+ [ignore squash and fixup commits](https://jorisroovers.github.io/gitlint/ignoring_commits/#merge-fixup-squash-and-revert-commits)
(fix for [#33: fixup messages should not trigger a gitlint violation](https://github.com/jorisroovers/gitlint/issues/33))
## Features
@@ -322,7 +322,7 @@ and [AlexMooney](https://github.com/AlexMooney) for their contributions.
## Rules
- New Rule: `author-valid-email` enforces a valid author email address. Details can be found in the
- [Rules section of the documentation](http://jorisroovers.github.io/gitlint/rules/#m1-author-valid-email).
+ [Rules section of the documentation](https://jorisroovers.github.io/gitlint/rules/builtin_rules/#m1-author-valid-email).
## Bugfixes
- [#37: Prevent Commas in text fields from breaking git log printing](https://github.com/jorisroovers/gitlint/issues/37)
@@ -342,8 +342,10 @@ Thanks to [tommyip](https://github.com/tommyip) for implementing this!
be improved upon in later releases.
## Bugfixes
- - [#24: --commits doesn't take commit specific config into account](https://github.com/jorisroovers/gitlint/issues/24)
- - [#27: --commits returns the wrong exit code](https://github.com/jorisroovers/gitlint/issues/27)
+
+- [#24: --commits doesn't take commit specific config into account](https://github.com/jorisroovers/gitlint/issues/24)
+- [#27: --commits returns the wrong exit code](https://github.com/jorisroovers/gitlint/issues/27)
+
## Development
- Better unit and integration test coverage for `--commits`
@@ -359,7 +361,7 @@ The 0.8.1 release brings minor tweaks and some experimental features. Special th
## Features
- Experimental: Linting a range of commits.
- [Documentation](http://jorisroovers.github.io/gitlint/#linting-a-range-of-commits).
+ [Documentation](https://jorisroovers.github.io/gitlint/linting_specific_commits/).
Known Caveats: [#23](https://github.com/jorisroovers/gitlint/issues/23),
[#24](https://github.com/jorisroovers/gitlint/issues/24).
Closes [#14](https://github.com/jorisroovers/gitlint/issues/14). Thanks to [tommyip](https://github.com/tommyip)
@@ -379,7 +381,7 @@ The 0.8.0 release is a significant release that has been in the works for a long
## Features
- User-defined rules: you can now
- [define your own custom rules](http://jorisroovers.github.io/gitlint/user_defined_rules/)
+ [define your own custom rules](https://jorisroovers.github.io/gitlint/rules/user_defined_rules/)
if you want to extend gitlint's functionality.
- Debug output improvements: Gitlint will now print your active configuration when using `--debug`
- The `general.target` option can now also be set via `-c` flags or a `.gitlint` file
@@ -445,9 +447,9 @@ requests.
## General
- Python 3 (3.3+) support!
-- All documentation is now hosted on [http://jorisroovers.github.io/gitlint/]()
+- All documentation is now hosted on [https://jorisroovers.github.io/gitlint/]()
- **Breaking change**: exit code behavior has changed. More details in the
- [Exit codes section of the documentation](http://jorisroovers.github.io/gitlint/#exit-codes).
+ [Exit codes section of the documentation](https://jorisroovers.github.io/gitlint/exit_codes/).
- **Breaking change**: `--install-hook` and `--uninstall-hook` have been renamed to `install-hook` and
`uninstall-hook` respectively to better express that they are commands instead of options.
@@ -478,7 +480,7 @@ requests.
## Rules
- New Rule: `title-match-regex`. Details can be found in the
- [Rules section of the documentation](http://jorisroovers.github.io/gitlint/rules/).
+ [Rules section of the documentation](https://jorisroovers.github.io/gitlint/rules/).
# v0.4.1 (2015-09-19)
@@ -497,7 +499,7 @@ requests.
- New rules: `body-is-missing`, `body-min-length`, `title-leading-whitespace`,
`body-changed-file-mention`. Details can be found in the
- [Rules section of the documentation](http://jorisroovers.github.io/gitlint/rules/).
+ [Rules section of the documentation](https://jorisroovers.github.io/gitlint/rules/).
## Development
- Internal: rule classes now have access to a gitcontext containing body the commit message and the files changed in the
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 892ff53..ec9df50 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -2,5 +2,5 @@
Thanks for your interest in contributing to gitlint!
-Instructions on how to get started can be found on [http://jorisroovers.github.io/gitlint/contributing](http://jorisroovers.github.io/gitlint/contributing/).
+Instructions on how to get started can be found on [https://jorisroovers.github.io/gitlint/contributing](https://jorisroovers.github.io/gitlint/contributing/).
diff --git a/README.md b/README.md
index 05787be..909d9ca 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# gitlint: [jorisroovers.github.io/gitlint](http://jorisroovers.github.io/gitlint/) #
+# gitlint: [jorisroovers.github.io/gitlint](https://jorisroovers.github.io/gitlint/) #
[![Tests](https://github.com/jorisroovers/gitlint/workflows/Tests%20and%20Checks/badge.svg)](https://github.com/jorisroovers/gitlint/actions?query=workflow%3A%22Tests+and+Checks%22)
[![Coverage Status](https://coveralls.io/repos/github/jorisroovers/gitlint/badge.svg?branch=fix-coveralls)](https://coveralls.io/github/jorisroovers/gitlint?branch=fix-coveralls)
@@ -7,9 +7,9 @@
Git commit message linter written in python, checks your commit messages for style.
-**See [jorisroovers.github.io/gitlint](http://jorisroovers.github.io/gitlint/) for full documentation.**
+**See [jorisroovers.github.io/gitlint](https://jorisroovers.github.io/gitlint/) for full documentation.**
-<a href="http://jorisroovers.github.io/gitlint/" target="_blank">
+<a href="https://jorisroovers.github.io/gitlint/" target="_blank">
<img src="https://raw.githubusercontent.com/jorisroovers/gitlint/main/docs/images/readme-gitlint.png" />
</a>
@@ -18,7 +18,7 @@ All contributions are welcome and very much appreciated!
**I'm [looking for contributors](https://github.com/jorisroovers/gitlint/issues/134) that are interested in taking a more active co-maintainer role as it's becoming increasingly difficult for me to find time to maintain gitlint. Please leave a comment in [#134](https://github.com/jorisroovers/gitlint/issues/134) if you're interested!**
-See [jorisroovers.github.io/gitlint/contributing](http://jorisroovers.github.io/gitlint/contributing) for details on
+See [jorisroovers.github.io/gitlint/contributing](https://jorisroovers.github.io/gitlint/contributing) for details on
how to get started - it's easy!
We maintain a [loose project plan on Github Projects](https://github.com/users/jorisroovers/projects/1/views/1).
diff --git a/docs/configuration/cli.md b/docs/configuration/cli.md
index 349c106..2c5ab66 100644
--- a/docs/configuration/cli.md
+++ b/docs/configuration/cli.md
@@ -49,7 +49,7 @@ Usage: gitlint [OPTIONS] COMMAND [ARGS]...
Git lint tool, checks your git commit messages for styling issues
- Documentation: http://jorisroovers.github.io/gitlint
+ Documentation: https://jorisroovers.github.io/gitlint
Options:
--target DIRECTORY Path of the target git repository. [default:
diff --git a/docs/configuration/general_options.md b/docs/configuration/general_options.md
index f18f25a..e046499 100644
--- a/docs/configuration/general_options.md
+++ b/docs/configuration/general_options.md
@@ -253,7 +253,7 @@ Path where gitlint looks for a config file.
## extra-path
[:octicons-tag-24: v0.8.0][v0.8.0]
-Path where gitlint looks for [user-defined rules](../rules/user_defined_rules/getting_started.md).
+Path where gitlint looks for [user-defined rules](../rules/user_defined_rules/index.md).
| Default value | Type | CLI flag | Env var |
| ---------------------- | -------------- | -------------------- | -------------------- |
diff --git a/docs/configuration/gitlint_file.md b/docs/configuration/gitlint_file.md
index f1d3c55..00b2f75 100644
--- a/docs/configuration/gitlint_file.md
+++ b/docs/configuration/gitlint_file.md
@@ -126,7 +126,7 @@ ignore=T1,body-min-length
on *valid but empty* commit ranges. Disabled by default.
3. Disabled by default, but will be enabled by default in the future. [More information](general_options.md#regex-style-search).
4. See [Contrib Rules](../rules/contrib_rules.md).
-5. See [User Defined Rules](../rules/user_defined_rules/getting_started.md).
+5. See [User Defined Rules](../rules/user_defined_rules/index.md).
6. All sections below sets rule specific behavior. <br/>
Rules and sections can be referenced by their full name or by id. For example, this rule
`[title-max-length]` could also be referenced as `[T1]`.
@@ -172,7 +172,7 @@ ignore=T1,body-min-length
ignore=all
```
-19. [User-Defined rules](../rules/user_defined_rules/getting_started.md) can be written in python to tailor gitlint to your specific needs.
+19. [User-Defined rules](../rules/user_defined_rules/index.md) can be written in python to tailor gitlint to your specific needs.
20. [Named Rules](../rules/named_rules.md) allow you to specify multiple instances of the same rule by given them an extra name of your
choosing after the colon sign `:`. <br><br> In the example below we're configuring another instances of the
`title-must-not-contain-word` rule (the existing one will remain active as well) and naming it `Additional-Words`.
diff --git a/docs/contributing/contrib_rules.md b/docs/contributing/contrib_rules.md
index 83f98e2..7e52311 100644
--- a/docs/contributing/contrib_rules.md
+++ b/docs/contributing/contrib_rules.md
@@ -6,7 +6,7 @@ itself. Thanks for considering to add a new one to gitlint!
Before starting, please read all the other documentation about contributing first.
Then, we suggest taking the following approach to add a Contrib rule:
-1. **Write your rule as a [user-defined rule](../rules/user_defined_rules/getting_started.md)**. In terms of code, Contrib rules are identical to
+1. **Write your rule as a [user-defined rule](../rules/user_defined_rules/index.md)**. In terms of code, Contrib rules are identical to
user-defined rules, they just happen to have their code sit within the gitlint codebase itself.
2. **Add your user-defined rule to gitlint**. You should put your file(s) in the [gitlint/contrib/rules](https://github.com/jorisroovers/gitlint/tree/main/gitlint-core/gitlint/contrib/rules) directory.
3. **Write unit tests**. The gitlint codebase contains [Contrib rule test files you can copy and modify](https://github.com/jorisroovers/gitlint/tree/main/gitlint-core/gitlint/tests/contrib/rules).
diff --git a/docs/demos/scenario.txt b/docs/demos/scenario.txt
index 7a4b692..54d1d1f 100644
--- a/docs/demos/scenario.txt
+++ b/docs/demos/scenario.txt
@@ -68,7 +68,7 @@ gitlint
gitlint --ignore title-trailing-punctuation
-# For more info, visit: http://jorisroovers.github.io/gitlint
+# For more info, visit: https://jorisroovers.github.io/gitlint
exit
diff --git a/docs/index.md b/docs/index.md
index 516caf6..4468e65 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -34,7 +34,7 @@ a [CI pipeline](ci.md).
- **Commit message hook**: [Auto-trigger validations against new commit message right when you're committing](commit_hooks.md). Also [works with pre-commit](commit_hooks.md#pre-commit).
- **Perfect for CI**: Gitlint is designed to work [with your own scripts or CI system](ci.md).
- **Community contributed rules**: Conventions that are common but not universal [can be selectively enabled](rules/contrib_rules.md).
- - **User-defined rules:** Want to do more then what gitlint offers out of the box? Write your own [user defined rules](rules/user_defined_rules/getting_started.md).
+ - **User-defined rules:** Want to do more then what gitlint offers out of the box? Write your own [user defined rules](rules/user_defined_rules/index.md).
- **Sane defaults:** Many of gitlint's validations are based on
[well-known](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html),
[community](https://addamhardy.com/2013-06-05-good-commit-messages-and-enforcing-them-with-git-hooks),
diff --git a/docs/javascript/extra.js b/docs/javascript/extra.js
index d97526b..74e32c7 100644
--- a/docs/javascript/extra.js
+++ b/docs/javascript/extra.js
@@ -3,11 +3,15 @@ document.addEventListener("DOMContentLoaded", function () {
new Termynal(termynalEl);
});
- // Redirect /gitlint/configuration/#regex-style-search to /gitlint/configuration/general_options/#regex-style-search
+ // Redirect /gitlint/configuration/#<option> to /gitlint/configuration/general_options/#<option>