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

test: Additional Improvements to CI Workflows #2438

Merged
merged 8 commits into from
Sep 8, 2023

Conversation

evansims
Copy link
Member

@evansims evansims commented Aug 28, 2023

Changes

This pull request updates our continuous integration workflows:

codeql.yml

  • Updated pull_request type triggers to use a narrower scope (avoids unnecessary runs.)
  • Updated push branch triggers to be more concise (uses the v* wildcard.)
  • Added concurrency check (cancels redundant in-progress runs.)

publish.yml

  • Removed the NODE_VERSION environmental variable reference (hardcoded 18 value.)

semgrep.yml

  • Updated to skip unnecessary runs on Dependabot PRs and re-runs on merge group queues.
  • Updated name to use "Check for Vulnerabilities" for clarity in branch protection filters.
  • Added concurrency check (cancels redundant in-progress runs.)

snyk.yml

  • Added workflow to trigger Snyk security checks.
    We previously used webhooks to trigger these checks, but this method is incompatible with GitHub's merge queue feature. This approach allows us to use the feature, as well as to autonomously run checks on a set schedule as we do in other repositories.

test.yml

  • Updated environment check to allow Dependabot PRs to run without approval.

References

Updates based on internal feedback and conversations.

Testing

This pull request applies improvements to the continuous integration testing for the repository but does not add additional tests.

Checklist

@evansims evansims temporarily deployed to internal August 28, 2023 22:07 — with GitHub Actions Inactive
@evansims evansims temporarily deployed to internal August 28, 2023 22:07 — with GitHub Actions Inactive
@evansims evansims temporarily deployed to internal August 28, 2023 22:09 — with GitHub Actions Inactive
@evansims evansims temporarily deployed to internal August 28, 2023 22:10 — with GitHub Actions Inactive
@evansims evansims temporarily deployed to internal August 28, 2023 22:10 — with GitHub Actions Inactive
@evansims evansims temporarily deployed to internal August 28, 2023 22:11 — with GitHub Actions Inactive
@evansims evansims temporarily deployed to internal August 28, 2023 22:11 — with GitHub Actions Inactive
@evansims evansims temporarily deployed to internal August 28, 2023 22:12 — with GitHub Actions Inactive
@evansims evansims temporarily deployed to internal August 28, 2023 22:12 — with GitHub Actions Inactive
@evansims evansims added the review:small Small review label Aug 28, 2023
@evansims evansims marked this pull request as ready for review August 28, 2023 22:15
@evansims evansims requested a review from a team as a code owner August 28, 2023 22:15
@codecov
Copy link

codecov bot commented Aug 28, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (7a6ddd3) 41.55% compared to head (9190120) 41.55%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2438   +/-   ##
=======================================
  Coverage   41.55%   41.55%           
=======================================
  Files         120      120           
  Lines        3025     3025           
  Branches      325      325           
=======================================
  Hits         1257     1257           
  Misses       1674     1674           
  Partials       94       94           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@evansims evansims changed the title test: Improvements to CI Workflow (2) test: Improvements to CI Workflows #2 Aug 28, 2023
@evansims evansims changed the title test: Improvements to CI Workflows #2 test: Additional Improvements to CI Workflows Aug 28, 2023
github-merge-queue bot pushed a commit to auth0/auth0-spa-js that referenced this pull request Aug 29, 2023
<!-- By submitting a PR to this repository, you agree to the terms
within the [Auth0 Code of
Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md).
Please see the [contributing
guidelines](https://github.com/auth0/.github/blob/master/CONTRIBUTING.md)
for how to create and submit a high-quality PR for this repo. -->

### Changes

This pull request updates our continuous integration workflows. It (in
part) mirrors [improvements made to the Lock
repository](auth0/lock#2438).

#### codeql.yml

- Updated `pull_request` type triggers to use a narrower scope (avoids
unnecessary runs) and apply to all branches.
- Updated `push` branch triggers to be more concise (uses the `v*`
wildcard.)
- Added concurrency check (cancels redundant in-progress runs.)
- Updated to skip unnecessary runs on Dependabot PRs and re-runs on
merge group queues.

#### publish.yml

- Fixed the `NODE_VERSION` environmental variable reference.

#### semgrep.yml

- Updated to skip unnecessary runs on Dependabot PRs and re-runs on
merge group queues.
- Updated name to use "Check for Vulnerabilities" for clarity in branch
protection filters.
- Added concurrency check (cancels redundant in-progress runs.)

#### snyk.yml

- Added workflow to trigger Snyk security checks.
We previously used webhooks to trigger these checks, but this method is
incompatible with GitHub's merge queue feature. This approach allows us
to use the feature, as well as to autonomously run checks on a set
schedule as we do in other repositories.

#### test.yml

- Moves the Codecov coverage upload step into the unit test step (fixes
coverage not being available during the build step.)

### References

Updates based on internal feedback and conversations.

### Testing

This pull request applies improvements to the continuous integration
testing for the repository but does not add additional tests.

### Checklist

- [x] I have read the [Auth0 general contribution
guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md)
- [x] I have read the [Auth0 Code of
Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md)
- [x] All code quality tools/guidelines have been run/followed
@evansims evansims temporarily deployed to internal September 8, 2023 07:36 — with GitHub Actions Inactive
@evansims evansims temporarily deployed to internal September 8, 2023 07:36 — with GitHub Actions Inactive
@evansims evansims merged commit c9a2598 into master Sep 8, 2023
5 checks passed
@evansims evansims deleted the test/ci-workflow-improvements branch September 8, 2023 07:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review:small Small review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant