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

versioning, epubReadingSystem, grunt build task, git-describe #63

Closed
danielweck opened this issue Jul 8, 2014 · 7 comments
Closed

versioning, epubReadingSystem, grunt build task, git-describe #63

danielweck opened this issue Jul 8, 2014 · 7 comments
Assignees

Comments

@danielweck
Copy link
Member

This applies to all "launcher" repositories, of which the Readium cloud reader / Chrome extension is one.
Currently, the build script works, but the navigator.epubReadingSystem runtime object is not populated with the versioning information.

@danielweck
Copy link
Member Author

@danielweck
Copy link
Member Author

@danielweck
Copy link
Member Author

See also submodules (only additions "readium-module.json" and "update-version.sh"):
https://github.com/readium/readium-js/tree/feature/version
https://github.com/readium/readium-shared-js/tree/feature/version

@danielweck
Copy link
Member Author

Note that the grunt shell invoke is asynchronous, so unlike git-describe it doesn't actually work properly right now.
WIP!
https://github.com/readium/readium-js-viewer/blob/feature/version/grunt/epubReadingSystem_processModules.js#L37

@danielweck
Copy link
Member Author

@ryanackley thank you very much, this looks great!

I added a separate issue for v1+ (populate epubReadingSystem with detailed version info, similar to my original feature branch):
readium/readium-shared-js#104

@danielweck
Copy link
Member Author

@ryanackley here is a follow-up to this, now populating the navigator.epubReadingSystem object: #222

The aforementioned Pull Request includes a new EPUB (in epub_library.json), to display/dump the augmented navigator.epubReadingSystem object (which now contains an additional "readium" field).

Note: this is a simpler design compared to my original "version" feature branch (linked a few comments above), as this is not using a generic hierarchical data structure to describe submodule dependencies (the 3 repository references are hard-coded, piggy-backing on the existing "versioning" code that looks at readium-js-viewer, readium-js, and readium-shared-js). Furthermore, there is no build-time "git-describe" to automatically extract the nearest tag/release name (if needed, this can be obtained "after the fact" from the provided git commit SHA using the command line 'git name-rev --tags --name-only SHA').

I'd appreciate your feedback, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants