6
0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-15 17:47:13 +00:00

Get rid of the "latest" release tag

The "latest" tag is a pain to maintain: it's a tag that we delete and
re-create at every release. Whenever we delete it, the binaries become
unavailable on Github until they are re-generated. Thus, from now on, we
conform to good practices (as examplified by the
github.com/docker/compose) project and distribute only pinned release.

The "nightly" tag remains, for now, as it allows us to distribute beta
features. It may disappear in the future.
This commit is contained in:
Régis Behmo 2019-04-22 13:29:53 +02:00
parent 56a48e8773
commit 847678bb07
8 changed files with 32 additions and 20 deletions

View File

@ -52,7 +52,7 @@ deploy:
skip_cleanup: true skip_cleanup: true
on: on:
tags: true tags: true
condition: $BUILD_DOCKER = true && $TRAVIS_TAG != "latest" && $TRAVIS_TAG != "nightly" condition: $BUILD_DOCKER = true && $TRAVIS_TAG != "nightly"
# Push to pypi # Push to pypi
- provider: script - provider: script
@ -60,4 +60,4 @@ deploy:
skip_cleanup: true skip_cleanup: true
on: on:
tags: true tags: true
condition: $BUILD_PYPI = true && $TRAVIS_TAG != "latest" && $TRAVIS_TAG != "nightly" condition: $BUILD_PYPI = true && $TRAVIS_TAG != "nightly"

View File

@ -20,9 +20,8 @@ dist/tutor:
nightly: ## Create a "nightly" release nightly: ## Create a "nightly" release
$(MAKE) tag TAG=nightly $(MAKE) tag TAG=nightly
release: ## Create a release, update the "latest" tag and push them to origin release: ## Create a release tag and push it to origin
$(MAKE) tag TAG=v$(shell make version) $(MAKE) tag TAG=v$(shell make version)
$(MAKE) tag TAG=latest
tag: tag:
@echo "=== Creating tag $(TAG)" @echo "=== Creating tag $(TAG)"

View File

@ -30,11 +30,7 @@ Tutor 🎓 Open edX 1-click install for everyone
Quickstart Quickstart
---------- ----------
1. `Download <https://github.com/regisb/tutor/releases>`_ the latest stable release of Tutor, uncompress the file and place the ``tutor`` executable in your path. From the command line:: 1. Install the `latest stable release <https://github.com/regisb/tutor/releases>`_ of Tutor (`Instructions for the command line <https://docs.tutor.overhang.io/install.html#direct-binary-downloads>`_)
sudo curl -L "https://github.com/regisb/tutor/releases/download/latest/tutor-$(uname -s)_$(uname -m)" -o /usr/local/bin/tutor
sudo chmod +x /usr/local/bin/tutor
2. Run ``tutor local quickstart`` 2. Run ``tutor local quickstart``
3. You're done! 3. You're done!

View File

@ -32,7 +32,8 @@ sudo curl -L "https://github.com/docker/compose/releases/download/1.23.2/docker-
sudo chmod +x /usr/local/bin/docker-compose sudo chmod +x /usr/local/bin/docker-compose
echo "=============== Installing tutor" echo "=============== Installing tutor"
sudo curl -L "https://github.com/regisb/tutor/releases/download/latest/tutor-$(uname -s)_$(uname -m)" -o /usr/local/bin/tutor export TUTOR_VERSION="$(curl -sSL https://api.github.com/repos/regisb/tutor/releases/latest | grep tag_name | sed "s/.*tag_name\": \"\(.*\)\",/\1/g")"
sudo curl -L "https://github.com/regisb/tutor/releases/download/$TUTOR_VERSION/tutor-$(uname -s)_$(uname -m)" -o /usr/local/bin/tutor
sudo chmod +x /usr/local/bin/tutor sudo chmod +x /usr/local/bin/tutor
echo "=============== Pulling vendor docker images" echo "=============== Pulling vendor docker images"

6
docs/cli_download.rst Normal file
View File

@ -0,0 +1,6 @@
.. _cli_download:
.. parsed-literal::
sudo curl -L "\ https\ ://github.com/regisb/tutor/releases/download/|tutor_version|/tutor-$(uname -s)_$(uname -m)" -o /usr/local/bin/tutor
sudo chmod +x /usr/local/bin/tutor

View File

@ -20,8 +20,8 @@
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = 'Tutor' project = 'Tutor'
copyright = u'2018, Régis Behmo' copyright = '2018, Régis Behmo'
author = u'Régis Behmo' author = 'Régis Behmo'
# The short X.Y version # The short X.Y version
version = '' version = ''
@ -128,8 +128,7 @@ latex_elements = {
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
(master_doc, 'tutor.tex', 'Tutor Documentation', (master_doc, 'tutor.tex', 'Tutor Documentation', 'Régis Behmo', 'manual'),
u'Régis Behmo', 'manual'),
] ]
@ -171,3 +170,16 @@ epub_title = project
# A list of files that should not be packed into the epub file. # A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html'] epub_exclude_files = ['search.html']
# Custom variables
import io
import os
here = os.path.abspath(os.path.dirname(__file__))
about = {}
with io.open(os.path.join(here, "..", "tutor", "__about__.py"), "rt", encoding="utf-8") as f:
exec(f.read(), about)
rst_prolog = """
.. |tutor_version| replace:: {}
""".format(
about['__version__'],
)

View File

@ -26,10 +26,9 @@ Also, the host running the containers should be a 64 bit platform. (images are n
Direct binary downloads Direct binary downloads
----------------------- -----------------------
The latest binaries can be downloaded from https://github.com/regisb/tutor/releases. From the command line:: The latest binaries can be downloaded from https://github.com/regisb/tutor/releases. From the command line:
sudo curl -L "https://github.com/regisb/tutor/releases/download/latest/tutor-$(uname -s)_$(uname -m)" -o /usr/local/bin/tutor .. include:: cli_download.rst
sudo chmod +x /usr/local/bin/tutor
This is the recommended installation method for most people. This is the recommended installation method for most people.

View File

@ -3,10 +3,9 @@
Quickstart Quickstart
========== ==========
1. `Download <https://github.com/regisb/tutor/releases>`_ the latest stable release of Tutor, uncompress the file and place the ``tutor`` executable in your path. From the command line:: 1. `Download <https://github.com/regisb/tutor/releases>`_ the latest stable release of Tutor, uncompress the file and place the ``tutor`` executable in your path. From the command line:
sudo curl -L "https://github.com/regisb/tutor/releases/download/latest/tutor-$(uname -s)_$(uname -m)" -o /usr/local/bin/tutor .. include:: cli_download.rst
sudo chmod +x /usr/local/bin/tutor
2. Run ``tutor local quickstart`` 2. Run ``tutor local quickstart``
3. You're done! 3. You're done!