Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trustedshops-public/circleci-orb-github-utils
Utility for working with GitHub in CircleCI
https://github.com/trustedshops-public/circleci-orb-github-utils
ci circleci circleci-orbs github tpcircleci-orb tscircleci-orbs util
Last synced: 1 day ago
JSON representation
Utility for working with GitHub in CircleCI
- Host: GitHub
- URL: https://github.com/trustedshops-public/circleci-orb-github-utils
- Owner: trustedshops-public
- License: mit
- Created: 2023-06-29T09:21:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-29T15:34:08.000Z (23 days ago)
- Last Synced: 2024-11-29T16:33:57.031Z (23 days ago)
- Topics: ci, circleci, circleci-orbs, github, tpcircleci-orb, tscircleci-orbs, util
- Homepage: https://circleci.com/developer/orbs/orb/trustedshops-public/github-utils
- Size: 21.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
circleci-orb-github-utils
===
[](https://github.com/trustedshops-public/github-utils/blob/main/LICENSE)
[](https://pre-commit.com/)
[](https://circleci.com/gh/trustedshops-public/circleci-orb-github-utils)
[](https://circleci.com/orbs/registry/orb/trustedshops-public/github-utils)
Utility for working with GitHub in CircleCI
## Resources
[CircleCI Orb Registry Page](https://circleci.com/orbs/registry/orb/trustedshops-public/github-utils) - The official registry page of this
orb for all versions, executors, commands, and jobs described.
[CircleCI Orb Docs](https://circleci.com/docs/2.0/orb-intro/#section=configuration) - Docs for using and creating
CircleCI Orbs.
### How to Contribute
We welcome [issues](https://github.com/trustedshops-public/circleci-orb-github-utils/issues) to
and [pull requests](https://github.com/trustedshops-public/circleci-orb-github-utils/pulls) against this repository!
### 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
### Publish new release
Commit according to semantic release spec above and let CircleCI (and semantic-release) do the magic.