Skip to content

[Backport 2.x] [Javadoc] Add missing package-info.java files to server#3129

Merged
dblock merged 1 commit into2.xfrom
backport/backport-3128-to-2.x
May 3, 2022
Merged

[Backport 2.x] [Javadoc] Add missing package-info.java files to server#3129
dblock merged 1 commit into2.xfrom
backport/backport-3128-to-2.x

Conversation

@opensearch-trigger-bot
Copy link
Copy Markdown
Contributor

Backport 2146827 from #3128

In preparation for re-enabling the missingJavadoc gradle task this change adds
in the missing package-info.java files to the server folder. For now general
javadocs are added to these files with the intent to clean up with better
descriptions over time.

Signed-off-by: Nicholas Walter Knize <nknize@apache.org>
(cherry picked from commit 2146827)
@opensearch-trigger-bot opensearch-trigger-bot bot requested a review from a team as a code owner May 2, 2022 19:32
@opensearch-ci-bot
Copy link
Copy Markdown
Collaborator

✅   Gradle Check success 4e00add
Log 4906

Reports 4906

@dblock
Copy link
Copy Markdown
Member

dblock commented May 2, 2022

@nknize s'up your DCO always fails on backports?

@nknize
Copy link
Copy Markdown
Contributor

nknize commented May 2, 2022

@nknize s'up your DCO always fails on backports?

I wonder if it's because I use my own GPG key instead of default github to sign commits?

We might want to check the backport action.

@dblock
Copy link
Copy Markdown
Member

dblock commented May 2, 2022

I have my own gpg key too.

@nknize
Copy link
Copy Markdown
Contributor

nknize commented May 2, 2022

No idea then. Maybe DCO check doesn't like my commits opened by anyone other than me? 😂

I always have to check out the backport branch and amend the commit. It's a pain.

/cc @VachaShah @peternied @peterzhuamazon

@VachaShah
Copy link
Copy Markdown
Contributor

No idea then. Maybe DCO check doesn't like my commits opened by anyone other than me? 😂

I always have to check out the backport branch and amend the commit. It's a pain.

/cc @VachaShah @peternied @peterzhuamazon

It would be because your DCO sign off is Signed-off-by: Nicholas Walter Knize <nknize@apache.org> on the original PR while the backport workflow picks the user name and user email from your github to add as author:

[backport/backport-3128-to-2.x 4e00adde8e5] [Javadoc] Add missing package-info.java files to server (#3128)
   Author: Nick Knize <nknize@apache.org>
   Date: Mon May 2 14:30:53 [20](https://github.com/opensearch-project/OpenSearch/runs/6263087135?check_suite_focus=true#step:3:20)22 -0500

@peternied
Copy link
Copy Markdown
Member

peternied commented May 2, 2022

@nknize I've set the DCO check to pass. You are free to merge as far as the CI checks go!

@nknize
Copy link
Copy Markdown
Contributor

nknize commented May 2, 2022

Thank you @peternied

...the backport workflow picks the user name and user email from your github to add as author:

Thanks for clarifying @VachaShah! My apache gpg key needs my full name to match. Is there any way the DCO workflow can pull the name from the original author sign-off instead of github display name?

@dblock
Copy link
Copy Markdown
Member

dblock commented May 3, 2022

@nknize I've set the DCO check to pass. You are free to merge as far as the CI checks go!

What do you click to do this?

@dblock dblock merged commit be2a9ae into 2.x May 3, 2022
@github-actions github-actions bot deleted the backport/backport-3128-to-2.x branch May 3, 2022 14:19
@peternied
Copy link
Copy Markdown
Member

Inside the GHA details there is UX that includes a 'Set DCO to pass' button, that is what I used to bypass the check. This option is only available to all users with write access to the repo.
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants