Skip to content

Comments

Add skipPublishDocGithubIo for all Spring starters#29009

Merged
saragluna merged 2 commits intoAzure:mainfrom
saragluna:xiada/add-skip-pub-doc-to-github
May 24, 2022
Merged

Add skipPublishDocGithubIo for all Spring starters#29009
saragluna merged 2 commits intoAzure:mainfrom
saragluna:xiada/add-skip-pub-doc-to-github

Conversation

@saragluna
Copy link
Member

Description

The Spring starters have no Javadocs, so we should stop publishing the empty Javadoc jars to the GitHub IO site. This PR will add the skipPublishDocGithubIo: true to all Spring starters.

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

@saragluna saragluna requested a review from hallipr as a code owner May 21, 2022 02:53
@ghost ghost added the azure-spring All azure-spring related issues label May 21, 2022
@saragluna saragluna requested a review from JimSuplizio May 21, 2022 02:55
@saragluna saragluna self-assigned this May 23, 2022
@saragluna saragluna added this to the [2022] June milestone May 23, 2022
@XiaofeiCao
Copy link
Contributor

@saragluna
Copy link
Member Author

Hi @XiaofeiCao, I checked the pipeline and it's because we are using a README file in sdk/spring folder, but this file is not checked out in the Sparse checkout repositories step. So merging this PR won't fix the issue. Let's see how to address it.

@saragluna
Copy link
Member Author

Hi @XiaofeiCao, I just created this #29013 to fix the issue.

@XiaofeiCao
Copy link
Contributor

Hi @XiaofeiCao, I just created this #29013 to fix the issue.

Thanks!

Copy link
Contributor

@JimSuplizio JimSuplizio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @saragluna. This makes the doc publishing (or lack thereof) consistent.

@JimSuplizio
Copy link
Contributor

Hi @saragluna, when will this PR be merged? I'm getting ci error here: https://dev.azure.com/azure-sdk/public/_build/results?buildId=1592813&view=logs&jobId=7108164a-7e0a-5672-22b4-83801a88006a&j=7108164a-7e0a-5672-22b4-83801a88006a&t=c2ae752a-fb25-5514-4562-48637360b096

Thought this PR would fix this?

@saragluna the problem here is that every library, in theory, is supposed to have a README and that's what should be included in the empty javadoc/sources, not the root README. Spring seems to be an exception to this. I'm looking at changing the sparse checkout paths generated for the FromSource runs to accommodate this but that probably won't be fixed until tomorrow (Tuesday, May 24th).

@saragluna
Copy link
Member Author

saragluna commented May 24, 2022

@JimSuplizio, we are trying to see whether we could skip the README.md files in Spring empty Javadoc or sources jar files in #29014. The jar files will contain a META-INF folder, which means they are not empty.

@saragluna saragluna merged commit 42844e2 into Azure:main May 24, 2022
@saragluna saragluna deleted the xiada/add-skip-pub-doc-to-github branch May 24, 2022 02:40
@JimSuplizio
Copy link
Contributor

@JimSuplizio, we are trying to see whether we could skip the README.md files in Spring empty Javadoc or sources jar files in #29014. The jar files will contain a META-INF folder, which means they are not empty.

@saragluna there's a reason we're putting the README into the 'empty' sources and javadocs and that's because of explicit instructions for publishing.
If, for some reason (for example, license issue or it's a Scala project), you can not provide -sources.jar or -javadoc.jar , please make fake -sources.jar or -javadoc.jar with simple README inside to pass the checking. We do not want to disable the rules because some people tend to skip it if they have an option and we want to keep the quality of the user experience as high as possible.

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

Labels

azure-spring All azure-spring related issues

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants