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

Create gh action #77

Merged
merged 4 commits into from
Aug 7, 2020
Merged

Create gh action #77

merged 4 commits into from
Aug 7, 2020

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Jan 21, 2020

Testing on push

Description

This PR creates a github CI action for testing on push to the repository to ensure that changes in repo do not break it.

Other information

Checklist:

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the master branch of the repository.
  • My commit messages follow best practices.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or

(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or

(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.

(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.

Copy link
Member

@akmadian akmadian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel free to merge whenever :) I think this is a good place to start, but building and testing on every push may become burdensome. Maybe remove testing on push, and add an action for PRs that does the whole thing?

@akmadian
Copy link
Member

Marking as blocked because the current tests will always fail. Once tests are re-written, we can merge :)

@akmadian akmadian mentioned this pull request Feb 26, 2020
14 tasks
@akmadian akmadian removed the blocked label Feb 28, 2020
@obulat obulat requested review from a team and brenoferreira and removed request for a team March 8, 2020 12:47
Copy link
Member

@akmadian akmadian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should have the name of each workflow be what it's triggered by. For example, the workflow for pushes should be called push.yml, the workflow for PRs should be called PR.yml, etc. Also, the build checks are currently failing, so we should get that figured out before merge.

I think we should add a PR workflow that does the following:

  • Build (node 8.x, 10.x, and 12.x)
  • Lint
  • Test

and change the push workflow to:

  • Lint
  • unit test

This would allow us to cut down on resource usage, and keep the workflow on more common triggers slimmer and faster, while running the whole battery for major sets of changes that occur less often (PRs). Thoughts?

Testing on push
On push: lint and test
On push to master branch (basically on merging a PR): build and publish by copying files from dist to docs and adding CNAME
@obulat
Copy link
Contributor Author

obulat commented Jul 31, 2020

Now that we have more tests ready, we should start using github actions to lint and test any new code.

I have added two workflows:

  • On each push, we run linting and testing
  • On each push to master branch we run build and copy build files to docs folder for deploy. I used push to master hook because there is no such hook as PR merged, and push to master will occur when we directly push something into master (which shouldn't happen often), or when something is merged into master.

@obulat obulat requested review from akmadian and zackkrida and removed request for brenoferreira July 31, 2020 19:53
@obulat obulat removed the request for review from akmadian July 31, 2020 20:11
@obulat obulat dismissed akmadian’s stale review August 7, 2020 20:10

Requested changes have been addressed.

@obulat obulat merged commit e05c8a6 into master Aug 7, 2020
@obulat obulat deleted the obulat-gh-action branch August 7, 2020 20:12
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.

3 participants