Proper way to make remediation commits

[GHkrishna]

We are trying to make remediation commits as per the docs.

The PR is from develop branch to qa branch. And we have the dco.yml configurations on both the branches. However, when making remediation commits, with different methods and multiple formats, we were still not able to make the DCO checks pass in the PR here (credebl/studio#1121)

Not sure, if there are any other settings that we would need to configure for the repo.

PR:

https://github.com/credebl/studio/pull/1121

Formats tried

Here's the different format we tried with:

Third-party DCO remediation commit for sujitaw <[email protected]>

On behalf of sujitaw <[email protected]>, I, Krishna Waske <[email protected]>, hereby add my Signed-off-by to this commit: ab22d90e913d440ac579c85ab9961fb1d30da443
On behalf of sujitaw <[email protected]>, I, Krishna Waske <[email protected]>, hereby add my Signed-off-by to this commit: 7d1f1cbe671ae0ddad4c02840278fce5e5775950
On behalf of sujitaw <[email protected]>, I, Krishna Waske <[email protected]>, hereby add my Signed-off-by to this commit: 07c85d1a6c1234a9ff7592bac768bf64fbca93c6

Third-party DCO remediation commit for Sujit <[email protected]>

On behalf of Sujit <[email protected]>, I, Krishna Waske <[email protected]>, hereby add my Signed-off-by to this commit: ab22d90e913d440ac579c85ab9961fb1d30da443
On behalf of Sujit <[email protected]>, I, Krishna Waske <[email protected]>, hereby add my Signed-off-by to this commit: 7d1f1cbe671ae0ddad4c02840278fce5e5775950
On behalf of Sujit <[email protected]>, I, Krishna Waske <[email protected]>, hereby add my Signed-off-by to this commit: 07c85d1a6c1234a9ff7592bac768bf64fbca93c6

Third-party DCO remediation commit for sujitaw <[email protected]>

On behalf of sujitaw <[email protected]>, I, Krishna Waske <[email protected]>, hereby add my Signed-off-by to this commit: ab22d90
On behalf of sujitaw <[email protected]>, I, Krishna Waske <[email protected]>, hereby add my Signed-off-by to this commit: 7d1f1cb
On behalf of sujitaw <[email protected]>, I, Krishna Waske <[email protected]>, hereby add my Signed-off-by to this commit: 07c85d1

Third-party DCO remediation commit for sujitaw <[email protected]>

On behalf of sujitaw <[email protected]>, I, Krishna Waske <[email protected]>, hereby add my Signed-off-by to this commit: <ab22d90>
On behalf of sujitaw <[email protected]>, I, Krishna Waske <[email protected]>, hereby add my Signed-off-by to this commit: <7d1f1cb>
On behalf of sujitaw <[email protected]>, I, Krishna Waske <[email protected]>, hereby add my Signed-off-by to this commit: <07c85d1>

All the above, we've also tried with the commiter themselves trying to signoff, with the correct name

DCO failure summary:

The DCO fails here, due to difference in author and signature name:

Commit sha: [ab22d90](https://github.com/credebl/studio/pull/1121/commits/ab22d90e913d440ac579c85ab9961fb1d30da443), Author: sujitaw, Committer: GitHub; Can not find "sujitaw [[email protected]](mailto:[email protected])", in ["Sujit [[email protected]](mailto:[email protected])", "Sujit [[email protected]](mailto:[email protected])", "Sujit [[email protected]](mailto:[email protected])"].
Commit sha: [7d1f1cb](https://github.com/credebl/studio/pull/1121/commits/7d1f1cbe671ae0ddad4c02840278fce5e5775950), Author: sujitaw, Committer: GitHub; Expected "sujitaw [[email protected]](mailto:[email protected])", but got "Sujit [[email protected]](mailto:[email protected])".
Commit sha: [07c85d1](https://github.com/credebl/studio/pull/1121/commits/07c85d1a6c1234a9ff7592bac768bf64fbca93c6), Author: sujitaw, Committer: GitHub; Can not find "sujitaw [[email protected]](mailto:[email protected])", in ["Sujit [[email protected]](mailto:[email protected])", "Sujit [[email protected]](mailto:[email protected])", "Sujit [[email protected]](mailto:[email protected])", "Sujit [[email protected]](mailto:[email protected])", "Sujit [[email protected]](mailto:[email protected])", "Sujit [[email protected]](mailto:[email protected])", "Sujit [[email protected]](mailto:[email protected])"].

TLDR

Unable to make remediation commits with dco.yml on base and feature branch.

[GHkrishna]

@tegioz @cynthia-sg any suggestions?

[tegioz]

Hi @GHkrishna 👋

The dco.yml configuration file must be placed in the default branch of the repository (main in this case).

dco2/docs/config/dco.yml

Line 3 in 1a8786b

# The configuration file must be named `dco.yml` and placed in the `.github` directory in the default branch of the repository. The values used below are the defaults.

Please note that the DCO failure summary you shared comes from the https://github.com/dcoapp/app DCO app, not from the one provided in this repository (DCO2). You can find ours at: https://github.com/credebl/studio/pull/1121/checks?check_run_id=46863584166.

[GHkrishna]

That's awesome Sergio,
By adding the config file in main(the default branch), remediation worked as expected 🥳

PS: The format which worked, was the first one, with the incorrect author name and complete commit id. (7 character id somehow failed to remediate correctly)

[GHkrishna]

the DCO failure summary you shared is not from the one provided in this repository (DCO2)
Yes you are right.

Out of curiosity, is there a way to generate summary from our app as well, the summary seems quite useful. If its not currently available, I'm happy to raise an issue accordingly.

[tegioz]

Hi @GHkrishna

DCO2 also generates a summary, please see:

(from https://github.com/credebl/studio/runs/46854548015)

It's kind of similar to DCO's one (https://github.com/credebl/studio/runs/46854547523), but we didn't include the names and emails (intentionally). If this becomes a problem we could reconsider adding them though.