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

ci: Improve Run CICD experience #12377

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from
Draft

Conversation

ko3n1g
Copy link
Collaborator

@ko3n1g ko3n1g commented Feb 26, 2025

Important

The Update branch button must only be pressed in very rare occassions.
An outdated branch is never blocking the merge of a PR.
Please reach out to the automation team before pressing that button.

What does this PR do ?

We have few scenarios where a PR gets updated:

  • reformat code with auto-commit
  • update PR button
  • Modify the concurrency control so that adding more labels to the PR won't cancel the Run CICD workflow

If this happens while a Run CICD workflow is running, the check suite won't be representative anymore since the metadata is overwritten by the updated commit.
This PR adds a relabel bot that re-attaches the Run CICD label, if the label was attached prior to the update event.

Furthermore, it removes the Run CICD label after the CI has finished (success or failure, cancel will not remove it).

Considerations:

  • Reformat is an action that users don't have (much) control over. So running the relabel bot after reformat makes a lot of sense to me
  • Updating the PR (accidentially) is a real threat and so also re-running the CI after this seems plausible to me
  • However, the re-label bot will also re-label if "normal" commits are being added. So pratically, once the Run CICD label is attached we will re-run the CI with each attached commit up until the CI finishes (success or failure). At this point the author will need to label the PR again.
  • I think this is fine, since one of the events that we want to catch with this automation is the accidental "Update PR" button. From git perspective, it is difficult to distinguish between this button and a "normal" commit. So in order to have a robust mechanism, I would suggest to always restart the CI with a new commit.

Collection: [Note which collection this PR will affect]

Changelog

  • Add specific line by line info of high level changes in this PR.

Usage

  • You can potentially add a usage example below
# Add a code snippet demonstrating how to use this 

GitHub Actions CI

The Jenkins CI system has been replaced by GitHub Actions self-hosted runners.

The GitHub Actions CI will run automatically when the "Run CICD" label is added to the PR.
To re-run CI remove and add the label again.
To run CI on an untrusted fork, a NeMo user with write access must first click "Approve and run".

Before your PR is "Ready for review"

Pre checks:

  • Make sure you read and followed Contributor guidelines
  • Did you write any new necessary tests?
  • Did you add or update any necessary documentation?
  • Does the PR affect components that are optional to install? (Ex: Numba, Pynini, Apex etc)
    • Reviewer: Does the PR have correct import guards for all optional libraries?

PR Type:

  • New Feature
  • Bugfix
  • Documentation

If you haven't finished some of the above items you can still open "Draft" PR.

Who can review?

Anyone in the community is free to review the PR once the checks have passed.
Contributor guidelines contains specific people who can review PRs to various areas.

Additional Information

  • Related to # (issue)

@github-actions github-actions bot added the CI label Feb 26, 2025
@ko3n1g ko3n1g added Run CICD and removed CI labels Feb 26, 2025
@github-actions github-actions bot added the CI label Feb 26, 2025
@ko3n1g ko3n1g added Run CICD and removed Run CICD labels Feb 26, 2025
@ko3n1g ko3n1g changed the title ci: Couple code linting ci: Re-label PR after update Feb 26, 2025
@ko3n1g ko3n1g added Run CICD and removed Run CICD labels Feb 26, 2025
@ko3n1g ko3n1g added Run CICD and removed Run CICD labels Feb 26, 2025
jstjohn
jstjohn previously approved these changes Feb 26, 2025
Copy link
Collaborator

@jstjohn jstjohn left a comment

Choose a reason for hiding this comment

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

Yes please.

Signed-off-by: oliver könig <[email protected]>
Signed-off-by: oliver könig <[email protected]>
Copy link
Contributor

[🤖]: Hi @ko3n1g 👋,

We wanted to let you know that a CICD pipeline for this PR just finished successfully

So it might be time to merge this PR or get some approvals

I'm just a bot so I'll leave it you what to do next.

//cc @pablo-garay @ko3n1g

Copy link
Contributor

[🤖]: Hi @ko3n1g 👋,

We wanted to let you know that a CICD pipeline for this PR just finished successfully

So it might be time to merge this PR or get some approvals

I'm just a bot so I'll leave it you what to do next.

//cc @pablo-garay @ko3n1g

@ko3n1g ko3n1g added Run CICD and removed Run CICD labels Feb 26, 2025
@ko3n1g ko3n1g changed the title ci: Re-label PR after update ci: Imrpve Run CICD experience Feb 26, 2025
@ko3n1g ko3n1g changed the title ci: Imrpve Run CICD experience ci: Improve Run CICD experience Feb 26, 2025
@ko3n1g ko3n1g added the ASR label Feb 26, 2025
f
Signed-off-by: oliver könig <[email protected]>
f
Signed-off-by: oliver könig <[email protected]>
f
Signed-off-by: oliver könig <[email protected]>
@github-actions github-actions bot removed the ASR label Feb 26, 2025
@ko3n1g ko3n1g marked this pull request as draft February 26, 2025 18:17
@ko3n1g
Copy link
Collaborator Author

ko3n1g commented Feb 26, 2025

Only to be merged after NeMo-FW 25.02 release to not disrupt any critical last minute operations.

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