Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Github Actions + new PR Template #274

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

BeauBouchard
Copy link

@BeauBouchard BeauBouchard commented Dec 29, 2021

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 #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...)

  • You can read more about Github Actions at the documentation reference here.
  • There is also a robust peer reviewed marketplace of open source resources that help to create more scalable CI solutions quickly. It also is more friendly for maintaining collaboratively compared to making a team on travis and sharing permissions.

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.

  • There is a good explanation of setting it up here.

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 #272, which will publish to NPM on merges into main.

@BeauBouchard
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant