From 3bb8061f802be846016207fa862996e201066279 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Fri, 17 Mar 2017 15:52:28 -0400 Subject: [PATCH] An indicator of the Open edX release line --- openedx/core/release.py | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 openedx/core/release.py diff --git a/openedx/core/release.py b/openedx/core/release.py new file mode 100644 index 0000000000..409f8aa6d9 --- /dev/null +++ b/openedx/core/release.py @@ -0,0 +1,19 @@ +""" +Information about the release line of this Open edX code. +""" + +# The release line: an Open edX release name ("ficus"), or "master". +# This should always be "master" on the master branch, and will be changed +# manually when we start release-line branches, like open-release/ficus.master. +RELEASE_LINE = "master" + + +def doc_version(): + """The readthedocs.org version name used in documentation references. + + Returns a short string like "latest" or "open-release-ficus.master". + """ + if RELEASE_LINE == "master": + return "latest" + else: + return "open-release-{}.master".format(RELEASE_LINE)