Auto create gitmoji labels
ActionsTags
(2)A simple action to automatically label PRs based on the gitmoji used in the title.
Note: GitHub requires more than just the gitmoji in the title, so this action will create the labels
as <gitmoji>_gitmoji for example ✨_gitmoji or 🐛_gitmoji etc.
name: Create gitmoji label
on:
pull_request:
types: [opened, edited, reopened, synchronize]
jobs:
create-gitmoji-label:
runs-on: ubuntu-latest
permissions:
pull-requests: write
contents: read
repository-projects: read
steps:
- name: Enforce gitmoji PR title
uses: georgepstaylor/[email protected]
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}The token requires the pull-request: write (to add a label to a PR) and if you are running this in a github-organisation, repository-projects: read too. Please see the following reference for the latter: cli/cli#5307
Using the above example verbatim, you can use the job title gitmoji-pr-title as a required check.
Ensure you set this action job as a required check for your PRs, otherwise PRs could be merged without the correct labels
Optionally you can use this action in conjunction with georgepstaylor/gitmoji-release-action to automatically generate releases and release notes based on the gitmoji labels.
Likewise, you can create releases using the GitHub UI and the release notes will be generated based on the gitmoji labels if you use the following configuration:
See:
- https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
- https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository
# .github/release.yml
changelog:
exclude:
labels:
- ignore-for-release
authors:
- octocat
categories:
- title: Exciting New Features and Enhancements ✨
labels:
- ✨_gitmoji
- ⚡_gitmoji
- 🚀_gitmoji
- 🎉_gitmoji
- 🥚_gitmoji
- title: Security Fixes 🔒
labels:
- 🔒_gitmoji
- 🛡️_gitmoji
- 🛂_gitmoji
- 🔐_gitmoji
- title: Bug Fixes 🐛
labels:
- 🐛_gitmoji
- 🚑_gitmoji
- 🩹_gitmoji
- title: Documentation 📚
labels:
- 📚_gitmoji
- 📝_gitmoji
- 💡_gitmoji
- 📄_gitmoji
- title: Typo Corrections 📝
labels:
- 📝_gitmoji
- 📚_gitmoji
- title: Breaking Changes 💥
labels:
- 💥_gitmoji
- title: Refactor ♻️
labels:
- ♻️_gitmoji
- ⚰️_gitmoji
- 🗑️_gitmoji
- 🚚_gitmoji
- title: Work In Progress 🚧
labels:
- 🚧_gitmoji
- 🍺_gitmoji
- 💩_gitmoji
- title: Dependency Updates 📦
labels:
- ➕_gitmoji
- ➖_gitmoji
- 📌_gitmoji
- ⬆️_gitmoji
- ⬇️_gitmoji
- title: Other Changes
labels:
- "*"
Auto create gitmoji labels is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
Tags
(2)Auto create gitmoji labels is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.