-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feature: Add issue and pull request templates + automation
- Loading branch information
Showing
8 changed files
with
210 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,70 @@ | ||
# Light It Pull Request Template ⚡⚡⚡ | ||
# ⚡ {0} - [{1}](https://app.clickup.com/t/{2}) ⚡ | ||
|
||
_Resolve_: [closes -###](https://link-to-your-ticket) | ||
## 💻 What type of change is this? | ||
|
||
## Description and Requires ⭐ | ||
- [{3}] 💎 Feature | ||
- [{4}] 🐛 Bug Fix | ||
- [ ] 📝 Documentation Update | ||
- [ ] 🎨 Styling | ||
- [ ] 🧑💻 Code Refactor | ||
- [ ] 🔥 Performance Improvements | ||
- [ ] ✅ Test | ||
- [ ] 🤖 Build / CI | ||
|
||
## ⭐ Description | ||
|
||
<!-- | ||
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. | ||
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. | ||
Example: | ||
--> | ||
|
||
I've added support for authentication to implement Key Result 2 of OKR1. It includes | ||
model, table, controller and test. For more background, see ticket #CU-834794. | ||
|
||
- [ ] This change requires a database update or migration | ||
- [ ] This change requires a documentation update | ||
For more background, see ticket **{1}[in-progress].** | ||
|
||
## Proof of Test (optional) 📷 | ||
<!-- | ||
ONLY ADD SECTION IF A NEW PACKAGE IS ADDED | ||
### Requires | ||
This pr requires the following packages to be installed: | ||
- `package1` | ||
- `package2` | ||
The packages are used for `reason1` and `reason2`. | ||
Include Screenshots if is necessary. | ||
Because of this, you must run `npm i` before starting. | ||
--> | ||
|
||
### How Has This Been Tested? ❓ | ||
## 📷 Screenshots | ||
|
||
<!-- | ||
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration | ||
Please include before AND after screenshots of the change, or proof of test about your branch | ||
--> | ||
|
||
- [ ] Test A | ||
- [ ] Test B | ||
### Before | ||
|
||
![image](https://github.com/Light-it-labs/lightranet/assets/17851841/f55f13c3-0f79-4d38-a6d9-51444daf3c81) | ||
|
||
### After | ||
|
||
## Checklist ✅ | ||
![image](https://github.com/Light-it-labs/lightranet/assets/17851841/38fd90e3-09e0-4af4-85e0-b8801d479f8c) | ||
|
||
|
||
## 💬 Comments | ||
|
||
<!-- | ||
Please describe any known issues, bugs, or unintended consequences with this change. Also, please include any additional comments you feel are relevant to the reviewer. | ||
Ex: | ||
This pr is blocked by #1234. | ||
Im awaiting backend changes to be merged before I can complete this, etc. | ||
This | ||
--> | ||
|
||
## ✅ Checklist | ||
### To review | ||
- [ ] I have tested this change locally in multiple screen sizes | ||
- [ ] My code follows the style guidelines of this project | ||
- [ ] I have performed a self-review of my own code | ||
- [ ] I have made corresponding changes to the documentation | ||
- [ ] My changes generate no new warnings | ||
- [ ] I have added tests that prove my fix is effective or that my feature works | ||
- [ ] New and existing unit tests pass locally with my changes | ||
- [ ] If my task include an endpoint, I add the endpoint to Hopscotch/Postman Project | ||
- [ ] Any dependent changes have been merged and published in downstream modules |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# To get started with Dependabot version updates, you'll need to specify which | ||
# package ecosystems to update and where the package manifests are located. | ||
# Please see the documentation for all configuration options: | ||
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file | ||
|
||
version: 2 | ||
updates: | ||
- package-ecosystem: "npm" # See documentation for possible values | ||
directory: "/" # Location of package manifests | ||
schedule: | ||
interval: "weekly" | ||
|
||
- package-ecosystem: "composer" # See documentation for possible values | ||
directory: "/" # Location of package manifests | ||
schedule: | ||
interval: "weekly" | ||
|
||
- package-ecosystem: "github-actions" | ||
# Workflow files stored in the default location of `.github/workflows`. (You don't need to specify `/.github/workflows` for `directory`. You can use `directory: "/"`.) | ||
directory: "/" | ||
schedule: | ||
interval: "weekly" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
draft: | ||
- changed-files: | ||
- any-glob-to-any-file: '**' | ||
|
||
feature: | ||
- head-branch: ['^feature', 'feature'] | ||
|
||
bugfix: | ||
- head-branch: [ '^bugfix', 'bugfix' ] | ||
|
||
hotfix: | ||
- head-branch: [ '^hotfix', 'hotfix' ] | ||
|
||
release: | ||
- base-branch: 'main' | ||
|
||
have testing: | ||
- changed-files: | ||
- any-glob-to-any-file: tests/** | ||
|
||
migrations: | ||
- changed-files: | ||
- any-glob-to-any-file: database/migrations/** | ||
|
||
dependencies: | ||
- changed-files: | ||
- any-glob-to-any-file: ['composer.**', 'package.**', 'package-lock.**', 'yarn.lock', 'yarn.lock', 'pnpm-lock.**'] | ||
|
||
change env: | ||
- changed-files: | ||
- any-glob-to-any-file: '.env.**' | ||
|
||
include command: | ||
- changed-files: | ||
- any-glob-to-any-file: 'src/Shared/App/Console/**' | ||
|
||
documentation: | ||
- changed-files: | ||
- any-glob-to-any-file: ['README.**', 'docs/**'] | ||
|
||
refactor: | ||
- head-branch: [ '^refactor', 'refactor' ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
needs review: | ||
- changed-files: | ||
- any-glob-to-any-file: '**' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
name: Labeler | ||
on: | ||
workflow_dispatch: | ||
pull_request: | ||
types: | ||
- opened | ||
|
||
jobs: | ||
label: | ||
|
||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: read | ||
pull-requests: write | ||
|
||
steps: | ||
- uses: actions/labeler@v5 | ||
with: | ||
repo-token: "${{ secrets.GITHUB_TOKEN }}" | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
name: Review Labeler | ||
on: | ||
workflow_dispatch: | ||
pull_request: | ||
types: | ||
- review_requested | ||
|
||
jobs: | ||
label: | ||
|
||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: read | ||
pull-requests: write | ||
|
||
steps: | ||
- uses: actions/labeler@v5 | ||
with: | ||
repo-token: "${{ secrets.GITHUB_TOKEN }}" | ||
configuration-path: ".github/review-label.yml" | ||
|
||
remove_label: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: actions-ecosystem/action-remove-labels@v1 | ||
with: | ||
labels: draft | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
name: Set PR title | ||
|
||
on: | ||
pull_request: | ||
types: | ||
- opened | ||
|
||
jobs: | ||
set-title: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Set PR title | ||
uses: actions/github-script@v7 | ||
with: | ||
github-token: ${{ secrets.GITHUB_TOKEN }} | ||
script: | | ||
const { owner, repo, number: pull_number } = context.issue; | ||
const pr = context.payload.pull_request; | ||
const body = pr.body; | ||
const branchName = pr.head.ref; | ||
const [type, id, description] = branchName.split('/'); | ||
const title = `[${id}] ${description.split("-").join(' ')}`; | ||
const format = (str, ...args) => { | ||
return str.replace(/{(\d+)}/g, (match, number) => { | ||
return typeof args[number] !== 'undefined' ? args[number] : match; | ||
}); | ||
}; | ||
const templateTitle = description.split("-").join(' ').replace(/\b\w/g, function(l){ return l.toUpperCase() }); | ||
const taskCode = id.split("CU-").join(''); | ||
const isFeature = type === 'feature' ? 'x' : ' '; | ||
const isBugfix = ["bugfix", "hotfix"].includes(type) ? 'x' : ' '; | ||
const updatedBody = format(body, templateTitle, id, taskCode, isFeature, isBugfix); | ||
await github.rest.pulls.update({ | ||
owner, | ||
repo, | ||
pull_number, | ||
title, | ||
body: updatedBody | ||
}); |