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

[FEAT] Self-hosted runners and Self-hosted runner groups APIs #2695

Merged
merged 28 commits into from
Apr 28, 2023

Conversation

lineville
Copy link
Contributor

@lineville lineville commented Apr 7, 2023

Resolves #2692 by implementing support for the following API's

Self-Hosted Runners

  • List self-hosted runners for an enterprise
  • List self-hosted runners for an organization
  • List self-hosted runners for a repository
  • List self-hosted runners for a group in an enterprise
  • List self-hosted runners for a group in an organization
  • List self-hosted runner applications for an enterprise
  • List self-hosted runner applications for an organization
  • List self-hosted runner applications for a repository
  • Delete a self-hosted runner for an enterprise
  • Delete a self-hosted runner for an organization
  • Delete a self-hosted runner for a repository
  • Create a self-hosted runner registration token for an enterprise
  • Create a self-hosted runner registration token for an organization
  • Create a self-hosted runner registration token for a repository

Self-Hosted Runner Groups

  • List self-hosted runner groups for an enterprise
  • List self-hosted runner groups for an organization
  • List organization access to a self-hosted runner group in an enterprise
  • List repository access to a self-hosted runner group in an organization

Behavior

Before the change?

  • The ActionsSelfHostedRunnersClient and ActionsSelfHostedRunnerGroupsClient we're empty and not implemented

After the change?

  • The ActionsSelfHostedRunnersClient and ActionsSelfHostedRunnerGroupsClient have been implemented (non-exhaustively) to include several of the available API's (listed above)

Other information

  • Models that we're added include Runner, RunnerResponse, RunnerApplication and RunnerApplicationResponse
  • There are many APIs under the Self-Hosted Runner and Self-Hosted Runner Groups that are left unimplemented after this PR

Additional info

Pull request checklist

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Added the appropriate label for the given change

☝️ Unable to add labels to the PR 😕 but should be tagged with feature

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes (Please add the Type: Breaking change label)
  • No

If Yes, what's the impact:

  • N/A

Pull request type

Please add the corresponding label for change this PR introduces:

  • Bugfix: Type: Bug
  • Feature/model/API additions: Type: Feature
  • Updates to docs or samples: Type: Documentation
  • Dependencies/code cleanup: Type: Maintenance

@lineville lineville changed the title Self hosted runners apis [FEAT] Self-hosted runners and Self-hosted runner groups SPIs Apr 7, 2023
@lineville lineville changed the title [FEAT] Self-hosted runners and Self-hosted runner groups SPIs [FEAT] Self-hosted runners and Self-hosted runner groups APIs Apr 7, 2023
@kfcampbell
Copy link
Member

@lineville is this still something you're interested in getting in?

@lineville
Copy link
Contributor Author

@lineville is this still something you're interested in getting in?

Yes, I'd love to get this in. I have been working on adding some integration tests. I have been facing some issues with authenticating given that some of the tests need to access an enterprise etc. Unit tests and Convention tests and docs are done ✅, was just trying to finish up some integration tests, or at least validate somehow it's functional end to end before opening this PR up for review.

@kfcampbell If you have any ideas about running integration tests against an enterprise, or any details you might have about how the existing integration tests are run locally or in CI would be super helpful 🙇

@kfcampbell
Copy link
Member

As far as I'm aware, this the only script used in our automated checks, which runs unit tests but not any integration tests. I think we'd be working from scratch with enterprise integration testing.

@lineville
Copy link
Contributor Author

@kfcampbell Thanks! I won't worry too much about having exhaustive integration tests then, given that it's not run in CI anyways. I'll open this PR up for review shortly!

@lineville lineville marked this pull request as ready for review April 17, 2023 23:01
@lineville
Copy link
Contributor Author

@kfcampbell I've pushed up some final changes and opened this up for review! No rush or anything, but just curious what the release cadence looks like for this project? Are you planning to cut a release sometime soon?

@kfcampbell
Copy link
Member

@lineville release cadence is ad-hoc depending on PRs that have been merged. When this goes in, we can cut a release shortly thereafter.

@lineville
Copy link
Contributor Author

@kfcampbell Just bumping this 😄, any ideas when we could expect this to be merged and released? Is there anything from my end that might be holding this up?

Copy link
Contributor

@nickfloyd nickfloyd left a comment

Choose a reason for hiding this comment

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

This looks great! Thank you for the changes ❤️

@nickfloyd nickfloyd merged commit 2d4ba4e into octokit:main Apr 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

[FEAT]: Self-Hosted Runners and Runner Groups API Support
3 participants