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

Add API cooldown #31

Merged
merged 9 commits into from
Jan 22, 2024
Merged

Add API cooldown #31

merged 9 commits into from
Jan 22, 2024

Conversation

MillironX
Copy link
Member

A temporary solution to #19, until we can swap out OctoKit with our own API.

GitHub has a plugin that automatically backs off on OctoKit requests based on the retry headers. There were a few internals and dependencies that needed to be rearranged for it to work, but everything seems to have stayed the same on my end.

@edmundmiller, I would love for you to open a pull request on sarek, or modules or something ridiculously big like that, stuff the action workflow full of nextflow versions to test against, point to this branch, and see if the cooldown functionality actually works. I'll do the same on my (much smaller) pipelines.

The GitHub actions API changes the underlying type structure to allow
for plugins like the throttling plugin at v6, so update to that version.
These tests are no longer used since the switch to OctokitWrapper, and
conflict with packages required for the implementation of throttling, so
remove them.
@MillironX
Copy link
Member Author

I created a branch with a built version of this PR that should allow anyone to test it in their workflows.

      - name: Install Nextflow
        uses: MillironX/setup-nextflow@octokit-throttling-dist
        with:
          version: ${{ matrix.NXF_VER }}

@edmundmiller edmundmiller added this to the 2.0.0 milestone Jan 15, 2024
@MillironX
Copy link
Member Author

With no objections, I will plan to merge this and tag a new version this weekend.

@MillironX MillironX merged commit 2098c3c into nf-core:master Jan 22, 2024
16 checks passed
@MillironX MillironX deleted the feature/octokit-throttling branch January 22, 2024 02:57
@edmundmiller
Copy link
Collaborator

Looked good to me, couldn't get around to making a stress test last week. We'll see if anything breaks! 😃

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.

2 participants