Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trustedshops-public/cookiecutter-circleci-orb
Cookiecutter template for circleci orbs
https://github.com/trustedshops-public/cookiecutter-circleci-orb
cookiecutter-template
Last synced: 1 day ago
JSON representation
Cookiecutter template for circleci orbs
- Host: GitHub
- URL: https://github.com/trustedshops-public/cookiecutter-circleci-orb
- Owner: trustedshops-public
- License: mit
- Created: 2021-10-28T11:37:28.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T02:34:57.000Z (9 months ago)
- Last Synced: 2024-04-08T03:37:12.828Z (9 months ago)
- Topics: cookiecutter-template
- Homepage:
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
cookiecutter-circleci-orb
===
[](https://github.com/trustedshops-public/circleci-orb-semantic-release/blob/main/LICENSE)
This repository is used as cookiecutter template for new CircleCI orbs.
## Usage
```sh
cookiecutter gh:trustedshops-public/cookiecutter-circleci-orb
```
## Development
### Commit Message Convention
This repository follows [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
#### Format
`(optional scope): `
Example: `feat(pre-event): Add speakers section`
#### 1. Type
Available types are:
- feat → Changes about addition or removal of a feature. Ex: `feat: Add table on landing page`
, `feat: Remove table from landing page`
- fix → Bug fixing, followed by the bug. Ex: `fix: Illustration overflows in mobile view`
- docs → Update documentation (README.md)
- style → Updating style, and not changing any logic in the code (reorder imports, fix whitespace, remove comments)
- chore → Installing new dependencies, or bumping deps
- refactor → Changes in code, same output, but different approach
- ci → Update github workflows, husky
- test → Update testing suite, cypress files
- revert → when reverting commits
- perf → Fixing something regarding performance (deriving state, using memo, callback)
- vercel → Blank commit to trigger vercel deployment. Ex: `vercel: Trigger deployment`
#### 2. Optional Scope
Labels per page Ex: `feat(pre-event): Add date label`
*If there is no scope needed, you don't need to write it*
#### 3. Description
Description must fully explain what is being done.
Add BREAKING CHANGE in the description if there is a significant change.
**If there are multiple changes, then commit one by one**
- After colon, there are a single space Ex: `feat: Add something`
- When using `fix` type, state the issue Ex: `fix: File size limiter not working`
- Use imperative, dan present tense: "change" not "changed" or "changes"
- Use capitals in front of the sentence
- Don't add full stop (.) at the end of the sentence