[Enhancement] Versioning and Backwards Compatibility #48
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
Starting with v1.2, every minor version's assets will be hosted in a separate directory (so that specs that use older versions of Primer Spec will still render correctly).
The script not only updates the VERSION file, but also creates new directories in the assets/ if appropriate, and updates _layouts/spec.html to use these new directories.
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 PR updates the structure of the Primer Spec site to host released binaries for all minor versions, starting with version 1.2. This change will provide backwards compatibility for specs that were generated using an older version of Primer Spec (for instance, archived versions of specs from past semesters).
To enable this backwards compatibility, the following changes needed to be made:
assetsdirectory for this site now contains a directory for CSS and JS files for each minor version.assets/location._layouts/spec.htmland_includes/spec_before_main_content.htmlreference the current version's assets. This ensures that when a site is built with Primer Spec, it will always download that particular version's assets.script/versionmakes it easy to bump the version as required. Major and minor version bumps also require changes to the above files, so this script automates that.script/version.Before the next release freeze, I will test this change with actual GitHub Pages sites.
@awdeorio: If you have a chance, I'd definitely appreciate a second pair of eyes on my updates to the documentation (especially
CONTRIBUING.md). 😃