cloudsnorkel.cdk-github-runners 0.18.1__tar.gz → 1.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (17) hide show
  1. {cloudsnorkel_cdk_github_runners-0.18.1/src/cloudsnorkel.cdk_github_runners.egg-info → cloudsnorkel_cdk_github_runners-1.0.0}/PKG-INFO +7 -5
  2. {cloudsnorkel_cdk_github_runners-0.18.1 → cloudsnorkel_cdk_github_runners-1.0.0}/README.md +5 -3
  3. {cloudsnorkel_cdk_github_runners-0.18.1 → cloudsnorkel_cdk_github_runners-1.0.0}/setup.py +3 -3
  4. {cloudsnorkel_cdk_github_runners-0.18.1 → cloudsnorkel_cdk_github_runners-1.0.0}/src/cloudsnorkel/cdk_github_runners/__init__.py +1337 -6274
  5. {cloudsnorkel_cdk_github_runners-0.18.1 → cloudsnorkel_cdk_github_runners-1.0.0}/src/cloudsnorkel/cdk_github_runners/_jsii/__init__.py +2 -2
  6. cloudsnorkel_cdk_github_runners-1.0.0/src/cloudsnorkel/cdk_github_runners/_jsii/cdk-github-runners@1.0.0.jsii.tgz +0 -0
  7. {cloudsnorkel_cdk_github_runners-0.18.1 → cloudsnorkel_cdk_github_runners-1.0.0/src/cloudsnorkel.cdk_github_runners.egg-info}/PKG-INFO +7 -5
  8. {cloudsnorkel_cdk_github_runners-0.18.1 → cloudsnorkel_cdk_github_runners-1.0.0}/src/cloudsnorkel.cdk_github_runners.egg-info/SOURCES.txt +1 -1
  9. cloudsnorkel_cdk_github_runners-0.18.1/src/cloudsnorkel/cdk_github_runners/_jsii/cdk-github-runners@0.18.1.jsii.tgz +0 -0
  10. {cloudsnorkel_cdk_github_runners-0.18.1 → cloudsnorkel_cdk_github_runners-1.0.0}/LICENSE +0 -0
  11. {cloudsnorkel_cdk_github_runners-0.18.1 → cloudsnorkel_cdk_github_runners-1.0.0}/MANIFEST.in +0 -0
  12. {cloudsnorkel_cdk_github_runners-0.18.1 → cloudsnorkel_cdk_github_runners-1.0.0}/pyproject.toml +0 -0
  13. {cloudsnorkel_cdk_github_runners-0.18.1 → cloudsnorkel_cdk_github_runners-1.0.0}/setup.cfg +0 -0
  14. {cloudsnorkel_cdk_github_runners-0.18.1 → cloudsnorkel_cdk_github_runners-1.0.0}/src/cloudsnorkel/cdk_github_runners/py.typed +0 -0
  15. {cloudsnorkel_cdk_github_runners-0.18.1 → cloudsnorkel_cdk_github_runners-1.0.0}/src/cloudsnorkel.cdk_github_runners.egg-info/dependency_links.txt +0 -0
  16. {cloudsnorkel_cdk_github_runners-0.18.1 → cloudsnorkel_cdk_github_runners-1.0.0}/src/cloudsnorkel.cdk_github_runners.egg-info/requires.txt +0 -0
  17. {cloudsnorkel_cdk_github_runners-0.18.1 → cloudsnorkel_cdk_github_runners-1.0.0}/src/cloudsnorkel.cdk_github_runners.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: cloudsnorkel.cdk-github-runners
3
- Version: 0.18.1
3
+ Version: 1.0.0
4
4
  Summary: CDK construct to create GitHub Actions self-hosted runners. Creates ephemeral runners on demand. Easy to deploy and highly customizable.
5
5
  Home-page: https://github.com/CloudSnorkel/cdk-github-runners.git
6
6
  Author: Amir Szekely<amir@cloudsnorkel.com>
@@ -16,7 +16,7 @@ Classifier: Programming Language :: Python :: 3.12
16
16
  Classifier: Programming Language :: Python :: 3.13
17
17
  Classifier: Programming Language :: Python :: 3.14
18
18
  Classifier: Typing :: Typed
19
- Classifier: Development Status :: 4 - Beta
19
+ Classifier: Development Status :: 5 - Production/Stable
20
20
  Classifier: License :: OSI Approved
21
21
  Requires-Python: >=3.10
22
22
  Description-Content-Type: text/markdown
@@ -660,6 +660,7 @@ Configuration problems that we can detect up-front fail the orchestrator with a
660
660
  2. If you see too many errors, make sure you're only sending `workflow_job` events
661
661
  5. When using GitHub app, make sure there are active installations in `github.auth.app.installations`
662
662
  6. If runners start but never pick up a job and get stopped with `IdleRunner`, their runner version may be too old. Runners can't update themselves, and GitHub stops sending jobs to runners that are not updated within 30 days of a new runner release, or right away for a critical security update. [Rebuild your runner images](#rebuilding-runner-images) to fix it
