Amend Platform and Travis scripts to fix build failures and align their process #8010
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… pip requirements, remove rst files from pip packages
robfrawley
changed the title
robfrawley
changed the title
|
Note: If you guys choose this resolution to #8009, I think we should likely rebase this onto lower branch. If this is the case, let me know what branch you guys would prefer. I'd suggest at least |
weaverryan
added a commit
that referenced
this pull request
Jun 13, 2017
…frawley) This PR was merged into the 2.7 branch. Discussion ---------- Fix and align travis and platform build environments This pull request fixes the `platform.sh` deploy and aligns the `platform.sh` and `travis-ci.org` build to use the same version constraints and environments. Per @xabbuh in #8009 (comment) this PR has been made against the `2.7` branch. Original implementation pulled from #8010 and #8009. Changes include: - Update the `pip` version requirements pulled in by [_build/.requirements.txt](https://github.com/robfrawley/symfony-docs/blob/feature-align-travis-and-platform-build/_build/.requirements.txt) to latest releases, except for `sphinx` which must be downgraded to `1.3` until we find a solution for `sphinx-php` (which there doesn't seem to be much interest in fixing: #7402 (comment), #7422, fabpot/sphinx-php#33). - Use the same package management and constraint requirements for both `platform.sh` and `travis-ci.org` by having both utilize the `_build/.requirements.txt` file when calling `pip`. - Use the same documentation build command to compile the documentation HTML (`make`) while still calling `sphinx` with "strict mode" (or, more accurately, "turn warnings into errors mode") for `travis-ci.org`. - On `platform.sh`, since the `vitrualenv` folder is at the documentation root, remove all `rst` files contained within it (pulled in from the `pip` packages) via a `find` command, so as to ensure the build doesn't pull them in (they would never appear in the output as they don't exist in the doctree, but if they contain errors or other inconsistencies, this could cause the build to fail while reading in their sources). - `find .virtualenv -type f -name "*.rst" -delete` Commits ------- 764bc37 align travis and platform build environments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a test to see if the
platform.shdeploy andtravis-ci.orgbuild complete successfully, without removing lines that break newer versions ofsphinx(as seen in #8009).The changes introduced by this pull request include:
Update the
pipversion requirements pulled in by _build/.requirements.txt to latest releases, except forsphinxwhich must be downgraded to1.3as the documentation fails to build using1.5or1.6(the latest releases) due to invalid code that causes the highlighting subroutine to fail.Use the same package management and constraint requirements for both
platform.shandtravis-ci.orgby having both utilize the_build/.requirements.txtfile when callingpip.Use the same documentation build command to compile the documentation HTML (
make) while still callingsphinxwith "strict mode" (or, more accurately, "turn warning into errors mode") fortravis-ci.org.On
platform.sh, since thevitrualenvfolder is at the documentation root, remove allrstfiles contained within it (pulled in from thepippackages) via afindcommand, so as to ensure the build doesn't pull them in (they would never appear in the output as they don't exist in the doctree, but if they contain errors or other inconsistencies, this could cause the build to fail while reading in their sources).find .virtualenv -type f -name "*.rst" -deleteThere are two main goals of this pull request:
platform.shbuild by downgrading thesphinxversion constraint (we will be forever stuck atshinx@1.3.*until we resolve the underlying issues, though: see Remove/update lines causing build failures #8009).platform.shandtravis-ci.orgso that, generally, one shouldn't fail while the other succeeds by ensuring both operate using the same build commands and constraints (relating both topipandmakecalls).