bithavoc / express-winston

express.js middleware for winstonjs
https://www.npmjs.com/package/express-winston
MIT License
797 stars 186 forks source link

Github Actions + new PR Template #274

Open BeauBouchard opened 2 years ago

BeauBouchard commented 2 years ago

Description

I wrote a quick github action workflow that will run lint and tests for all the versions the previous travis one did. I outlined some benefits in https://github.com/bithavoc/express-winston/issues/272 to do this, as well as the need to get the CI working again for PR contributions.

About Github Actions

Once merged they will start running on all pushed commits to PRs. I only added CI in this PR for introduction and to get it working on other PRs. It will run through a matrix of the node versions and perform both a lint/test on each. (maybe dont need to lint each version...)

About Github PR Template

Really simple, just provides a default PR description so you can structure how contributions are formed. It also facilitates notes that can help the PR reviewer.

The structure is markdown and i included 3 simple sections and invisible descriptions that are a good start. They can evolve over time depending on how you want to change them, but importantly having the file there allows others to change it.

Risk/Impact Analysis

Low Risk / Non-code changes

QA Notes

Setup a new workflow, or authorize me to setup the workflow in the settings of the repo.

We will need a followup ticket which i can outline in https://github.com/bithavoc/express-winston/issues/272, which will publish to NPM on merges into main.

BeauBouchard commented 2 years ago

@bithavoc mind checking this PR out? or is this repo totally unmaintained?