Welcome to the Github Action Mastermind collection. This is the mono-repository for Videndum's collection of superpowered actions. This collection is built to work together as an universal tool for Github Project management. For simplicity, our main tool - Release Mastermind - incorporates all our other tools within one simple action, which can be used in all your workflows to manage all your common tasks.
We designed this tool because the community tools either didn't have the features we wanted, or are not maintained. We wanted to create a single action which could do everything, or nothing, dependent on the configuration. This tool does exactly that, you choose how much or how little you want it to do...
Need reasons to consider using Release Manager?
- Everything is configured from either JSON or YAML files found within your
.githubfolder for the repository. One file = no clutter. - Automates all common tasks within a single action - Reduce the size of your workflow files
- Actively maintained - This project is actively maintained as it's the backbone of all our projects
- Works on any repository - No permissions required, simply use a Personal Access Token
- Features
- How to get support 👨‍👩‍👧‍👦
- Backlog & Contributing
- Running Locally & Developing
- Getting Started
- Available Conditions
- Final Note
- Create, Update, Delete Labels declaratively from Config
- Apply Labels based on conditions
- Enforce Conventions - Ensure the repository follows conventions setout by your team. Configured using Conditions
- Automatically assign to projects - Ensure your projects have all open issues and pull requests assigned to the correct locations.
- Synchronise project boards - Keep remote project boards up to date with repo boards. Useful for multi-repo projects or big organisations.
- Automatically assign to milestones - Keep milestones upto date by automatically assigning issues and pull requests
- Automatically create Branches - Open branches based on project column, or when an issue is opened.
- Hotfix duplication - Automatically duplicate Hotfix pull requests to the
mainbranch. - Automatically approve - Setup automatic pull request approval based on conditions.
- Automatically bump version - Automatically increase the version of your project - Optionally use tags.
- Automatically package and release - Specify commands to run when new release should be created.
- Create Changelogs - Automatically create changelogs for your project.
- Create milestones automatically - Automatically create milestones when a new release is published.
- Automatically maintain
mainanddevbranches - Create pull requests fromdevtomainand automatically approve them based on config. - Automatically syncronise branches or folders with remote repository.
For Features Requests, Q&A, Show & Tell and Discussions please use our discussions page đźš‘.
We have a FAQ category in our discussions page where you can get quick answers, help with debugging weird issues, and general help.
Our extensive documentation can be found at here.
GitHub is our office, it's the place where our development and contributor teams do their work. We use the issue list to keep track of bugs and the features that we are working on. We do this openly for transparency, to reduce replication by contributors and increase productivity.
With the discussion page, you can leverage the knowledge of our wider community to get help with any problems you are having. Please keep in mind that this project is open-source, support is provided by the goodwill of our wonderful community members.
Thank you for taking an interst in contributing. We have created development containers (.devcontainer) to allow you to jump straight in with coding. We even went through the hassle of setting up step by step guides using CodeTour. Everything is configured and ready to go, all you need to do is use one of the supported platforms: VSCode | Github Codespaces
For more information on how to contribute, please read the contributing guidelines.
Our backlog can be found on Github
Setting up local running is simple, however we MUST warn that building / packaging while using local scripts can cause your GITHUB_TOKEN to be included within the package. To avoid this happening. you MUST follow the steps correctly. We will not be held responsible for any leeked personal tokens.
- Setup a secret on your repository named:
ACTIONS_STEP_DEBUGvalue:true - Ensure the action has run once after you created this secret
- Fork & Clone the development repository
- Continue from step 4 of
Running Locallythen return to step 5 & 6. - Make changes, then rebuild using
npm run dev:runoryarn dev:run - If uploading changes to Github
- Delete
./context.json,./config,./lib,./dist. - Run
yarn dev:all. - Commit & push.
- Delete
- Fork & Clone this repository
- Run
yarn installornpm install - From the action logs find
Context for local runningcopy the output into a file named./context.jsonat the root of the project. - Modify the
./config.sample.jsonto contain yourGITHUB_TOKENand rename to./config.json - Run the script using
yarn dev:runornpm run dev:run
Important
It is Extremely important to understand while using this template, most of the code within .github/ will automatically update within a new pull request whenever the template repository is updated.
[coming soon]
Create a new Github Actions workflow at .github/workflows/main.yml:
Note: actions/checkout must be run first so that the release action can find your config file.
main.yml
# @format
name: Project Management
on:
issues:
types: [opened, edited, closed, reopened]
pull_request:
types: [opened, edited, closed, reopened, synchronize]
project_card:
types: [created, moved, deleted]
schedule: [cron: "0 * * * *"]
jobs:
release-mastermind:
name: Release Mastermind
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
- uses: ./
with:
GITHUB_TOKEN: "${{ secrets.BOT_TOKEN }}"
config: .github/allconfigs.jsonNow create the config file at .github/config.json:
Our runners config (Very Long)
[
{
"$schema": "../../schema/configs.json",
"root": ".",
"versioning": {
"source": "milestones",
"type": "SemVer"
},
"prereleaseName": "alpha",
"sharedConfig": {
"stale": {
"staleLabel": "stale",
"stale": {
"days": 60,
"comment": "This has been automatically marked as stale by the bot."
},
"abandoned": {
"days": 30,
"label": "abandoned",
"comment": "This has been automatically marked as abandoned by the bot."
}
},
"enforceConventions": {
"onColumn": ["Accepted", "Reviewing"],
"conventions": [
{
"requires": 1,
"contexts": [
"@videndum/workflow-mastermind",
"@videndum/release-mastermind",
"@videndum/label-mastermind",
"@videndum/variable-mastermind",
"@videndum/convention-mastermind",
"condition",
"api",
"util",
"installer",
"deps",
"deps-dev"
],
"conditions": "semanticTitle"
}
]
},
"labels": {
"bug": {
"requires": 1,
"conditions": [
{
"type": "titleMatches",
"pattern": "/^bug(\\(.*\\))?(!)?:/i"
},
{
"type": "descriptionMatches",
"pattern": "/(created|new|opened|made)( an| a)? bug/i"
}
]
},
"chore": {
"requires": 1,
"conditions": [
{
"type": "titleMatches",
"pattern": "/^chore(\\(.*\\))?(!)?:/i"
}
]
},
"optimisation": {
"requires": 2,
"conditions": [
{
"type": "titleMatches",
"pattern": "/^opt(\\(.*\\))?(!)?:/i"
},
{
"type": "titleMatches",
"pattern": "/^optimisation(\\(.*\\))?(!)?:/i"
},
{
"type": "titleMatches",
"pattern": "/^maint(\\(.*\\))?(!)?:/i"
},
{
"type": "titleMatches",
"pattern": "/^maintenance(\\(.*\\))?(!)?:/i"
},
{
"type": "descriptionMatches",
"pattern": "/^type:(,| |Style|Refactoring|Revert|Deprecated|Removal)*optimisation/im"
}
]
},
"style": {
"requires": 2,
"conditions": [
{
"type": "titleMatches",
"pattern": "/^style(\\(.*\\))?(!)?:/i"
},
{
"type": "titleMatches",
"pattern": "/^maint(\\(.*\\))?(!)?:/i"
},
{
"type": "titleMatches",
"pattern": "/^maintenance(\\(.*\\))?(!)?:/i"
},
{
"type": "descriptionMatches",
"pattern": "/^type:(,| |Refactoring|Optimisation|Revert|Deprecated|Removal)*style/im"
}
]
},
"refactor": {
"requires": 2,
"conditions": [
{
"type": "titleMatches",
"pattern": "/^ref(\\(.*\\))?(!)?:/i"
},
{
"type": "titleMatches",
"pattern": "/^refactor(\\(.*\\))?(!)?:/i"
},
{
"type": "titleMatches",
"pattern": "/^maint(\\(.*\\))?(!)?:/i"
},
{
"type": "titleMatches",
"pattern": "/^maintenance(\\(.*\\))?(!)?:/i"
},
{
"type": "descriptionMatches",
"pattern": "/^type:(,| |Style|Optimisation|Revert|Deprecated|Removal)*refactoring/im"
}
]
},
"revert": {
"requires": 2,
"conditions": [
{
"type": "titleMatches",
"pattern": "/^revert(\\(.*\\))?(!)?:/i"
},
{
"type": "titleMatches",
"pattern": "/^maint(\\(.*\\))?(!)?:/i"
},
{
"type": "titleMatches",
"pattern": "/^maintenance(\\(.*\\))?(!)?:/i"
},
{
"type": "descriptionMatches",
"pattern": "/^type:(,| |Style|Refactoring|Optimisation|Deprecated|Removal)*revert/im"
}
]
},
"deprecated": {
"requires": 2,
"conditions": [
{
"type": "titleMatches",
"pattern": "/^dep(\\(.*\\))?(!)?:/i"
},
{
"type": "titleMatches",
"pattern": "/^deprecated(\\(.*\\))?(!)?:/i"
},
{
"type": "titleMatches",
"pattern": "/^maint(\\(.*\\))?(!)?:/i"
},
{
"type": "titleMatches",
"pattern": "/^maintenance(\\(.*\\))?(!)?:/i"
},
{
"type": "descriptionMatches",
"pattern": "/^type:(,| |Style|Refactoring|Optimisation|Revert|Removal)*deprecated/im"
}
]
},
"removal": {
"requires": 2,
"conditions": [
{
"type": "titleMatches",
"pattern": "/^removal(\\(.*\\))?(!)?:/i"
},
{
"type": "titleMatches",
"pattern": "/^maint(\\(.*\\))?(!)?:/i"
},
{
"type": "titleMatches",
"pattern": "/^maintenance(\\(.*\\))?(!)?:/i"
},
{
"type": "descriptionMatches",
"pattern": "/^type:(,| |Style|Refactoring|Optimisation|Revert|Deprecated)*removal/im"
}
]
},
"discussion": {
"requires": 1,
"conditions": [
{
"type": "titleMatches",
"pattern": "/^discussion(\\(.*\\))?(!)?:/i"
}
]
},
"documentation": {
"requires": 1,
"conditions": [
{
"type": "titleMatches",
"pattern": "/^docs(\\(.*\\))?(!)?:/i"
},
{
"type": "titleMatches",
"pattern": "/^documentation(\\(.*\\))?(!)?:/i"
}
]
},
"feature": {
"requires": 1,
"conditions": [
{
"type": "titleMatches",
"pattern": "/^feat(\\(.*\\))?(!)?:/i"
},
{
"type": "titleMatches",
"pattern": "/^enhance(\\(.*\\))?(!)?:/i"
},
{
"type": "titleMatches",
"pattern": "/^feature(\\(.*\\))?(!)?:/i"
},
{
"type": "titleMatches",
"pattern": "/^enhancement(\\(.*\\))?(!)?:/i"
}
]
},
"fix": {
"requires": 1,
"conditions": [
{
"type": "titleMatches",
"pattern": "/^fix(\\(.*\\))?(!)?:/i"
}
]
},
"workflow": {
"requires": 1,
"conditions": [
{
"type": "titleMatches",
"pattern": "/^.*\\((@videndum\\/)?workflow-mastermind\\)(!)?:/i"
}
]
},
"releaseMastermind": {
"requires": 1,
"conditions": [
{
"type": "descriptionMatches",
"pattern": "/^- package\\(s\\):.*(@videndum\\/)?release-mastermind.*/im"
},
{
"type": "titleMatches",
"pattern": "/^.*\\((@videndum\\/)?release-mastermind\\)(!)?:/i"
}
]
},
"labelMastermind": {
"requires": 1,
"conditions": [
{
"type": "descriptionMatches",
"pattern": "/^- package\\(s\\):.*(@videndum\\/)?label-mastermind.*/im"
},
{
"type": "titleMatches",
"pattern": "/^.*\\((@videndum\\/)?label-mastermind\\)(!)?:/i"
}
]
},
"variableMastermind": {
"requires": 1,
"conditions": [
{
"type": "descriptionMatches",
"pattern": "/^- package\\(s\\):.*(@videndum\\/)?variable-mastermind.*/im"
},
{
"type": "titleMatches",
"pattern": "/^.*\\((@videndum\\/)?variable-mastermind\\)(!)?:/i"
}
]
},
"condition": {
"requires": 1,
"conditions": [
{
"type": "titleMatches",
"pattern": "/^.*\\(condition\\)(!)?:/i"
}
]
},
"api": {
"requires": 1,
"conditions": [
{
"type": "titleMatches",
"pattern": "/^.*\\(api\\)(!)?:/i"
}
]
},
"contexts": {
"requires": 1,
"conditions": [
{
"type": "titleMatches",
"pattern": "/^.*\\(contexts\\)(!)?:/i"
}
]
},
"util": {
"requires": 1,
"conditions": [
{
"type": "titleMatches",
"pattern": "/^.*\\(util\\)(!)?:/i"
}
]
},
"installer": {
"requires": 1,
"conditions": [
{
"type": "titleMatches",
"pattern": "/^.*\\(installer\\)(!)?:/i"
}
]
},
"deps": {
"requires": 1,
"conditions": [
{
"type": "titleMatches",
"pattern": "/^.*\\(deps\\)(!)?:/i"
}
]
},
"depsDev": {
"requires": 1,
"conditions": [
{
"type": "titleMatches",
"pattern": "/^.*\\(deps-dev\\)(!)?:/i"
}
]
},
"priorityCritical": {
"requires": 1,
"conditions": [
{
"type": "titleMatches",
"pattern": "!:.*(critical|urgent)?|!?:.*(critical|urgent)"
}
]
}
}
},
"pr": {
"manageRelease": {
"version": "bump",
"labels": {
"prerelease": "Versioning - Prerelease",
"build": "Versioning - Build",
"patch": "Versioning - Patch",
"minor": "Versioning - Minor",
"major": "Versioning - Major",
"breaking": "Versioning - Breaking"
},
"createTag": true,
"createRelease": true,
"createMilestone": {},
"createPackages": "npm publish",
"createChangelog": {
"includeIssues": true,
"sections": [
{
"title": "Features Effectuated",
"PRlabels": ["Type - Feature"],
"issueLabels": [],
"includeCommitter": true,
"linkPR": true
},
{
"title": "Bugs Squashed",
"PRlabels": ["Type - Fix"],
"issueLabels": [],
"includeCommitter": true,
"linkPR": true
},
{
"title": "Maintenance & Dusting",
"PRlabels": [
"Type - Maintenance",
"Type - Style",
"Type - Documentation",
"Type - Enhancement",
"Type - Optimisation",
"Type - Refactor"
],
"issueLabels": [],
"includeCommitter": true,
"linkPR": true
},
{
"title": "Abolishment",
"PRlabels": [
"Type - Revert",
"Type - deprecated",
"Type - Removal"
],
"issueLabels": [],
"includeCommitter": true,
"linkPR": true
},
{
"title": "Confession Time",
"PRlabels": [],
"issueLabels": ["Bug - Confirmed"],
"includeCommitter": true,
"linkPR": true
}
]
},
"conditions": {}
},
"automaticApprove": {
"conventions": [
{
"requires": 1,
"conditions": [{}]
}
]
},
"duplicateHotfix": {},
"createMilestone": {},
"syncRemote": {},
"assignProject": [
{
"project": "Developer Operations",
"column": "Reviewing",
"requires": 0,
"conditions": []
}
],
"labels": {
"xs": {
"requires": 1,
"conditions": [
{
"type": "changesSize",
"min": 0,
"max": 10
}
]
},
"s": {
"requires": 1,
"conditions": [
{
"type": "changesSize",
"min": 10,
"max": 30
}
]
},
"m": {
"requires": 1,
"conditions": [
{
"type": "changesSize",
"min": 40,
"max": 100
}
]
},
"l": {
"requires": 1,
"conditions": [
{
"type": "changesSize",
"min": 100,
"max": 500
}
]
},
"xl": {
"requires": 1,
"conditions": [
{
"type": "changesSize",
"min": 500,
"max": 1000
}
]
},
"xxl": {
"requires": 1,
"conditions": [
{
"type": "changesSize",
"min": 1000
}
]
},
"fixConfirmed": {
"requires": 6,
"conditions": [
{
"type": "descriptionMatches",
"pattern": "/^- \\[x\\] fix Confirmed by ((@.*& .*){4,}|(@.*& )*@(tgtgamer|videndum\\/.*))/im"
},
{
"type": "descriptionMatches",
"pattern": "/^- \\[x\\] have fixed on a clean installation/im"
},
{
"type": "descriptionMatches",
"pattern": "/^- \\[x\\] have fixed on a stable build/im"
},
{
"type": "descriptionMatches",
"pattern": "/^- \\[x\\] have fixed on a development build/im"
},
{
"type": "descriptionMatches",
"pattern": "/^- \\[x\\] have included logs or screenshots/im"
},
{
"type": "descriptionMatches",
"pattern": "/^- \\[x\\] have linked any related/im"
}
]
},
"devOpsReviewing": {
"requires": 1,
"conditions": [
{
"type": "pendingReview",
"value": true
}
]
},
"devOpsRejected": {
"requires": 1,
"conditions": [
{
"type": "requestedChanges",
"value": true
}
]
}
}
},
"issue": {
"assignProject": [
{
"project": "Developer Operations",
"column": "Requested",
"requires": 1,
"conditions": []
},
{
"project": "Issues",
"column": "New",
"requires": 1,
"conditions": [
{
"type": "hasLabel",
"label": "Type - Bug",
"value": true
},
{
"type": "titleMatches",
"pattern": "/^bug(\\(.*\\))?(!)?:/i"
},
{
"type": "descriptionMatches",
"pattern": "/(created|new|opened|made)( an| a)? bug/i"
}
]
}
],
"assignColumn": {},
"createBranch": {},
"labels": {
"android": {
"requires": 1,
"conditions": [
{
"type": "descriptionMatches",
"pattern": "/^- platform:.*android/im"
}
]
},
"aws": {
"requires": 1,
"conditions": [
{
"type": "descriptionMatches",
"pattern": "/^- platform:.*aws/im"
},
{
"type": "descriptionMatches",
"pattern": "/^- platform:.*amazon web service/im"
}
]
},
"google": {
"requires": 1,
"conditions": [
{
"type": "descriptionMatches",
"pattern": "/^- platform:.*google/im"
}
]
},
"ios": {
"requires": 1,
"conditions": [
{
"type": "descriptionMatches",
"pattern": "/^- platform:.*ios/im"
}
]
},
"ubuntu": {
"requires": 1,
"conditions": [
{
"type": "descriptionMatches",
"pattern": "/^- platform:.*ubuntu/im"
}
]
},
"fedora": {
"requires": 1,
"conditions": [
{
"type": "descriptionMatches",
"pattern": "/^- platform:.*fedora/im"
}
]
},
"debian": {
"requires": 1,
"conditions": [
{
"type": "descriptionMatches",
"pattern": "/^- platform:.*debian/im"
}
]
},
"macos": {
"requires": 1,
"conditions": [
{
"type": "descriptionMatches",
"pattern": "/^- platform:.*macos/im"
}
]
},
"windows": {
"requires": 1,
"conditions": [
{
"type": "descriptionMatches",
"pattern": "/^- platform:.*windows/im"
}
]
},
"bugConfirmed": {
"requires": 8,
"conditions": [
{
"type": "descriptionMatches",
"pattern": "/^- \\[x\\] bug Confirmed by ((@.*& .*){4,}|(@.*& )*@(tgtgamer|videndum\\/.*))/im"
},
{
"type": "descriptionMatches",
"pattern": "/^- \\[x\\] have reproduced on my application version/im"
},
{
"type": "descriptionMatches",
"pattern": "/^- \\[x\\] have reproduced on a clean installation/im"
},
{
"type": "descriptionMatches",
"pattern": "/^- \\[x\\] have reproduced on a development build/im"
},
{
"type": "descriptionMatches",
"pattern": "/^- \\[x\\] have included logs or screenshots/im"
},
{
"type": "descriptionMatches",
"pattern": "/^- \\[x\\] have contacted support/im"
},
{
"type": "descriptionMatches",
"pattern": "/^- \\[x\\] have asked the community/im"
},
{
"type": "descriptionMatches",
"pattern": "/^- \\[x\\] have linked any related/im"
}
]
},
"fixConfirmed": {
"requires": 6,
"conditions": [
{
"type": "descriptionMatches",
"pattern": "/^- \\[x\\] fix Confirmed by ((@.*& .*){4,}|(@.*& )*@(tgtgamer|videndum\\/.*))/im"
},
{
"type": "descriptionMatches",
"pattern": "/^- \\[x\\] have fixed on a clean installation/im"
},
{
"type": "descriptionMatches",
"pattern": "/^- \\[x\\] have fixed on a stable build/im"
},
{
"type": "descriptionMatches",
"pattern": "/^- \\[x\\] have fixed on a development build/im"
},
{
"type": "descriptionMatches",
"pattern": "/^- \\[x\\] have included logs or screenshots/im"
},
{
"type": "descriptionMatches",
"pattern": "/^- \\[x\\] have linked any related/im"
}
]
}
}
},
"project": {
"syncRemote": [
{
"localProject": "Developer Operations",
"owner": "Videndum",
"project": "Developer Operations"
},
{
"localProject": "Issues",
"owner": "Videndum",
"project": "Issues"
}
],
"openBranch": {},
"assignMilestone": {},
"labels": {
"available": {
"requires": 1,
"conditions": [
{
"type": "onColumn",
"project": "Developer Operations",
"column": "Requested"
}
]
},
"pending": {
"requires": 1,
"conditions": [
{
"type": "onColumn",
"project": "Developer Operations",
"column": "Accepted"
}
]
},
"progress": {
"requires": 1,
"conditions": [
{
"type": "onColumn",
"project": "Developer Operations",
"column": "In Progress"
},
{
"type": "onColumn",
"project": "Developer Operations",
"column": "Testing"
}
]
},
"review": {
"requires": 1,
"conditions": [
{
"type": "onColumn",
"project": "Developer Operations",
"column": "Reviewing"
}
]
},
"completed": {
"requires": 1,
"conditions": [
{
"type": "onColumn",
"project": "Developer Operations",
"column": "Completed"
}
]
},
"doNotDevelop": {
"requires": 1,
"conditions": [
{
"type": "onColumn",
"project": "Developer Operations",
"column": "Rejected"
}
]
},
"devOpsAccepted": {
"requires": 1,
"conditions": [
{
"type": "onColumn",
"project": "Developer Operations",
"column": "Accepted"
}
]
},
"devOpsDeveloping": {
"requires": 1,
"conditions": [
{
"type": "onColumn",
"project": "Developer Operations",
"column": "In Progress"
}
]
},
"devOpsTesting": {
"requires": 1,
"conditions": [
{
"type": "onColumn",
"project": "Developer Operations",
"column": "Testing"
}
]
},
"devOpsReviewing": {
"requires": 1,
"conditions": [
{
"type": "onColumn",
"project": "Developer Operations",
"column": "Reviewing"
}
]
},
"devOpsStaging": {
"requires": 1,
"conditions": [
{
"type": "onColumn",
"project": "Developer Operations",
"column": "Staging"
}
]
},
"devOpsCompleted": {
"requires": 1,
"conditions": [
{
"type": "onColumn",
"project": "Developer Operations",
"column": "Completed"
}
]
},
"devOpsRejected": {
"requires": 1,
"conditions": [
{
"type": "onColumn",
"project": "Developer Operations",
"column": "Rejected"
}
]
},
"priorityLow": {
"requires": 1,
"conditions": [
{
"type": "onColumn",
"project": "Issues",
"column": "Low Priority"
}
]
},
"priorityMedium": {
"requires": 1,
"conditions": [
{
"type": "onColumn",
"project": "Issues",
"column": "Medium Priority"
}
]
},
"priorityHigh": {
"requires": 1,
"conditions": [
{
"type": "onColumn",
"project": "Issues",
"column": "High Priority"
}
]
},
"priorityCritical": {
"requires": 2,
"conditions": [
{
"type": "onColumn",
"project": "Issues",
"column": "High Priority"
},
{
"type": "titleMatches",
"pattern": "!:.*(critical|urgent)?|!?:.*(critical|urgent)"
}
]
}
}
},
"schedule": {}
}
]Be sure that Github Actions is enabled for in your repository's settings. The action will now run on your issues, projects and pull requests.
| Option | Required | Description | Default |
|---|---|---|---|
| GITHUB_TOKEN | true | Your github token or PAT | N/A |
| config | false | The config file to use | ".github/config.json" |
| configJSON | false | "JSON string with config data" | N/A |
| fillEmpty | false | Fill Empty context configuration with shared configs | true |
| skipDelete | false | Skip deleting labels from repository | false |
Due to the nature of this project. Most of the options have been documented as tables of information for your convinience. However Where this isn't partically helpful or easy to do, we have used the Typing from our typescript files to showcase the option.
| Option | Required | Description | Params |
|---|---|---|---|
| labels | false | Defines all the labels within the repo | Labels |
| runners | true | Defines the configuration for each project | Runners[] |
You can have multiple runners, which allows for configuration for monorepo projects.
| Option | Required | Description | Params |
|---|---|---|---|
| Root | true | Defines the root of the project | string |
| projectType | true | Defines the type of project | "node" / "other" |
| versioning | true | Defines the versioning of the project | Versioning |
| prereleaseName | false | Defines the name of a prerelease | string |
| sharedLabelsConfig | false | Defines labels to use on both PR and Issues | SharedLabels |
| pr | false | Defines the configuration for Pull Requests | PullRequestConfig |
| issue | false | Defines the configuration for issues | IssueConfig |
| project | false | Defines the configuration for projects | ProjectConfig |
| Option | Required | Description | Params |
|---|---|---|---|
| source | true | Defines the source for versioning | "node" / "milestones" / string |
| type | false | Defines the versioning of the project | "SemVer" / "other" |
| Option | Required | Description | Params |
|---|---|---|---|
| ref | false | Overrides the reference | string |
| enforceConventions | false | Enforces conventions | EnforceConventions |
| labels | false | Apply labels automatically | [Key: string]: PRConditionConfig |
| automaticApprove | false | Automatically approved PR based on conditions | AutomaticApprove |
| manageRelease | false | Manage releases | Release |
| duplicateHotfix | false | Duplicate a hotfix to the main branch |
[title: string]: DuplicateHotfix |
| syncRemote | false | Syncronise a remote repository | SyncRemote[] |
| assignProject | false | Automatically assign to projects | AssignProject[] |
| Option | Required | Description | Params |
|---|---|---|---|
| onColumn | false | (if project card ) Which column should trigger this action | column[ String / Number ] |
| commentHeader | false | A comment to append to the header of failed comments | string |
| commentFooter | false | A comment to append to the footer of failed comments | string |
| moveToColumn | false | (if project card) Optionally move the card to another column on failure | String / Number |
| Conventions | true | The conventions to enforce | SharedConventionsConfig[] |
| Option | Required | Description | Params |
|---|---|---|---|
| owner | false | The owner of the project (organisation) | string |
| user | false | The user which owns the project (user) | string |
| repo | false | The repo which contains teh project (requires owner to be set) | string |
| project | true | The name of the project to assign | string |
| column | true | The column within the project to assign | string |
| Option | Required | Description | Params |
|---|---|---|---|
| requires | true | The number of conditions this requires | number |
| failedComment | true | A comment to respond with should this convention fail | string |
| conditions | true | The conditions to check against | Condition[] / "semanticTitle" |
| contexts | false | (if using "semanticTitle") contexts to use |
string[] |
Choosing "semanticTitle" as the condition will automatically configure your conventions to use semantic conventions. You can add additional context by adding the contexts option which enforce only those contexts get used.
| Option | Required | Description | Params |
|---|---|---|---|
| commentHeader | false | A comment to append to the header of failed comments | string |
| commentFooter | false | A comment to append to the footer of failed comments | string |
| Conventions | true | The conventions to enforce | SharedConventionsConfig[] |
| Option | Required | Description | Params |
|---|---|---|---|
| labels | sometimes | Defines the labels to use within automation tasks | ReleaseLabels |
| createTag | false | Should this action create a tag? | boolean |
| createRelease | false | Create a github release | CreateRelease |
| createMilestones | false | Create a milestone | CreateMilestone |
| createPackages | false | Commands to use when creating packages | String[] / string |
| createChangelog | false | Create a changelog | Changelog |
| Option | Required | Description | Params |
|---|---|---|---|
| build | true | A tag to represent dependencies updates and insignificant changes | string |
| prerelease | true | A tag to represent a prerelease of the next version. | string |
| patch | true | A tag to represent a Patch version to be incremented due to backwards compatible bug fixes are introduced. | string |
| minor | true | A tag to represent a Minor version to be incremented due to substantial new functionality or improvements are introduced | string |
| major | true | A tag to represent a Major version to be incremented due to of backwards incompatible changes are introduced | string |
| breaking | true | A tag to represent a breaking change | string |
| Option | Required | Description | Params |
|---|---|---|---|
| includeIssues | false | Should issues be included in release | boolean |
| sections | false | The sections configureation | Sections[] |
| tagName | false | The name of the tag to create | string |
| tagPrefix | false | The prefix before the tagName | string |
| releaseName | false | The name of the release | string |
| releaseNamePrefix | false | The prefix before the releaseName | string |
| releaseNameSuffix | false | The Suffex before the releaseName | string |
| draft | false | Should the release be draft | boolean |
| prerelease | false | Should the release be a prerelease | boolean |
| useChangelog | false | Should the release use the changelog configuration | boolean |
| Option | Required | Description | Params |
|---|---|---|---|
| includeIssues | false | Should issues be included in release | boolean |
| sections | false | The sections configureation | Sections[] |
| title | false | The title for the changelog | string |
| body | false | The changelog body which should be included | string |
| Option | Required | Description | Params |
|---|---|---|---|
| title | true | The title of section | string |
| body | false | A body to add to this section | string |
| PRlabels | true | The pull request labels to include | string[] |
| issueLabels | false | The issue labels to include | string[] |
| includeCommitter | false | Should include the committer username | boolean |
| linkPR | false | Should link the pull request | boolean |
| Option | Required | Description | Params |
|---|---|---|---|
| milestone | true | The milestone you want to use | "version" / string |
| deadline | false | The date in which you want to set as the completion date | string |
| Option | Required | Description | Params |
|---|---|---|---|
| prName | true | What should the pull request be named | "unchanged" / "number" / string |
| titlePrefix | false | Should there be a title prefix | string |
| branches | false | What banches should have the duplicated hotfix | string[] |
| Option | Required | Description | Params |
|---|---|---|---|
| localBranch | true | Which branch should be syncronised | string |
| remoteBranch | true | Which branch should be syncronised | string |
| localPath | true | Which path should be synconised | string |
| remotePath | true | Which path should be syncronised | string |
| Option | Required | Description | Params |
|---|---|---|---|
| ref | false | Overrides the reference | string |
| enforceConventions | false | Enforces conventions | EnforceConventions |
| labels | false | Apply labels automatically | [Key: string]: IssueConditionConfig |
| assignProject | false | Automatically assign to projects | AssignProject[] |
| createBranch | false | Automatically create branches on configuration | [label: string]: CreateBranch |
| Option | Required | Description | Params |
| ------------ | -------- | ------------------------------- | -------- | ------- | --------- |
| branchPrefix | false | Should the branch have a prefix | string |
| branchSuffix | false | Should the branch have a suffix | string |
| branchName | false | Branch name | 'title' | 'short' | 'number' |
'title' - Use the entire title
'short' - Use the first 3 words
'number' - Use the issue number
| Option | Required | Description | Params |
|---|---|---|---|
| ref | false | Overrides the reference | string |
| enforceConventions | false | Enforces conventions | EnforceConventions |
| labels | false | Apply labels automatically | [Key: string]: ProjectConditionConfig |
| syncRemote | false | Syncronise remote projects (e.g. org projects) | ExProjects[] |
| openBranch | false | Create Branch based on config | ProjectCreateBranch |
| assignMilestone | false | Automatically assign to milestones | [milestone: string]: Milestones |
| Option | Required | Description | Params |
|---|---|---|---|
| owner | false | The owner of the project (organisation) | string |
| user | false | The user which owns the project (user) | string |
| repo | false | The repo which contains teh project (requires owner to be set) | string |
| project | true | The name of the project to assign | string |
| Option | Required | Description | Params |
|---|---|---|---|
| onProject | false | Which project shoud be used | string |
| onColumn | false | Which column should be used | string / number |
| branchPrefix | false | Should the branch have a prefix | string |
| branchSuffix | false | Should the branch have a suffix | string |
| branchName | false | Branch name | 'title' / 'short' / 'number' |
'title' - Use the entire title
'short' - Use the first 3 words
'number' - Use the issue number
| Option | Required | Description | Params |
|---|---|---|---|
| onColumn | true | Which column should be used | string |
| ignoreLabels | false | Labels which should be ignored | string[] |
Types
/** @format */
import {
Condition,
IssueCondition,
PRCondition,
ProjectCondition,
ScheduleCondition
} from "../src/conditions"
import { Repo } from "../src/utils"
/**
* Application interfaces
*/
export interface Options {
configPath: string
configJSON: Runners
showLogs: boolean
dryRun: boolean
fillEmpty: boolean
skipDelete: boolean
repo?: Repo
}
export interface Runners {
labels?: Labels
runners: Config[]
}
export interface Config {
root: string
versioning: {
source: VersionSource
type?: VersionType
}
retryLimit?: number
prereleaseName?: string
labels?: { [key: string]: string }
sharedConfig?: SharedConfig
pr?: PullRequestConfig
issue?: IssueConfig
project?: ProjectConfig
schedule?: ScheduleConfig
}
/**
* Config types
*/
export type VersionSource = "node" | "milestones" | string
export type VersionType = "SemVer"
export interface SharedConditions {
requires: number
conditions: Condition[]
}
export interface Label {
name: string
description: string
color: string
}
export interface Labels {
[key: string]: Label
}
export interface PRConditionConfig {
requires: number
conditions: PRCondition[]
}
export interface IssueConditionConfig {
requires: number
conditions: IssueCondition[]
}
export interface ProjectConditionConfig {
requires: number
conditions: ProjectCondition[]
}
export interface ScheduleConditionConfig {
requires: number
conditions: ScheduleCondition[]
}
export interface PullRequestConfig extends SharedConfig {
assignProject?: AssignProject[]
automaticApprove?: AutomaticApprove
manageRelease?: Release
duplicateHotfix?: { [title: string]: DuplicateHotfix }
syncRemote?: SyncRemote[]
}
export interface IssueConfig extends SharedConfig {
assignProject?: AssignProject[]
createBranch?: { [label: string]: CreateBranch }
}
export interface ProjectConfig extends SharedConfig {
syncRemote?: ExProjects[]
openBranch?: ProjectCreateBranch
assignMilestone?: { [milestone: string]: Milestones }
}
export interface ScheduleConfig extends SharedConfig {}
export type SharedConfigIndex =
| "ref"
| "enforceConventions"
| "labels"
| "stale"
export interface SharedConfig {
ref?: string
enforceConventions?: EnforceConventions
stale?: Stale
labels?: {
[key: string]:
| IssueConditionConfig
| ProjectConditionConfig
| PRConditionConfig
| ScheduleConditionConfig
| SharedConditions
}
}
export interface SharedConventionConditions {
requires: number
conditions: Condition[] | string
}
export interface SharedConventionsConfig extends SharedConventionConditions {
failedComment: string
contexts?: string[]
}
export interface CreateBranch {
branchPrefix?: string
branchSuffix?: string
branchName: "title" | "short" | "number"
}
export interface EnforceConventions {
onColumn?: Column[]
commentHeader?: string
commentFooter?: string
moveToColumn?: string
conventions: SharedConventionsConfig[]
}
export interface Stale {
staleLabel: string
stale?: StaleConfig
abandoned?: AbanondedConfig
conditions?: SharedConditions[]
}
export interface StaleConfig extends SharedConditions {
days: number
comment?: string
resolve?: string
commentHeader?: string
commentFooter?: string
}
export interface AbanondedConfig extends StaleConfig {
close?: boolean
lock?: boolean
label: string
}
export interface AutomaticApprove {
commentHeader?: string
commentFooter?: string
conventions: SharedConventionsConfig[]
}
export interface Release extends PRConditionConfig {
labels?: {
build: string
prerelease: string
patch: string
minor: string
major: string
breaking?: string
}
createTag?: boolean
createRelease?: CreateRelease
createMilestone?: CreateMilestone
createPackages?: string[] | string
createChangelog?: Changelog
}
export interface DuplicateHotfix {
prName: "unchanged" | "number" | string
titlePrefix?: string
branches: string[]
}
export interface SyncRemote {
localBranch: string
remoteBranch: string
localPath: string
remotePath: string
conditions: SharedConditions[]
}
export interface ReleaseChanges {
includeIssues?: boolean
sections?: Sections[]
}
export interface Sections {
title: string
body?: string
PRlabels: string[]
issueLabels?: string[]
includeCommitter?: boolean
linkPR?: boolean
}
export interface CreateRelease extends ReleaseChanges {
tagName?: string
tagPrefix?: string
releaseName?: string
releaseNamePrefix?: string
releaseNameSuffix?: string
draft?: boolean
prerelease?: boolean
useChangelog?: boolean
}
export interface Changelog extends ReleaseChanges {
title?: string
body?: string
}
export interface CreateMilestone {
milestone: "version" | string
deadline?: string
}
export type Column = string | number
interface AssignProject extends IssueConditionConfig {
owner?: string
user?: string
repo?: string
project: string
column: string
}
interface ExProjects {
localProject: string
owner?: string
user?: string
repo?: string
project: string
}
interface ProjectCreateBranch extends CreateBranch {
onProject?: string
onColumn?: string
}
interface Milestones {
onColumn: string
ignoreLabels?: string[]
}Many conditions use regular expressions (usually with a pattern parameter).
Since these regular expressions are passed in through JSON strings, there are
some things to pay attention to.
Special characters must be double escaped: pattern: "\\W+$" is equivalent to the Regex: /\W+$/.
If you want to use flags, use the following format: pattern: "/^wip:/i" is equivalent to the Regex: /^wip:/i.
For complex conditions, you can use conditional options such as only, $and and $or. They can be found within the common conditions section.
Allows conditions to be combined to create more advanced conditions. Would require all conditions to return true otherwise it would fail.
{
"type": "$and",
"pattern": [
{
"requires": 1,
"conditions": []
},
{
"requires": 1,
"conditions": []
}
]
}Checks if an issue or pull request's creator's username matches a Regex pattern.
Example:
{
"type": "creatorMatches",
"pattern": "^foo"
}Checks if an issue or pull request's description matches a Regex pattern.
Example:
{
"type": "descriptionMatches",
"pattern": "foo.*bar"
}Checks if an issue or pull request has a specific label applied.
Example:
{
"type": "hasLabel",
"label": "Type - Bug",
"value": "false"
}Checks if an issue or pull request is abandoned.
Example:
{
"type": "isAbandoned",
"stale": 30
}Checks if an issue or pull request is locked.
Example:
{
"type": "isLocked",
"value": true
}Checks if an issue or pull request is open or closed.
Example:
{
"type": "isOpen",
"value": true
}Checks if an issue or pull request is stale.
Example:
{
"type": "isStale",
"stale": 30
}Requires only the number specified in requires to pass otherwise it fails.
{
"type": "$only",
"requires": 1,
"pattern": [
{
"requires": 1,
"conditions": []
},
{
"requires": 1,
"conditions": []
}
]
}Allows conditions to be combined to create more advanced conditions. Would require one conditions to return true otherwise it would fail.
{
"type": "$or",
"pattern": [
{
"requires": 1,
"conditions": []
},
{
"requires": 1,
"conditions": []
}
]
}Checks if branch name matches a Regex pattern.
Example:
{
"type": "branchMatches",
"pattern": "^bugfix\\/"
}Checks if an pull request's changes against min & max values. Note: if max is undefined assumed value is unlimited
Example:
{
"type": "changesSize",
"min": 0,
"max": 100
}Checks if the files modified in the pull request match a glob.
Globs are matched using the minimatch library.
Example:
{
"type": "filesMatch",
"glob": "src/foo/**/*"
}Checks if a pull request has requested a review.
Example:
{
"type": "isApproved",
"value": true,
"required": 1
}Checks if a pull request is a draft.
Example:
{
"type": "isDraft",
"value": true
}Checks if a pull request has requested a review.
Example:
{
"type": "pendingReview",
"value": true
}Checks if a pull request has requested a review.
Example:
{
"type": "requestedChanges",
"value": true
}Checks if the card is in the specified column.
Example:
{
"type": "onColumn",
"project": "Isuues",
"column": "New"
}Thank you for taking the time to look through this repository. If you have liked what you have found, please would you favourite & share. Ideally I would like to get a community behind this project which can ensure that it is maintained, updated and improved as GitActions get more suffisticated.
This project took heavy infulence from IvanFon/super-labeler-action which we are actively maintaining on our fork here: Videndum/label-mastermind. We invite any of the team who worked on his project to come onboard with our version and intend to continue maintaining for a significant while.