Skip to content

Commit

Permalink
Add GitHub Actions CI
Browse files Browse the repository at this point in the history
  • Loading branch information
DABH committed Jul 10, 2023
1 parent 2c97869 commit 83f8d9c
Show file tree
Hide file tree
Showing 6 changed files with 165 additions and 2 deletions.
75 changes: 75 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
name: Have you encountered an issue?
description: Report an issue with Winston.
title: "[Bug]: "
labels: ["Bug", "Needs Investigation"]
body:
- type: markdown # Form Header
attributes:
value: >-
This issue form is for reporting bugs only!
- type: input # Search Terms
validations:
required: true
attributes:
label: 🔎 Search Terms
description: >-
What search terms did you use when trying to find an existing bug report, looking in both open and closed issues?
List them here (comma seperated) so people in the future can find this one more easily.
- type: textarea # Problem Definition
validations:
required: true
attributes:
label: The problem
description: >-
Please provide a clear and concise description of the problem you've encountered and what the
expected behavior was.
- type: markdown # Environment Section Header
attributes:
value: |
## Environment
- type: input # Affected Version Input
id: winston-version
validations:
required: true
attributes:
label: What version of Winston presents the issue?
placeholder: v3.4.0
description: >
Can be found by running one of the following (depending on your package manager of choice):
- `npm list winston`
- `yarn list --pattern winston`
- type: input # Affected Version Input
id: node-version
validations:
required: true
attributes:
label: What version of Node are you using?
placeholder: v16.8.0
description: >
Can be found by running the following: `node -v`
- type: input # Last Known Working Version
attributes:
label: If this worked in a previous version of Winston, which was it?
placeholder: v3.0.0
description: >
If known, otherwise please leave blank.
- type: markdown # Details Section Header
attributes:
value: |
# Details
- type: textarea # Minimum Working Example Input
attributes:
label: Minimum Working Example
description: |
If you can, providing an MWE to reproduce the issue you're encountering can greatly speed up
investigation into the issue by one of our maintainers, or anyone else in the community who's looking
to get involved.
This can be as simple as a script, a link to a repo, etc.
If using a script please wrap with triple backticks and language. EG:
` ```javascript `
- type: textarea # Additional Information
attributes:
label: Additional information
description: >
If you have any additional information for us that you feel will be valuable, please use the field below.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Have a formatting issue or feature request?
url: https://github.com/winstonjs/logform/issues/new/choose
about: Please search and report @ WinstonJS/Logform
- name: Need help using Winston?
url: https://stackoverflow.com/questions/tagged/winston
about: Please look on StackOverflow first to see if someone has already answered your question.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Would you like to see a feature implemented?
description: Request a new feature for Winston
title: "[Feature Request]: "
labels: ["Feature Request", "Needs Investigation"]
body:
- type: markdown # Form Header
attributes:
value: |
This issue form is for requesting features only!
- type: input # Search Terms
validations:
required: true
attributes:
label: 🔎 Search Terms
description: >-
What search terms did you use when trying to find an existing feature request, looking in both open and closed issues?
List them here (comma seperated) so people in the future can find this one more easily.
- type: textarea # Feature Definition
validations:
required: true
attributes:
label: The vision
description: >-
Please provide a clear and concise description of the feature you would like to see implemented.
- type: markdown # Feature Details Section
attributes:
value: |
# Details
- type: textarea # Use Case Input
attributes:
label: Use case
description: |
If you desire you can provide use cases for the requested feature.
- type: textarea # Additional Information
attributes:
label: Additional information
description: >
If you have any additional information for us that you feel will be valuable, please use the field below.
10 changes: 10 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
version: 2
updates:
- package-ecosystem: github-actions
directory: /
schedule:
interval: weekly
- package-ecosystem: npm
directory: /
schedule:
interval: weekly
32 changes: 32 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: CI

on:
pull_request:
branches:
- main
- master
push:
branches:
- main
- master

jobs:
unit-tests:
runs-on: ubuntu-latest
strategy:
matrix:
node:
- 16
- 18
- 20
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node }}
- name: Install Dependencies
run: npm clean-install
- name: Lint
run: npm run lint
- name: Test
run: npm test
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 83f8d9c

Please sign in to comment.