Skip to content

Commit

Permalink
some: false commit
Browse files Browse the repository at this point in the history
  • Loading branch information
oliverbaehler committed Oct 23, 2023
1 parent 10bbf39 commit c6736b8
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 5 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Changelog

Changes are published with their type and scope for each release in the release description. Changes are assigned based on their commit description. Read more on how commits should be formatted in the [Contributing](CONTRIBUTING.md#commits) guide.

See the [Releases](https://github.com/projectcapsule/capsule/releases)
12 changes: 7 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,12 @@ Commit messages should indicate the change and it's impact. The general format f

The following types are allowed for commits and pull requests:

* `ci` or `build`: changes to buillding process/workflows
* `chore`: housekeeping changes, no production code change
* `ci`: changes to buillding process/workflows
* `docs`: changes to documentation
* `feat`: new features
* `fix`: bug fixes
* `test`: test related changes

## Scopes

Expand All @@ -48,13 +50,13 @@ The following types are allowed for commits and pull requests:
* `all`: changes that affect all components
* `chart`: changes to the Helm chart
* `operator`: changes to the operator
* `docs`: changes to the documentation
* `manifest`: changes to the manifest installer
* `website`: changes to the website
* `ci`: changes to the CI/CD workflows
* `build`: changes to the build process
* `test`: changes to the testing process
* `e2e`: changes to the e2e testing process
* `release`: changes to the release process
* `repo`: changes to general repository files
* `deps`: dependency updates
* `make`: changes to Makefile

### Sign-Off

Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,10 @@ Please, refer to the maintainers file available [here](.github/maintainers.yaml)

Please, refer to the [documentation page](https://capsule.clastix.io/docs/contributing/release).

### Changelog

Read how we log changes [here](CHANGELOG.md)

### Software Bill of Materials

All OCI release artifacts include a Software Bill of Materials (SBOM) in CycloneDX JSON format. More information on this is available [here](SECURITY.md#software-bill-of-materials-sbom)
Expand Down
19 changes: 19 additions & 0 deletions commitlint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
const Configuration = {
extends: ['@commitlint/config-conventional'],
plugins: ['commitlint-plugin-function-rules'],
rules: {
'scope-enum': [2, 'always', ['all', 'chart', 'operator', 'manifest', 'deps', 'release', 'website', 'repo', 'e2e', 'make']],
'type-enum': [2, 'always', ['chore', 'ci', 'docs', 'feat', 'test', 'fix']],
},
/*
* Whether commitlint uses the default ignore rules, see the description above.
*/
defaultIgnores: true,
/*
* Custom URL to show upon failure
*/
helpUrl:
'https://github.com/projectcapsule/capsule/blob/main/CONTRIBUTING.md#commits',
};

module.exports = Configuration;

0 comments on commit c6736b8

Please sign in to comment.