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

Handling previews for PRs against feature branches #1693

Open
lcawl opened this issue Jan 10, 2020 · 1 comment
Open

Handling previews for PRs against feature branches #1693

lcawl opened this issue Jan 10, 2020 · 1 comment
Labels
defer preview About the preview service canonically hosted on docs-preview.app.elstc.co team-discuss

Comments

@lcawl
Copy link
Contributor

lcawl commented Jan 10, 2020

It seems that documentation previews are not generated for feature branches.

For example, in elastic/elasticsearch#50821 the elasticsearch-ci/docs check is successful but doesn't generate previews and the log says:

15:21:37 INFO:build_docs:No changes to push

There are in fact documentation changes in that PR, however, so it seems to me that check is providing misinformation.

I think we should make it clearer somehow that folks need to do their own documentation builds to verify changes in these types of PRs. For example, maybe it's simplest to just disable these checks entirely on the branches that can't generate docs (so they're not giving false success indicators). Or else enable correct testing for all branches.

@nik9000
Copy link
Member

nik9000 commented Jan 10, 2020

It's be fairly easy to add the feature branch to the list of branches for which we build docs. Then the docs for the feature branch would be public and we'd build the docs on previews. The feels like the right kind of public for us.

@gtback gtback added the preview About the preview service canonically hosted on docs-preview.app.elstc.co label May 14, 2020
@gtback gtback added the defer label Sep 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
defer preview About the preview service canonically hosted on docs-preview.app.elstc.co team-discuss
Projects
None yet
Development

No branches or pull requests

3 participants