Skip to content

Commit 83f8d9c

Browse files
committed
Add GitHub Actions CI
1 parent 2c97869 commit 83f8d9c

File tree

6 files changed

+165
-2
lines changed

6 files changed

+165
-2
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
name: Have you encountered an issue?
2+
description: Report an issue with Winston.
3+
title: "[Bug]: "
4+
labels: ["Bug", "Needs Investigation"]
5+
body:
6+
- type: markdown # Form Header
7+
attributes:
8+
value: >-
9+
This issue form is for reporting bugs only!
10+
- type: input # Search Terms
11+
validations:
12+
required: true
13+
attributes:
14+
label: 🔎 Search Terms
15+
description: >-
16+
What search terms did you use when trying to find an existing bug report, looking in both open and closed issues?
17+
List them here (comma seperated) so people in the future can find this one more easily.
18+
- type: textarea # Problem Definition
19+
validations:
20+
required: true
21+
attributes:
22+
label: The problem
23+
description: >-
24+
Please provide a clear and concise description of the problem you've encountered and what the
25+
expected behavior was.
26+
- type: markdown # Environment Section Header
27+
attributes:
28+
value: |
29+
## Environment
30+
- type: input # Affected Version Input
31+
id: winston-version
32+
validations:
33+
required: true
34+
attributes:
35+
label: What version of Winston presents the issue?
36+
placeholder: v3.4.0
37+
description: >
38+
Can be found by running one of the following (depending on your package manager of choice):
39+
- `npm list winston`
40+
- `yarn list --pattern winston`
41+
- type: input # Affected Version Input
42+
id: node-version
43+
validations:
44+
required: true
45+
attributes:
46+
label: What version of Node are you using?
47+
placeholder: v16.8.0
48+
description: >
49+
Can be found by running the following: `node -v`
50+
- type: input # Last Known Working Version
51+
attributes:
52+
label: If this worked in a previous version of Winston, which was it?
53+
placeholder: v3.0.0
54+
description: >
55+
If known, otherwise please leave blank.
56+
- type: markdown # Details Section Header
57+
attributes:
58+
value: |
59+
# Details
60+
- type: textarea # Minimum Working Example Input
61+
attributes:
62+
label: Minimum Working Example
63+
description: |
64+
If you can, providing an MWE to reproduce the issue you're encountering can greatly speed up
65+
investigation into the issue by one of our maintainers, or anyone else in the community who's looking
66+
to get involved.
67+
68+
This can be as simple as a script, a link to a repo, etc.
69+
If using a script please wrap with triple backticks and language. EG:
70+
` ```javascript `
71+
- type: textarea # Additional Information
72+
attributes:
73+
label: Additional information
74+
description: >
75+
If you have any additional information for us that you feel will be valuable, please use the field below.

.github/ISSUE_TEMPLATE/config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Have a formatting issue or feature request?
4+
url: https://github.com/winstonjs/logform/issues/new/choose
5+
about: Please search and report @ WinstonJS/Logform
6+
- name: Need help using Winston?
7+
url: https://stackoverflow.com/questions/tagged/winston
8+
about: Please look on StackOverflow first to see if someone has already answered your question.
+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Would you like to see a feature implemented?
2+
description: Request a new feature for Winston
3+
title: "[Feature Request]: "
4+
labels: ["Feature Request", "Needs Investigation"]
5+
body:
6+
- type: markdown # Form Header
7+
attributes:
8+
value: |
9+
This issue form is for requesting features only!
10+
- type: input # Search Terms
11+
validations:
12+
required: true
13+
attributes:
14+
label: 🔎 Search Terms
15+
description: >-
16+
What search terms did you use when trying to find an existing feature request, looking in both open and closed issues?
17+
List them here (comma seperated) so people in the future can find this one more easily.
18+
- type: textarea # Feature Definition
19+
validations:
20+
required: true
21+
attributes:
22+
label: The vision
23+
description: >-
24+
Please provide a clear and concise description of the feature you would like to see implemented.
25+
- type: markdown # Feature Details Section
26+
attributes:
27+
value: |
28+
# Details
29+
- type: textarea # Use Case Input
30+
attributes:
31+
label: Use case
32+
description: |
33+
If you desire you can provide use cases for the requested feature.
34+
- type: textarea # Additional Information
35+
attributes:
36+
label: Additional information
37+
description: >
38+
If you have any additional information for us that you feel will be valuable, please use the field below.

.github/dependabot.yml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: github-actions
4+
directory: /
5+
schedule:
6+
interval: weekly
7+
- package-ecosystem: npm
8+
directory: /
9+
schedule:
10+
interval: weekly

.github/workflows/ci.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: CI
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
- master
8+
push:
9+
branches:
10+
- main
11+
- master
12+
13+
jobs:
14+
unit-tests:
15+
runs-on: ubuntu-latest
16+
strategy:
17+
matrix:
18+
node:
19+
- 16
20+
- 18
21+
- 20
22+
steps:
23+
- uses: actions/checkout@v3
24+
- uses: actions/setup-node@v3
25+
with:
26+
node-version: ${{ matrix.node }}
27+
- name: Install Dependencies
28+
run: npm clean-install
29+
- name: Lint
30+
run: npm run lint
31+
- name: Test
32+
run: npm test

package-lock.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)