Make generation of demo.svg deterministic #625
Merged
Conversation
This file contains 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
|
|
Helcaraxan
force-pushed
the
fix/demo-svg-gen
branch
3 times, most recently
from
62af2cd
to
c116eaf
Compare
Helcaraxan
force-pushed
the
fix/demo-svg-gen
branch
from
c116eaf
to
fa2b1a4
Compare
Helcaraxan
commented
Jul 26, 2019
| @@ -1,11 +1,15 @@ | |||
| sudo: false | |||
There was a problem hiding this comment.
Removing this as it's deprecated according to Travis documentation.
|
Any news from the maintainers ? |
|
Unfortunately not. I can't seem to find any trace of their activity on the project over the past 3 weeks. Probably due to it being the summer holiday season, so quite understandable. 🙂 |
Closed
|
thank you! |
|
You're welcome. 🙂 Happy to see this getting merged! |
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.
While working on #605 we found out that the PR's CI revealed an unexpected diff in
docs/demo.svg. CI onmasterlooked fine as well but I could reproduce the failure nonetheless locally by runningmake -B docs/demo.svg.The rootcause is as follows:
The generation of
demo.svgdepends on a Node tool that is installed vianpm install svg-term-cli. Underneath this thenpmcommand performs its own recursive dependency resolution and fetches the latest version (that is compatible with any existing version constraints) of all required direct & indirect dependencies.The latest CI run on
masterdates back to 13/14 July and passed correctly. Since then thesvgoNPM package, a direct dependency ofsvg-term-cli, released a new minor version making the most recent version1.3.0instead of1.2.2which is still compatible with the>=1.0.3constraint defined bysvg-term-cli. The move from1.2.2to1.3.0apparently introduced a change that resulted in a diff in the generateddocs/demo.svgfile.The solution here (and which will help prevent this occurring in the future as well) is to fix the versions of all (in)direct dependencies used to install the
svg-term-clipackage.This is achieved by creating a fake NPM package in the
toolsfolder using apackage.jsonwithsvg-term-clias a dependency and apackage-lock.jsonfile to hardcode the required version for each dependency. This also allows us to runnpm ciinstead ofnpm install svg-term-cliwhich is designed specifically for the automated runs of a CI environment.This will make the generation of
docs/demo.svgdeterministic and allows the safe upgrade of any of the required package versions in the future via code-reviewed updates to thepackage.jsonandpackage-lock.jsonfiles.