663
+ 7. If organization-level runners never pick up jobs from public repositories, check the runner group settings. By default, only private repositories can use runners in a runner group. You can allow public repositories in the [runner group repository access settings](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#changing-which-repositories-can-access-a-runner-group), but make sure you understand the [security risks](#job-isolation) first
663
664
 
664
665
  All logs are saved in CloudWatch.
665
666
 
@@ -708,10 +709,11 @@ Other useful metrics to track:
708
709
  1. Use `GitHubRunners.metricJobCompleted()` to get a metric for the number of completed jobs broken down by labels and job success.
709
710
  2. Use `GitHubRunners.metricTime()` to get a metric for the total time a runner is running. This includes the overhead of starting the runner.
710
711
  3. Use `GitHubRunners.metricStolenRunners()` to get a metric for number of runners detected as stolen by another job. Anything over zero can indicate a misconfiguration or GitHub webhook issues.
712
+ 4. Use `GitHubRunners.metricJobsMatchingMultipleProviders()` to get a metric for the number of jobs whose labels matched more than one provider and may run on any of them. Anything over zero means some workflows should ask for more labels.
711
713
 
712
- Use `GitHubRunners.createDashboard()` to get a CloudWatch dashboard with all of these metrics in one place. It shows
713
- completed jobs by status, failed jobs by runner label, runners that failed to start, runner time, webhook activity, and
714
- recent errors from the logs.
714
+ Use `GitHubRunners.createDashboard()` to get a CloudWatch dashboard with all of these metrics in one place. It's split
715
+ into sections for jobs, runners, runner assignment and management functions. Each section explains what its numbers
716
+ mean and which ones to alarm on.
715
717
 
716
718
  ## Known Issues
717
719
 
@@ -632,6 +632,7 @@ Configuration problems that we can detect up-front fail the orchestrator with a
632
632
  2. If you see too many errors, make sure you're only sending `workflow_job` events
633
633
  5. When using GitHub app, make sure there are active installations in `github.auth.app.installations`
634
634
  6. If runners start but never pick up a job and get stopped with `IdleRunner`, their runner version may be too old. Runners can't update themselves, and GitHub stops sending jobs to runners that are not updated within 30 days of a new runner release, or right away for a critical security update. [Rebuild your runner images](#rebuilding-runner-images) to fix it
635
+ 7. If organization-level runners never pick up jobs from public repositories, check the runner group settings. By default, only private repositories can use runners in a runner group. You can allow public repositories in the [runner group repository access settings](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#changing-which-repositories-can-access-a-runner-group), but make sure you understand the [security risks](#job-isolation) first
635
636
 
636
637
  All logs are saved in CloudWatch.
637
638
 
@@ -680,10 +681,11 @@ Other useful metrics to track:
680
681
  1. Use `GitHubRunners.metricJobCompleted()` to get a metric for the number of completed jobs broken down by labels and job success.
681
682
  2. Use `GitHubRunners.metricTime()` to get a metric for the total time a runner is running. This includes the overhead of starting the runner.
682
683
  3. Use `GitHubRunners.metricStolenRunners()` to get a metric for number of runners detected as stolen by another job. Anything over zero can indicate a misconfiguration or GitHub webhook issues.
684
+ 4. Use `GitHubRunners.metricJobsMatchingMultipleProviders()` to get a metric for the number of jobs whose labels matched more than one provider and may run on any of them. Anything over zero means some workflows should ask for more labels.
683
685
 
684
- Use `GitHubRunners.createDashboard()` to get a CloudWatch dashboard with all of these metrics in one place. It shows
685
- completed jobs by status, failed jobs by runner label, runners that failed to start, runner time, webhook activity, and
686
- recent errors from the logs.
686
+ Use `GitHubRunners.createDashboard()` to get a CloudWatch dashboard with all of these metrics in one place. It's split
687
+ into sections for jobs, runners, runner assignment and management functions. Each section explains what its numbers
688
+ mean and which ones to alarm on.
687
689
 
688
690
  ## Known Issues
689
691
 
@@ -5,7 +5,7 @@ kwargs = json.loads(
5
5
  """
6
6
  {
7
7
  "name": "cloudsnorkel.cdk-github-runners",
8
- "version": "0.18.1",
8
+ "version": "1.0.0",
9
9
  "description": "CDK construct to create GitHub Actions self-hosted runners. Creates ephemeral runners on demand. Easy to deploy and highly customizable.",
10
10
  "license": "Apache-2.0",
11
11
  "url": "https://github.com/CloudSnorkel/cdk-github-runners.git",
@@ -26,7 +26,7 @@ kwargs = json.loads(
26
26
  ],
27
27
  "package_data": {
28
28
  "cloudsnorkel.cdk_github_runners._jsii": [
29
- "cdk-github-runners@0.18.1.jsii.tgz"
29
+ "cdk-github-runners@1.0.0.jsii.tgz"
30
30
  ],
31
31
  "cloudsnorkel.cdk_github_runners": [
32
32
  "py.typed"
@@ -50,7 +50,7 @@ kwargs = json.loads(
50
50
  "Programming Language :: Python :: 3.13",
51
51
  "Programming Language :: Python :: 3.14",
52
52
  "Typing :: Typed",
53
- "Development Status :: 4 - Beta",
53
+ "Development Status :: 5 - Production/Stable",
54
54
  "License :: OSI Approved"
55
55
  ],
56
56
  "scripts": []