docs: remove GitLab clone depth limitation #4105

Closed abitrolly closed 4 months ago

See https://github.com/conventional-changelog/commitlint/issues/4103

Description

I removed stages key, because copy/pasting the block may break stages that people have defined already.

Motivation and Context

Usage examples

// commitlint.config.js
module.exports = {};

echo "your commit message here" | commitlint # fails/passes

How Has This Been Tested?

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

[ ] My change requires a change to the documentation.
[ ] I have updated the documentation accordingly.
[ ] I have added tests to cover my changes.
[ ] All new and existing tests passed.

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Thanks!

I removed stages key, because copy/pasting the block may break stages that people have defined already.

You think it's worth adding i.e. a comment for these or just leave it out for now?

@escapedcat better leave it out for now, because there are more ways to organize when to run then job . For example, use special needs: [] syntax to run it as soon as possible regardless of stage.

https://docs.gitlab.com/ee/ci/pipelines/pipeline_architectures.html#pipelines-with-the-needs-keyword

Failing lint stage also aborts build stage, which may be not what people expect. Probably they want to see if tests pass and fix both tests and lint warnings for the next push.

conventional-changelog / commitlint