DOCS-646: dynamically compiling release versions into download commands

Author: Sam Kleinman

.gitignore

@@ -8,3 +8,4 @@ build/*
 *.bak
 .DS_Store
 source/includes/hash.rst
+source/includes/install-curl-release*.rst

bin/update_hash.py

@@ -1,6 +1,5 @@
 #!/usr/bin/python
 
-
 from mongodb_docs_meta import get_commit
 
 def main():

bin/update_release.py

@@ -0,0 +1,52 @@
+#!/usr/bin/python
+
+import sys
+import os 
+sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "../")))
+import conf
+
+def cli():
+    try: 
+        builder = sys.argv[1]
+    except IndexError: 
+        exit('[build]: Error. No builder specified.')
+
+    if builder == 'linux-32':
+        builder = 'linux-i686'
+        platform = 'linux'
+    elif builder == 'linux-64':
+        builder = 'linux-x86_86'
+        platform = 'linux'
+    elif builder == 'osx':
+        builder = 'osx-x86_86'
+        platform = 'osx'
+    else: 
+        print(sys.argv[1])
+        exit('[build]: Error. Builder argument, must be "linux-32", "linux-64", or "osx".')
+
+    try:
+        outputfile = sys.argv[2]
+    except IndexError: 
+        exit('[build]: Error. No output file specified to "update_release.py"')
+
+    return { 'outputfile': outputfile, 'builder': builder, 'platform': platform }
+
+def generate_output(builder, platform, version):
+    BREAK = '\n\n'
+    INDENT = '   '
+
+    output = ('.. code-block:: sh' + '\n\n' + 
+              '   curl http://downloads.mongodb.org/' + platform + '/mongodb-' + 
+              builder + '-' + version + '.tgz > mongo.tgz' + '\n')
+
+    return output
+
+def main():
+    interface = cli()
+    output = generate_output(interface['builder'], interface['platform'], conf.version) 
+
+    with open(interface['outputfile'], 'w') as f: 
+        f.write(output)
+
+if __name__ == '__main__':
+    main()

conf.py

@@ -48,9 +48,8 @@
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
+# built documents. The value of ``version`` is used in the paths for the curl commands. 
+
 version = '2.2.0'
 release = version
 

makefile

@@ -113,7 +113,7 @@ endif
 # access these targets through the ``publish`` target.
 .PHONY: initial-dependencies static-components sphinx-components post-processing
 
-pre-build-dependencies:setup source/includes/hash.rst source/about.txt
+pre-build-dependencies:setup source/tutorial/install-mongodb-on-linux.txt source/tutorial/install-mongodb-on-os-x.txt source/includes/hash.rst source/about.txt
 initial-dependencies:$(public-branch-output)/MongoDB-Manual.epub
 	@echo [build]: completed the pre-publication routine for the $(manual-branch) branch of the Manual.
 static-components:$(public-output)/index.html $(public-output)/10gen-gpg-key.asc $(public-output)/10gen-security-gpg-key.asc $(public-branch-output)/.htaccess $(public-branch-output)/release.txt $(public-output)/osd.xml
@@ -127,15 +127,35 @@ sphinx-components:$(public-branch-output)/MongoDB-Manual.pdf $(public-branch-out
 # Build the HTML components of the build.
 #
 
+.PHONY:instalation-guides source/tutorial/install-mongodb-on-linux.txt source/tutorial/install-mongodb-on-os-x.txt 
+.PHONY:source/includes/install-curl-release-linux-64.rst source/includes/install-curl-release-linux-32.rst source/includes/install-curl-release-osx-64.rst 
+instalation-guides:source/tutorial/install-mongodb-on-linux.txt source/tutorial/install-mongodb-on-os-x.txt
+source/tutorial/install-mongodb-on-linux.txt:source/includes/install-curl-release-linux-64.rst
+	@touch $@
+	@echo [build]: touched $@ to ensure a clean build.
+source/tutorial/install-mongodb-on-os-x.txt:source/includes/install-curl-release-osx-64.rst 
+	@echo [build]: touched $@ to ensure a clean build.
+source/includes/install-curl-release-linux-64.rst:source/includes/install-curl-release-linux-32.rst
+	@$(PYTHONBIN) bin/update_release.py linux-64 $@
+#	@git update-index --assume-unchanged $@
+	@echo [build]: \(re\)generated $@.
+source/includes/install-curl-release-linux-32.rst:
+	@$(PYTHONBIN) bin/update_release.py linux-32 $@
+#	@git update-index --assume-unchanged $@
+	@echo [build]: \(re\)generated $@.
+source/includes/install-curl-release-osx-64.rst:
+	@$(PYTHONBIN) bin/update_release.py osx $@
+#	@git update-index --assume-unchanged $@
+	@echo [build]: \(re\)generated $@.
+
 .PHONY:source/about.txt source/includes/hash.rst setup
 
 setup:source/includes/hash.rst
 	@mkdir -p $(public-branch-output)
 	@echo [build]: created $(public-branch-output)
-
 source/includes/hash.rst:
 	@$(PYTHONBIN) bin/update_hash.py
-	@git update-index --assume-unchanged source/includes/hash.rst
+	@git update-index --assume-unchanged $@
 	@echo [build]: \(re\)generated $@.
 source/about.txt:setup
 	@touch $@

source/includes/install-curl-release-linux-32.rst

@@ -0,0 +1,6 @@
+.. this file is generated with a dynamic release number by the build
+   process.
+
+.. code-block:: sh
+
+   curl http://downloads.mongodb.org/linux/mongodb-linux-i686-x.y.z.tgz > mongo.tgz

source/includes/install-curl-release-osx-64.rst

@@ -0,0 +1,6 @@
+.. this file is generated with a dynamic release number by the build
+   process.
+
+.. code-block:: sh
+
+   curl http://downloads.mongodb.org/linux/mongodb-osx-x86_64-x.y.z.tgz > mongo.tgz

source/tutorial/install-mongodb-on-linux.txt

@@ -40,22 +40,11 @@ Download MongoDB
 In a terminal session, begin by downloading the latest release. In
 most cases you will want to download the 64-bit version of MongoDB.
 
-.. code-block:: sh
-
-   curl http://downloads.mongodb.org/linux/mongodb-linux-x86_64-x.y.z.tgz > mongo.tgz
+.. include:: /includes/install-curl-release-linux-64.rst
 
 If you need to run the 32-bit version, use the following command.
 
-.. code-block:: sh
-
-   curl http://downloads.mongodb.org/linux/mongodb-linux-i686-x.y.z.tgz > mongo.tgz
-
-.. note::
-
-   Replace x.y.z with the current stable version (i.e. |version|).
-
-   You may also choose to install a development release, in which case
-   you will need to specify that version number above.
+.. include:: /includes/install-curl-release-linux-32.rst
 
 Once you've downloaded the release, issue the following command to
 extract the files from the archive:

source/tutorial/install-mongodb-on-os-x.txt

@@ -127,36 +127,16 @@ OS X, which may provide a more straightforward installation process.
 Download MongoDB
 ~~~~~~~~~~~~~~~~
 
-In a terminal session, begin by downloading the latest release. In
-most cases you will want to download the 64-bit version of MongoDB.
+In a terminal session, begin by downloading the latest release. Use
+the following command at the system prompt:
 
-.. code-block:: sh
-
-   curl http://downloads.mongodb.org/osx/mongodb-osx-x86_64-x.y.z.tgz > mongo.tgz
-
-If you need to run the 32-bit version, use the following command:
-
-.. code-block:: sh
-
-   curl http://downloads.mongodb.org/osx/mongodb-osx-i386-x.y.z.tgz > mongo.tgz
-
-.. note::
-
-   Replace x.y.z with the current stable version (i.e. |version|).
-
-   You may also choose to install a development release, in which case
-   you will need to specify that version number above.
+.. include:: /includes/install-curl-release-osx-64.rst
 
 .. note::
 
    The :program:`mongod` process will not run on older Macintosh computers
    with PowerPC (i.e. non-Intel) processors.
 
-   While 32-bit builds of MongoDB are fine for testing purposes, it is
-   impossible to use multi-gigabyte databases with 32-bit systems. All
-   recent Macintosh systems (including all Intel-based systems) have
-   support for 64-bit builds of MongoDB.
-
 Once you've downloaded the release, issue the following command to
 extract the files from the archive: