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

Avoid concurrent workflows #522

Merged
merged 1 commit into from
Jun 10, 2022

Conversation

jonseitz
Copy link
Contributor

@jonseitz jonseitz commented Jun 8, 2022

The concurrency field prevents multiple instances of the same
workflow (or any two workflows with the same concurrency value) from
running at the same time. It will also cancel/replace pending workflows
when the new one attempts to run. That could put us in an edge case
where a PR test run could be skipped, but I think a skipped test run is
probably better in the long run than a failed test run. In either case,
this should not affect any active workflows.

I've added individual concurrency groups for the test, versioning,
documentation, and publication stages. The PR check workflow is simple
enough that it shouldn't have any problems running concurrently, but we
can always revisit in the future.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality
    to change)

Checklist:

  • I have run eslint on the code
  • I have added JSDoc for all of my code (where applicable)
  • I have added tests to cover my changes.

Priority:

  • Normal
  • High

Related Issues:

Fixes #521

The concurrency[1] field prevents multiple instances of the same
workflow (or any two workflows with the same concurrency value) from
running at the same time. It will also cancel/replace pending workflows
when the new one attempts to run. That could put us in an edge case
where a PR test run could be skipped, but I think a skipped test run is
probably better in the long run than a failed test run. In either case,
this should not affect any active workflows.

I've added individual concurrency groups for the test, versioning,
documentation, and publication stages. The PR check workflow is simple
enough that it shouldn't have any problems running concurrently, but we
can always revisit in the future.

[1]:
https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#concurrency
@jonseitz jonseitz requested a review from rmainwork June 8, 2022 20:10
@jonseitz jonseitz changed the base branch from main to develop June 8, 2022 20:11
@codecov
Copy link

codecov bot commented Jun 8, 2022

Codecov Report

Merging #522 (fe6fe70) into develop (bbec275) will not change coverage.
The diff coverage is n/a.

❗ Current head fe6fe70 differs from pull request most recent head 95ddf6c. Consider uploading reports for the commit 95ddf6c to get more accurate results

@@           Coverage Diff            @@
##           develop     #522   +/-   ##
========================================
  Coverage    96.11%   96.11%           
========================================
  Files          176      176           
  Lines         3704     3704           
  Branches       432      432           
========================================
  Hits          3560     3560           
  Misses          68       68           
  Partials        76       76           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 79a6e14...95ddf6c. Read the comment docs.

Copy link
Contributor

@rmainwork rmainwork left a comment

Choose a reason for hiding this comment

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

This is good to go!

@jonseitz jonseitz merged commit d38b1cf into develop Jun 10, 2022
@jonseitz jonseitz deleted the bugfix/521-avoid-simultaneous-workflows branch June 10, 2022 14:40
@jonseitz jonseitz mentioned this pull request Jun 10, 2022
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.

Avoid running simultaneous test workflows
2 participants