seriesseed / equity

Series Seed Preferred Stock
http://www.seriesseed.com
1.23k stars 334 forks source link

Automated Microsoft Word Builds #32

Open kemitchell opened 9 years ago

kemitchell commented 9 years ago

This pull request adds build configuration files for generating and publishing ZIP archives of .docx Word files automatically on each tagged release of Series Seed. It addresses some concerns raised in issue #24.

You can see an example of a release and a generated ZIP on the releases page of my fork.

For reasons explained below, someone should add me as a member of the seriesseed GitHub organization so that I can set up automated building and merge this PR myself. I will update the configuration files to work for the official repository, rather than my fork, and squash all the commits together so we don't have five just for build automation.

Travis CI is a free service (for open-source projects) that does automatic testing and building of projects hosted on GitHub. The new configuration files have Travis use pandoc to convert all the Markdown files in the repository to .docx, then ZIP them up and add them as a download to a GitHub release. As a member of the GitHub organization, I can enable Travis CI for seriesseed/equity and set up the right secure API access tokens for publishing build files back to GitHub. I will also go ahead and tag old numbered releases in the repository.

Generated ZIPs will not include .docx redlines, but tagging releases on GitHub will make it very easy to link to a comparison of past numbered versions. It will also make it possible to download ZIPs of each historical version of Series Seed from one page, in case someone does want to run a redline of specific versions.

If there's deep interest, we may also look into providing a different default .docx template than the one pandoc uses by default. The styles in the default seem to be the old Word 2010 defaults, with blue headings &c. They're not "lawyerly", but they're very easy to change.