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.

Sign up for GitHub

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

Jump to bottom

Build vttestserver in GHA and send Slack message on Docker Build failure #16963

Merged
merged 5 commits into from
Oct 23, 2024
Merged

Build vttestserver in GHA and send Slack message on Docker Build failure #16963

merged 5 commits into from
Oct 23, 2024

Conversation

frouioui
Copy link
Member

@frouioui frouioui commented Oct 15, 2024 •
edited
Loading

Description

This is a follow-up of #16759 where we had reverted recent changes to the docker build github action workflow. This PR re-adds some of the changes we had reverted, like the build of vttestserver which was missing. It also adds a step to notify maintainers on Slack when there is a failure. The pipeline now looks as follows:
image

Commit 1c14d44 illustrate how the notification mechanism works. The notification can seen on https://vitess.slack.com/archives/C07SC9PDN57/p1729017794047489.

@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Oct 15, 2024

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 Oct 15, 2024
@github-actions github-actions bot added this to the v22.0.0 milestone Oct 15, 2024
@frouioui frouioui force-pushed the vttestserver-docker branch from fffa473 to 2c57621 Compare October 15, 2024 18:01
rohit-nayak-ps
rohit-nayak-ps reviewed Oct 15, 2024
View reviewed changes
.github/workflows/docker_build_images.yml Outdated Show resolved Hide resolved
.github/workflows/docker_build_images.yml
@@ -26,13 +94,13 @@ jobs:

steps:
- name: Check out code
uses: actions/checkout@v4
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
Copy link
Contributor

Choose a reason for hiding this comment

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

What is the reason to use the SHA here instead of a version?

Copy link
Member Author

Choose a reason for hiding this comment

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

Using the SHA instead of the version is part of the OpenSSF best practices. We started doing this some time ago through #16612. This is to comply with #16607.

.github/workflows/docker_build_images.yml Show resolved Hide resolved
docker/vttestserver/README.md
docker login

# we assume in this example that we are releasing v21.0.0-rc1, but replace this by any other tag
git checkout v21.0.0-rc1
Copy link
Contributor

Choose a reason for hiding this comment

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

We should remove the -rc1 right, since we no longer use that for the branch names? Or are we using tag names?

Copy link
Member Author

Choose a reason for hiding this comment

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

We want to checkout the git tag directly, not the release branch. I updated the comment to be more understandable in 1e950a0.

@frouioui frouioui marked this pull request as draft October 15, 2024 18:13
@frouioui frouioui force-pushed the vttestserver-docker branch 2 times, most recently from a44305c to 40b0c85 Compare October 15, 2024 18:26
@frouioui
wip - test slack notification
1c14d44 
Signed-off-by: Florent Poinsard <[email protected]>
@frouioui frouioui force-pushed the vttestserver-docker branch from 40b0c85 to 1c14d44 Compare October 15, 2024 18:40
@frouioui
Remove WIP and fix Slack notification
e25cbd3 
Signed-off-by: Florent Poinsard <[email protected]>
@frouioui
Make docs more clear
1e950a0 
Signed-off-by: Florent Poinsard <[email protected]>
@frouioui frouioui marked this pull request as ready for review October 15, 2024 18:52
@frouioui frouioui added Type: CI/Build Component: Docker 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 Oct 15, 2024
@frouioui
Copy link
Member Author

frouioui commented Oct 21, 2024 •
edited
Loading

After running some tests on one of my dummy repo: the workflow file used to run on a tags event is the file that belongs to that specific tag. So, i am backporting this PR to release-21.0 so the change take effect there (as we reverted it in >= v21)

@frouioui frouioui added the Backport to: release-21.0 Needs to be backport to release-21.0 label Oct 21, 2024
@frouioui frouioui merged commit dbf2c6a into main Oct 23, 2024
196 checks passed
@frouioui frouioui deleted the vttestserver-docker branch October 23, 2024 04:06
vitess-bot pushed a commit that referenced this pull request Oct 23, 2024
@vitess-bot @vitess-bot
Build vttestserver in GHA and send Slack message on Docker Build fa…
cd39d41 
…ilure (#16963)

Signed-off-by: Florent Poinsard <[email protected]>
@vitess-bot vitess-bot bot mentioned this pull request Oct 23, 2024
Merged
frouioui pushed a commit that referenced this pull request Oct 23, 2024
@vitess-bot
[release-21.0] Build vttestserver in GHA and send Slack message on …
5f957b2 
…Docker Build failure (#16963) (#17047)

Signed-off-by: Florent Poinsard <[email protected]>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rohit-nayak-ps rohit-nayak-ps rohit-nayak-ps approved these changes

@deepthi deepthi deepthi approved these changes

@derekperkins derekperkins Awaiting requested review from derekperkins derekperkins is a code owner

@mattlord mattlord Awaiting requested review from mattlord mattlord is a code owner

@GuptaManan100 GuptaManan100 Awaiting requested review from GuptaManan100 GuptaManan100 is a code owner

Assignees
No one assigned
Labels
Backport to: release-21.0 Needs to be backport to release-21.0 Component: Docker Type: CI/Build
Projects
None yet
Milestone
v22.0.0
Development

Successfully merging this pull request may close these issues.
3 participants
@frouioui @deepthi @rohit-nayak-ps