Identus Cloud Agent enforces the Developer Certificate of Origin (DCO). It requires all commit messages to contain the Signed-off-by line with an email address that matches the commit author and the name on your GitHub account.
The Developer Certificate of Origin (DCO) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. Here is the full text of the DCO, reformatted for readability:
By making a contribution to this project, I certify that:
The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
The contribution is based upon previous work that, to the best of my knowledge, is covered under an > appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
Contributors sign-off that they adhere to these requirements by adding a Signed-off-by line to commit messages.
The project requires a sign-off message in the following format appear on each commit in the pull request:
feat: new feature
Signed-off-by: John Smith <john.smith@iohk.io>
The text can either be manually added to your commit body, or you can add either -s or --signoff to your usual git commit commands.
Git has a -s | --signoff command-line option to append this automatically to your commit message:
git commit --signoff --message 'This is my commit message'git commit -s -m "This is my commit message"This will use your default git configuration which is found in .git/config and usually, it is the username systemaddress of the machine which you are using.
To change this, you can use the following commands (Note these only change the current repo settings, you will need to add --global for these commands to change the installation default).
Your name:
git config user.name "FIRST_NAME LAST_NAME"Your email:
git config user.email "MY_NAME@example.com"If you have authored a commit that is missing the signed-off-by line, you can amend your commits and push them to GitHub
git commit --amend --signoffIf you've pushed your changes to GitHub already you'll need to force push your branch after this with git push -f.
The project uses a DCO bot for all GitHub pulls to verify that each commit is signed off. When you create your pull request, it will automatically be verified by this bot. An example of what to expect is below.
If your Pull Request fails the DCO check, it's necessary to fix the entire commit history in the PR. Although this is a situation we'd like to avoid the best practice is to squash the commit history to a single commit, append the DCO sign-off as described above or interactively in the rebase comment editing process, and force push. For example, if you have 2 commits in your history (Note the ~2):
git rebase --interactive HEAD~2
(interactive squash + DCO append)
git push origin --forceNote, that in general rewriting history in this way is something that can cause issues with the review process and this should only be done to correct a DCO mistake.