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

Simply changing GH Actions runner #17788

Conversation

timvaillancourt
Copy link
Contributor

@timvaillancourt timvaillancourt commented Feb 13, 2025

Description

This small tweak to test/ci_workflow_gen.go makes it more straightforward for forks of vitessio/vitess to modify the GitHub Actions runner used for heavier CI jobs (modify the const cores16RunnerName)

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Copy link
Contributor

vitess-bot bot commented Feb 13, 2025

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Feb 13, 2025
@timvaillancourt timvaillancourt added Component: Build/CI and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Feb 13, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Feb 13, 2025
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

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

We should probably do the same thing for test/templates/unit_test.tpl and test/templates/cluster_vitess_tester.tpl to be more consistent.

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt
Copy link
Contributor Author

@frouioui good idea, I made that update and get these errors. I wondered if they make sense to you:

tim@Tims-MacBook-Pro vitess % make generate_ci_workflows >/dev/null            
2025/02/14 00:54:09 Error: template: unit_test.tpl:17:15: executing "unit_test.tpl" at <.RunsOn>: can't evaluate field RunsOn in type *main.unitTest
2025/02/14 00:54:09 Error: template: unit_test.tpl:17:15: executing "unit_test.tpl" at <.RunsOn>: can't evaluate field RunsOn in type *main.unitTest
2025/02/14 00:54:09 Error: template: unit_test.tpl:17:15: executing "unit_test.tpl" at <.RunsOn>: can't evaluate field RunsOn in type *main.unitTest
2025/02/14 00:54:09 Error: template: unit_test.tpl:17:15: executing "unit_test.tpl" at <.RunsOn>: can't evaluate field RunsOn in type *main.unitTest
2025/02/14 00:54:09 Error: template: unit_test.tpl:17:15: executing "unit_test.tpl" at <.RunsOn>: can't evaluate field RunsOn in type *main.unitTest
2025/02/14 00:54:09 Error: template: unit_test.tpl:17:15: executing "unit_test.tpl" at <.RunsOn>: can't evaluate field RunsOn in type *main.unitTest
2025/02/14 00:54:09 Error: template: cluster_vitess_tester.tpl:17:15: executing "cluster_vitess_tester.tpl" at <.RunsOn>: can't evaluate field RunsOn in type *main.vitessTesterTest

@frouioui
Copy link
Member

@timvaillancourt, similarly to generateClusterWorkflows the functions generateUnitTestWorkflows and generateVitessTesterWorkflows should confiure the struct we send to the template with RunsOn.

They both use the structs unitTest and vitessTesterTest, which should contain a field RunsOn, like clusterTest.

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt
Copy link
Contributor Author

@timvaillancourt, similarly to generateClusterWorkflows the functions generateUnitTestWorkflows and generateVitessTesterWorkflows should confiure the struct we send to the template with RunsOn.

Thanks @frouioui, I founds those and my latest commit fixed things

As expected make generate_ci_workflows works and causes no diff to the workflow files:

tim@Tims-MacBook-Pro vitess % make generate_ci_workflows >/dev/null
tim@Tims-MacBook-Pro vitess % echo $?
0
tim@Tims-MacBook-Pro vitess % git diff
tim@Tims-MacBook-Pro vitess % 

@timvaillancourt timvaillancourt merged commit efa30d4 into vitessio:main Feb 14, 2025
101 checks passed
@timvaillancourt timvaillancourt deleted the ci_workflows_gen-16cores-runner-name branch February 14, 2025 00:28
timvaillancourt added a commit to slackhq/vitess that referenced this pull request Feb 14, 2025
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants