Skip to content

Commit 5f73727

Browse files
TheRealFlyingCoderTheRealFlyingCoder
committed
Update github workflow and templates
1 parent 871ae81 commit 5f73727

File tree

8 files changed

+251
-18
lines changed

8 files changed

+251
-18
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
name: '🐛 Bug report'
2+
description: Create a report to help us improve
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Thank you for reporting an issue :pray:.
8+
9+
This issue tracker is for reporting bugs found in `remix-scaffold` (https://github.com/TheRealFlyingCoder/remix-scaffold).
10+
If you have a question about how to achieve something and are struggling, please post a question
11+
inside of `remix-scaffold` Discussions tab: https://github.com/TheRealFlyingCoder/remix-scaffold/discussions
12+
13+
Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:
14+
- `remix-scaffold` Issues tab: https://github.com/TheRealFlyingCoder/remix-scaffold/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
15+
- `remix-scaffold` closed issues tab: https://github.com/TheRealFlyingCoder/remix-scaffold/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed
16+
- `remix-scaffold` Discussions tab: https://github.com/TheRealFlyingCoder/remix-scaffold/discussions
17+
18+
The more information you fill in, the better the community can help you.
19+
- type: textarea
20+
id: description
21+
attributes:
22+
label: Describe the bug
23+
description: Provide a clear and concise description of the challenge you are running into.
24+
validations:
25+
required: true
26+
- type: input
27+
id: link
28+
attributes:
29+
label: Your Example Website or App
30+
description: |
31+
Which website or app were you using when the bug happened?
32+
Note:
33+
- Your bug will may get fixed much faster if we can run your code and it doesn't have dependencies other than the `remix-scaffold` npm package.
34+
- To create a shareable code example you can use Stackblitz (https://stackblitz.com/). Please no localhost URLs.
35+
- Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve.
36+
placeholder: |
37+
e.g. https://stackblitz.com/edit/...... OR Github Repo
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: steps
42+
attributes:
43+
label: Steps to Reproduce the Bug or Issue
44+
description: Describe the steps we have to take to reproduce the behavior.
45+
placeholder: |
46+
1. Go to '...'
47+
2. Click on '....'
48+
3. Scroll down to '....'
49+
4. See error
50+
validations:
51+
required: true
52+
- type: textarea
53+
id: expected
54+
attributes:
55+
label: Expected behavior
56+
description: Provide a clear and concise description of what you expected to happen.
57+
placeholder: |
58+
As a user, I expected ___ behavior but i am seeing ___
59+
validations:
60+
required: true
61+
- type: textarea
62+
id: screenshots_or_videos
63+
attributes:
64+
label: Screenshots or Videos
65+
description: |
66+
If applicable, add screenshots or a video to help explain your problem.
67+
For more information on the supported file image/file types and the file size limits, please refer
68+
to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
69+
placeholder: |
70+
You can drag your video or image files inside of this editor ↓
71+
- type: textarea
72+
id: platform
73+
attributes:
74+
label: Platform
75+
value: |
76+
- OS: [e.g. macOS, Windows, Linux]
77+
- Browser: [e.g. Chrome, Safari, Firefox]
78+
- Version: [e.g. 91.1]
79+
validations:
80+
required: true
81+
- type: textarea
82+
id: additional
83+
attributes:
84+
label: Additional context
85+
description: Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 🤔 Feature Requests & Questions
4+
url: https://github.com/TheRealFlyingCoder/remix-scaffold/discussions
5+
about: Please ask and answer questions here.
6+
- name: 💬 Remix Discord Channel
7+
url: https://rmx.as/discord
8+
about: Interact with other people using Remix 📀
9+
- name: 💬 New Updates (Twitter)
10+
url: https://twitter.com/remix_run
11+
about: Stay up to date with Remix news on twitter
12+
- name: 🍿 Remix YouTube Channel
13+
url: https://www.youtube.com/channel/UC_9cztXyAZCli9Cky6NWWwQ
14+
about: Are you a techlead or wanting to learn more about Remix in depth? Checkout the Remix YouTube Channel

‎.github/release.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
changelog:
2+
categories:
3+
- title: Documentation Changes
4+
labels:
5+
- documentation
6+
- title: New Features
7+
labels:
8+
- enhancement
9+
- title: Bug Fixes
10+
labels:
11+
- bug
12+
- title: Other Changes
13+
labels:
14+
- "*"

‎.github/workflows/bump.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Bump version
2+
3+
on:
4+
workflow_dispatch:
5+
inputs:
6+
version:
7+
description: 'Type of version (major / minor / patch)'
8+
required: true
9+
10+
jobs:
11+
bump-version:
12+
name: Bump version
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Check out source
16+
uses: actions/checkout@v2
17+
with:
18+
ssh-key: ${{ secrets.DEPLOY_KEY }}
19+
- name: Setup Node.js
20+
uses: actions/setup-node@v2
21+
with:
22+
node-version: '16'
23+
cache: 'npm'
24+
- name: Install dependencies
25+
uses: bahmutov/npm-install@v1
26+
- name: Setup Git
27+
run: |
28+
git config user.name '${{ secrets.GIT_USER_NAME }}'
29+
git config user.email '${{ secrets.GIT_USER_EMAIL }}'
30+
- name: bump version
31+
run: npm version ${{ github.event.inputs.version }}
32+
33+
- name: Push latest version
34+
run: git push origin main --follow-tags

‎.github/workflows/deployment.yml‎

Lines changed: 0 additions & 17 deletions
This file was deleted.

‎.github/workflows/main.yml‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
name: CI
2+
3+
on: [push]
4+
5+
jobs:
6+
build:
7+
name: Build
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout repo
11+
uses: actions/checkout@v2
12+
13+
- name: Use Node 14
14+
uses: actions/setup-node@v1
15+
with:
16+
node-version: 14
17+
18+
- name: Install dependencies
19+
uses: bahmutov/npm-install@v1
20+
21+
- name: Build
22+
run: npm run build
23+
24+
typecheck:
25+
name: Typechecker
26+
runs-on: ubuntu-latest
27+
steps:
28+
- name: Checkout repo
29+
uses: actions/checkout@v2
30+
31+
- name: Use Node 14
32+
uses: actions/setup-node@v1
33+
with:
34+
node-version: 14
35+
36+
- name: Install dependencies
37+
uses: bahmutov/npm-install@v1
38+
39+
- name: Typecheck
40+
run: npm run typecheck
41+
42+
test:
43+
name: Unit and Integration Tests
44+
runs-on: ubuntu-latest
45+
steps:
46+
- name: Checkout repo
47+
uses: actions/checkout@v2
48+
49+
- name: Use Node 14
50+
uses: actions/setup-node@v1
51+
with:
52+
node-version: 14
53+
54+
- name: Install dependencies
55+
uses: bahmutov/npm-install@v1
56+
57+
- name: Test
58+
run: npm run test -- --ci --coverage --maxWorkers=2
59+
60+
lint:
61+
name: Linter
62+
runs-on: ubuntu-latest
63+
steps:
64+
- name: Checkout repo
65+
uses: actions/checkout@v2
66+
67+
- name: Use Node 14
68+
uses: actions/setup-node@v1
69+
with:
70+
node-version: 14
71+
72+
- name: Install dependencies
73+
uses: bahmutov/npm-install@v1
74+
75+
- name: Build
76+
run: npm run build
77+
78+
- name: Lint
79+
run: npm run lint

‎.github/workflows/publish.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Publish
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v1
12+
- uses: actions/setup-node@v1
13+
with:
14+
node-version: 14
15+
registry-url: https://registry.npmjs.org/
16+
- run: npm install
17+
- run: npm run build
18+
- run: npm publish --access public
19+
env:
20+
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

‎package.json‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,11 @@
1717
"remix",
1818
"scaffolding"
1919
],
20-
"author": "Thomas Rowe",
20+
"author": {
21+
"name": "Tom Rowe",
22+
"email": "theflyingcoder@hotmail.com",
23+
"url": "https://github.com/TheRealFlyingCoder"
24+
},
2125
"repository": {
2226
"url": "https://github.com/TheRealFlyingCoder/remix-scaffold",
2327
"type": "git"

0 commit comments

Comments
 (0)