elastic / elastic/docs

Handling previews for PRs against feature branches

Open
#1,693 1 comment 0 reactions 0 assignees View on GitHub
defer preview team-discuss
Dominant language
Ruby
Stars
265
Forks
347
Avg merge
3d 15h
Merged PRs (30d)
2

Description

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

For example, in https://github.com/elastic/elasticsearch/pull/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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.