Skip to content

Commit

Permalink
ci: update the workflow, issue and pr templates
Browse files Browse the repository at this point in the history
  • Loading branch information
wewoor committed Feb 2, 2021
2 parents e4903d9 + 1f31d1d commit 87e9ec3
Show file tree
Hide file tree
Showing 4 changed files with 113 additions and 33 deletions.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**

- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**

- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
21 changes: 21 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# 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.

Fixes # (issue)

# How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Please also note any relevant details for your test configuration.

- [ ] Test A
- [ ] Test B

# Checklist:

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] Any dependent changes have been merged and published in downstream modules
66 changes: 33 additions & 33 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,42 @@

name: CI

# Controls when the action will run.
# Controls when the action will run.
on: [push, pull_request] # Triggers the workflow on push or pull request events

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
install:
runs-on: ubuntu-latest
steps:
- run: echo "Install the dependencies."
- run: yarn install --cache-folder .yarn

static-checking:
runs-on: ubuntu-latest
steps:
- name: Run Check Types
run: yarn check-types
- name: Run ESlint
run: yarn eslint
- name: Run Prettier
run: yarn prettier --check
- name: Run StyleLint
run: yarn stylelint
install:
runs-on: ubuntu-latest
steps:
- run: echo "Install the dependencies."
- run: yarn install --cache-folder .yarn

build:
runs-on: ubuntu-latest
needs: [install]
steps:
- name: Run Build
run: yarn build

test:
runs-on: ubuntu-latest
needs: [install]
steps:
- name: Run Unit Test
run: yarn test
static-checking:
runs-on: ubuntu-latest
steps:
- name: Run Check Types
run: yarn check-types
- name: Run ESlint
run: yarn eslint
- name: Run Prettier
run: yarn prettier --check
- name: Run StyleLint
run: yarn stylelint

build:
runs-on: ubuntu-latest
needs: [install]
steps:
- name: Run Build
run: yarn build

test:
runs-on: ubuntu-latest
needs: [install]
steps:
- name: Run Unit Test
run: yarn test

0 comments on commit 87e9ec3

Please sign in to comment.