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

Make docs doesn't return errors? #13864

Closed
ph opened this issue Oct 1, 2019 · 3 comments
Closed

Make docs doesn't return errors? #13864

ph opened this issue Oct 1, 2019 · 3 comments
Labels
docs needs_team Indicates that the issue/PR needs a Team:* label Stalled :Testing

Comments

@ph
Copy link
Contributor

ph commented Oct 1, 2019

I've come across an issue in a build doc in #13336 and I think it's worth investigating, the PR was making the main doc build fails but the "make docs" was working and did not complain at all. I've fixed the issue in #13862.

I think it worth investigating why this is the case, I mean we do test locally the build with make docs and it would be nice that we can have a 1:1 representation of the build.

@andrewkroh
Copy link
Member

Looks like the script should be setting the return code:

Double-check these (I think they're OK):

beats/Makefile

Lines 132 to 134 in 4131241

docs:
@$(foreach var,$(PROJECTS),BUILD_DIR=${BUILD_DIR} $(MAKE) -C $(var) docs || exit 1;)
sh ./script/build_docs.sh dev-guide github.com/elastic/beats/docs/devguide ${BUILD_DIR}

docs: ## @build Builds the documentation for the beat
@if [ -d $(XPACK_DIR) ]; then \
sh ${ES_BEATS}/script/build_docs.sh ${BEAT_NAME} ${BEAT_PATH}/docs ${BUILD_DIR} ${XPACK_DIR}; \
else \
sh ${ES_BEATS}/script/build_docs.sh ${BEAT_NAME} ${BEAT_PATH}/docs ${BUILD_DIR}; \
fi

@botelastic
Copy link

botelastic bot commented Mar 18, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@botelastic botelastic bot added Stalled needs_team Indicates that the issue/PR needs a Team:* label labels Mar 18, 2021
@botelastic
Copy link

botelastic bot commented Mar 18, 2021

This issue doesn't have a Team:<team> label.

@botelastic botelastic bot closed this as completed Apr 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs needs_team Indicates that the issue/PR needs a Team:* label Stalled :Testing
Projects
None yet
Development

No branches or pull requests

2 participants