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

Changes for SCC24 #18

Conversation

arjunsuresh
Copy link
Contributor

No description provided.

@arjunsuresh arjunsuresh requested review from a team as code owners September 24, 2024 23:06
Copy link

MLCommons CLA bot:
Thank you very much for your submission, we really appreciate it. Before we can accept your contribution, we ask that you sign the MLCommons CLA (Apache 2). Please use this [Google form] (https://forms.gle/Ew1KkBVpyeJDuRw67) to initiate authorization. If you are from an MLCommons member organization, we will request that you be added to the CLA. If you are not from a member organization, we will email you a CLA to sign. For any questions, please contact [email protected].
1 out of 2 committers have signed the MLCommons CLA.
@arjunsuresh
❌ @admin
admin seems not to be a GitHub user. You need a GitHub account after you become MLCommons member. If you have already a GitHub account, please add the email address used for this commit to your account.
You can retrigger this bot by commenting recheck in this Pull Request

@morphine00
Copy link
Contributor

Hi folks, there are some commits under the name "admin", meaning that one of the users didn't set up their .git correctly for GitHub.

@arjunsuresh
Copy link
Contributor Author

arjunsuresh commented Sep 24, 2024 via email

@morphine00
Copy link
Contributor

Any authorized GitHub acount/token will do. Perhaps this is of help? https://github.com/orgs/community/discussions/25863 .

We can create an account just for this, but at first sight it looks like it's not necessary?

@arjunsuresh
Copy link
Contributor Author

Thank you @morphine00 . I tried to use the GitHub bot account where the user is actions-user. But this user still needs to be added in the MLCommons CLA right?

Created a committerMap for users in PR: (signed: arjunsuresh-4791823, ) , (notSigned:  admin-, actions-user-65916846, )
MLCommons CLA bot comment id:  2372542209

@morphine00
Copy link
Contributor

Hi Arjun, in the short term you can have the commits in question authored by you using one of the methods described below, and that'll get you past the CLA bot.

  1. However, there's a question raised here: do you foresee the Inference group needing a bot of their own for these actions?

  2. Note that regardless of whether you assign attribution of the commits to yourself using the methods below, or we create a bot, those commits and this PR will have to be re-done with the correct attribution. There are methods using Git to retroactively add user information to a commit, but that's generally more work than just redoing the PR.


(Options taken from ChatGPT, but it seems to make sense)

A. Signed-off-by Workflow: Ensure that commits made by bots are properly attributed and approved by a human who has signed the licensing agreement. You can implement a "Signed-off-by" footer for each commit, which adds a verifiable trail of human oversight for bot commits. GitHub’s --signoff option can be used when creating commits via bots or CI tools.

B. Co-Authored-by Commit Convention: For commits initiated by bots (such as through GitHub Actions), use the Co-authored-by convention, which allows for multiple authorship attribution. The bot can be listed as the primary author, but the team member who initiated or approved the action can be added as a co-author. This ties the commit back to a specific user who has signed the licensing agreement.

@arjunsuresh
Copy link
Contributor Author

Thank you @morphine00 . I'll take care of updating the commits in this PR.

But in all CM related repositories we do need a bot to automatically update the README files and also in the inference results repository (during the review period) to update the results summary via github actions. Do you think this github actions bot account is fine for this?
https://github.com/orgs/community/discussions/26560

@arjunsuresh arjunsuresh merged commit c4270cb into mlcommons:mlperf-inference-results-scc24 Oct 1, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Oct 1, 2024
@nathanw-mlc
Copy link
Member

Hey @arjunsuresh, following up on this; is there still a need for a bot account for CM? Is your intention to have the bot make commits, open a PR, then have the PR approved and merged, as is this case in this PR, or are you looking to make direct commits to main/master as we've done with the deploy keys?

@arjunsuresh
Copy link
Contributor Author

Hi @nathanw-mlc actually we are still in need of a bot github account for the below 2 use cases.

  1. Do automatic update of relevant README files when there is a commit to the main branch in the cm4mlops repository
  2. Do automatic update of submission results when there is a commit to the main branch of the inference_results (public) or the submissions_inference (private) repository.

In both cases the bot account needs to do commit to the same repo and can be done using the deploy keys like we have done previously. But can we use a bot "userid" and "email" for this?

@nathanw-mlc
Copy link
Member

In both cases the bot account needs to do commit to the same repo and can be done using the deploy keys like we have done previously. But can we use a bot "userid" and "email" for this?

@arjunsuresh, is your desire to have a bot userid and email to have the commits attributed to a particular bot account? When a workflow makes commits with a deploy, the commit is automatically attributed to the GitHub account that created the deploy key. We've been using the mlcommons-bot account to create the deploy keys, so commits will be attributed to that account. Are you wanting a designated bot account for CM?

@arjunsuresh
Copy link
Contributor Author

Great Nathan. That works for us. So we just need to do the below git config before doing the commit in the github action right?

 git config --global user.name mlcommons-bot
 git config --global user.email "[email protected]"

@nathanw-mlc
Copy link
Member

So we just need to do the below git config before doing the commit in the github action right?

 git config --global user.name mlcommons-bot
 git config --global user.email "[email protected]"

Yes, that should work, and you only need to use the deploy key when you need to perform actions that need to bypass branch protections.

@arjunsuresh
Copy link
Contributor Author

Thanks a lot Nathan. That solves our problem 😊

@nathanw-mlc
Copy link
Member

That solves our problem

Great, let me know if this solution gives you trouble or needs improvement.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants