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

Update docs workflow to support having more artifacts #2386

Merged
merged 2 commits into from
Nov 16, 2024

Merge branch 'main' into pr-fix-docs

0e62926
Select commit
Loading
Failed to load commit list.
Merged

Update docs workflow to support having more artifacts #2386

Merge branch 'main' into pr-fix-docs
0e62926
Select commit
Loading
Failed to load commit list.
DCO / DCO required action Nov 16, 2024 in 0s

DCO

There is one commit incorrectly signed off. This means that the author of this commit failed to include a Signed-off-by line in the commit message.

To avoid having PRs blocked in the future, always include Signed-off-by: Author Name <[email protected]> in every commit message. You can also do this automatically by using the -s flag (i.e., git commit -s).

Here is how to fix the problem so that this code can be merged.


Preferred method: Commit author adds a DCO remediation commit

A DCO Remediation Commit contains special text in the commit message that applies a missing Signed-off-by line in a subsequent commit. The primary benefit of this method is that the project’s history does not change, and there is no risk of breaking someone else’s work.

These authors can unblock this PR by adding a new commit to this branch with the following text in their commit message:

Ben Howe <[email protected]>

DCO Remediation Commit for Ben Howe <[email protected]>

I, Ben Howe <[email protected]>, hereby add my Signed-off-by to this commit: 84985db001c251d788d1bcf8221c4f2911581615

Signed-off-by: Ben Howe <[email protected]>

Please note: You should avoid adding empty commits (i.e., git commit -s --allow-empty), because these will be discarded if someone rebases the branch / repo.


Least preferred method: Rebase the branch

If you have a local git environment and meet the criteria below, one option is to rebase the branch and add your Signed-off-by lines in the new commits. Please note that if others have already begun work based upon the commits in this branch, this solution will rewrite history and may cause serious issues for collaborators (described in the git documentation under "The Perils of Rebasing").

You should only do this if:

  • You are the only author of the commits in this branch
  • You are absolutely certain nobody else is doing any work based upon this branch
  • There are no empty commits in the branch (for example, a DCO Remediation Commit which was added using --allow-empty)

To add your Signed-off-by line to every commit in this branch:

  1. Ensure you have a local copy of your branch by checking out the pull request locally via command line.
  2. In your local branch, run: git rebase HEAD~2 --signoff
  3. Force push your changes to overwrite the branch: git push --force-with-lease origin pr-fix-docs

Summary

Commit sha: 84985db, Author: Ben Howe, Committer: Ben Howe; The sign-off is missing.