Hi Wilfred Thank you for putting this together. Agree to have some doc and examples and every committer should follow the same rule. Moving on, it might also good to look at some auto-merge features, such as leveraging github action or github bot to enforce these rules. That might be fun to look at as well.
Weiwei On Mon, Jun 1, 2020 at 8:41 AM Sunil Govindan <[email protected]> wrote: > Thanks Wilfred > I agree. > > I think we can add these to our github and mandatory params for a PR > > Thanks > Sunil > > On Mon, Jun 1, 2020 at 9:07 PM Wilfred Spiegelenburg <[email protected]> > wrote: > > > I have had only one response to this discussion. I spoke offline to > Weiwei > > and looking at the lasts commits we are losing details and get badly > > formatted commit messages. > > * Committer is the generic github account. Here is an example of a commit > > from github. > > * Badly formatted messages as github does not insert line breaks. > > > > Since there was no strong -1 on this I am going to add the steps to the > > documentation, and ask everyone that commits to follow the simple manual > > merge steps: > > > > * git checkout master > > > > * git pull > > > > * git checkout -b <JIRA ID> master > > > > * git pull <FORK GIT> <REMOTE PR branch> > > > > * git checkout master > > > > * git merge --squash <JIRA ID> > > > > * git commit --author “ORIGINAL AUTHOR <[email protected]>” > > * git push origin master > > > > On commit you will be given the change to properly format the message of > > the commit. We can use magic github words in the commit to automatically > > close the PR on commit. > > I will add examples for the messages and the auto close > > > > Wilfred > > > > On Sun, 26 Apr 2020 at 05:01, Wangda Tan <[email protected]> wrote: > > > > > This looks reasonable to me. If everybody agrees, we should add it to > the > > > dev doc. > > > > > > Thanks, > > > Wangda > > > > > > On Mon, Apr 13, 2020 at 11:56 PM Wilfred Spiegelenburg < > > > [email protected]> wrote: > > > > > >> Hi, > > >> > > >> We have been using the github squash and commit button to merge > requests > > >> for a most of our commits. I have noticed a problem with that usage. > The > > >> commit that is added by GitHub will be attributed to the person that > > >> opened > > >> the PR (that is good and correct). However the committer is set to > > github. > > >> This means that we cannot track back a commit to a committer unless > you > > >> use > > >> the github UI and open the PR. The code that is committed into the > repo > > is > > >> also not signed off by the person performing the commit but by using a > > >> general github signature. > > >> > > >> As an example [YUNIKORN-85] shows the following commit log entry: > > >> -+-+-+-+- > > >> Author: Tao Yang <[email protected]> > > >> AuthorDate: Sat Apr 11 01:55:41 2020 +0800 > > >> Commit: GitHub <[email protected]> > > >> CommitDate: Fri Apr 10 10:55:41 2020 -0700 > > >> -+-+-+-+- > > >> > > >> And on the UI it just shows Tao committed the change while Weiwei was > > the > > >> person that merged. You cannot find the correct detail unless you dig > > into > > >> the original PR on github itself. > > >> > > >> -+-+-+-+- > > >> [YUNIKORN-85] Improve recovery performance by querying all pods once > … … > > >> TaoYang526 committed 4 days ago > > >> -+-+-+-+- > > >> > > >> Because of this I already switched back to a manual squash and commit > of > > >> the changes setting the author etc. That shows up correctly in the > logs: > > >> -+-+-+-+- > > >> Author: Weiwei Yang <[email protected]> > > >> AuthorDate: Fri Apr 10 02:17:16 2020 +1000 > > >> Commit: Wilfred Spiegelenburg <[email protected]> > > >> CommitDate: Fri Apr 10 02:17:16 2020 +1000 > > >> -+-+-+-+- > > >> And also in the github UI: > > >> -+-+-+-+- > > >> [YUNIKORN-72] data race in unit test (#96) … > > >> yangwwei authored and wilfred-s committed 5 days ago > > >> -+-+-+-+- > > >> > > >> I want to propose that we all go back to that way so we do not lose > > >> the information of whom committed and get the correct signatures on > the > > >> committed code. > > >> > > >> Please let me know if this is acceptable. > > >> > > >> Wilfred > > >> > > > > > >
