UNCLASSIFIED - NO CUI

Skip to content
Snippets Groups Projects

Add commitlint job

Merged Zachariah Dzielinski requested to merge commitlint-ci into master
1 file
+ 15
1
Compare changes
  • Side-by-side
  • Inline
+ 22
1
@@ -11,6 +11,7 @@ Table of Contents:
- [Local Setup](#local-setup)
- [Prereqs](#prereqs)
- [Steps](#steps)
- [Combining Multiple Commits](#combining-multiple-commits)
- [Iron Bank Images](#iron-bank-images)
- [Local Kubernetes cluster](#local-kubernetes-cluster)
- [Deploying Big Bang (Quick Start)](#deploying-big-bang-quick-start)
@@ -36,7 +37,11 @@ Big Bang is designed in such a way as to be as easily deployed locally as it is
### Pre-commit hooks
We would like developers to leverage [conventional commits](https://www.conventionalcommits.org/) when contributing. In order to help enforce this we are leveraging client-side pre-commit hooks. This is done using the following tools:
We would require developers to leverage [conventional commits](https://www.conventionalcommits.org/) when contributing.
In order to help enforce this we are leveraging client-side pre-commit hooks.
This is done using the following tools:
- [husky](https://www.npmjs.com/package/husky)
- [commitlint](https://commitlint.js.org/#/)
@@ -57,6 +62,22 @@ npm install --only=dev
This will download `husky` and `commitlint` to your local repo and modify your `.git/hooks` to allow husky to run pre-commit hooks. Once installed it will enforce the usage of convential-commits.
#### Combining Multiple Commits
If you have pushed commits that do not conform to the conventional-commit guide lines, you can combine all of the incorrectly formatted commit messages by using `git rebase`.
A more expansive guide of how this is done can be found [here](https://www.w3docs.com/snippets/git/how-to-combine-multiple-commits-into-one-with-3-steps.html).
Here is a quick tip to squash all commits for a branch named `test`:
```
git checkout test
git reset $(git merge-base master $(git rev-parse --abbrev-ref HEAD))
git add -A
git commit -m "feat: example conventional commit"
git push --force
```
## Iron Bank Images
Per the [charter](https://repo1.dsop.io/platform-one/big-bang/charter), all Big Bang packages will leverage container images from [IronBank](https://ironbank.dsop.io/). In order to pull these images, ImagePullSecrets must be provided to BigBang. To obtain access to these images, follow the guides below. These steps should NOT be used for production since the API keys for a user are only valid when the user is logged into [Registry1](https://registry1.dsop.io)
Loading