tt-metal will require status/pipeline checks for pull requests into main

[tt-rkim]

Please read this entire thing before you spam me or @TT-billteng . I will not be happy if we receive questions that have answers here.

You may notice a small yellow dot on each PR now:

This is now because we will slowly start requiring pull requests to pass pipelines on the latest main before merging via the GitHub UI. However, we will only start with ONE, small non-silicon pipeline which everyone should definitely pass any and never fails non-deterministically.

To be absolutely clear: you still must pass all post-commit pipelines before merging.

This is all in preparation for open-sourcing, ensuring our pipelines are clean on main, and wasting less developer time checking if pipelines pass and manually running them.

How do I get checks to pass to get the green checkmark?

Opening or re-opening pull requests with target branch main will now start automatically running any required pipelines.

Additionally, some pipelines may also re-run if you push to your branch after you open a PR.

Their pass/fail statuses will be posted to your PR and the HEAD of your branch commits.

What pipelines do I need to pass before I get a green checkmark?

Currently, you only need to pass the static checks pipeline. This include SPDX headers, core metal runtime kernel, and some linting. If you're worried about the time, don't worry, the static checks pipeline takes less than 2 minutes. If you think that's too long, I'm not sure how to take you seriously.

There are NO silicon pipelines that will gate the merge button on UI. You must still ensure they pass, however.

Is there anything extra I need to do?

Yes.

• Please do not unnecessarily spam our pipelines - especially ones which use silicon runners. Which is a lot! You can avoid doing so with the following:
  • Only run post-commit pipelines when you're ready to see what's on CI, rather than using it as a crutch to run tests all the time before you're ready to even to check it in to main.
  • Locally run pipelines as much as possible before running GitHub CI. CI should be something you run in the background while you go off and work on other things, anyway.
  • Do not open/re-open pull requests before you're ready for review.
• You must still pass all post-commit pipelines by manually running them through the Actions UI with "Run workflow". We will still endlessly shame you if you break main.
• Do not commit directly to main via the GitHub UI. We will turn this off in future, but we can't right now without breaking our existing developer workflow. I will shame you endlessly if you do this and possibly turn off your developer access.

Some lower-level notes

[*] = Pushing to a pull request will trigger a GitHub event called pull_request synchronize. This will also re-trigger required pipelines. This is why we encourage to not run CI too much before you're ready for PR review. CONTRIBUTING.md was updated to reflect this.

cc: @tenstorrent-metal/developers @tenstorrent-metal/external-developers

[tt-rkim]

If I already have a PR, how do I get the green checkmark?

Rebase to latest main.

[tt-rkim]

I see this thing that says "Update branch". Can I click it?

You may ONLY use if you click the drop-down and click "Rebase" instead.

We enforce a linear commit history. Please do not merge merge commits into our main branch. I will definitely find you.