Better release descriptions

By using `github-releases`, we can now generate much better release
description blurbs.
This commit is contained in:
Régis Behmo 2019-04-22 15:14:46 +02:00
parent 847678bb07
commit 1a94b05188
4 changed files with 30 additions and 9 deletions

View File

@ -34,13 +34,9 @@ script:
- make ci-bundle
deploy:
# Push tutor binary to github releases
- provider: releases
api_key:
secure: ffrhGvgxHf3WVnKsKiJZTUoEf3+ZBtIydPHQoTDmHiYMyPnaO6RJWxq5PnoDRr47b1vnvbCE0lhNsGr3sgnruQSN3xHYfT4wz1F6Lz7Y5Jt7Uq1W0/UfSRlB3BwYcFpkUb5fSXLSku+QrV8OTk/yItlY9tppnvXA9h4CZjQqgJYHYc1DRKWQVYnVs/dCttUpiPV3eyIFeQoPKFsHwZXKcm9cVzom5r+lkjwpw3AIuAutPd71jyj/Va/By6B/43yAIqw3sA/thBeL76vqd8C4cMeWE00of1EWnH+sx6pKz32Fqe/o6dVop5PZPCiI+TVIDxR8oLevHtPTCfIwRDg60y23DdH3bMGSw1bAyjeWTnhRGcdYQJi1NKq3hJ0ldy0lOFlUiMkKPdQBtU7i0xIpoXTIhnro0YUUtjbh/QEtyRn8nbMVeenId42Bymah5P8srhE8S2z0x0mirIqNlM/tgLKEOJXdSL4sPKCMwRLcTUIc0fCiwLeHJnHIrMNEfnWsqO1odzv/PS5nLsdiGHBmC63d+xLNllzincIV1djyi5SEzMZxcqmjX1n/G3nKYVXhaIQE0wWQSHqNwLlKluY0kPXCNtU1TPr5SJHGnomQKizVaEsDrdAjylBL+rPwVCAv9z8FCtyOg7uMx2WdD0pvky2Iy4rbl2RBLUHmUZoAjPY=
file: "releases/*"
file_glob: true
overwrite: true
# Create github release and push binary to github
- provider: script
script: make ci-github
skip_cleanup: true
on:
tags: true

View File

@ -46,11 +46,28 @@ ci-bundle: ## Create bundle and run basic tests
$(MAKE) ci-test
$(MAKE) bundle
mkdir -p releases/
cp ./dist/tutor ./releases/tutor-$$(uname -s)_$$(uname -m)
./dist/tutor --version
./dist/tutor config printroot
./dist/tutor config save --yes --set ACTIVATE_NOTES=true --set ACTIVATE_XQUEUE=true
ci-github: ## Upload assets to github
cat docs/release.md > releases/description.md
git log -1 --pretty=format:%b >> releases/description.md
sed -i "s/TUTOR_VERSION/v$$(make -s version)/g" releases/description.md
docker run --rm -e "GITHUB_TOKEN=$$GITHUB_TOKEN" regis/github-release:latest release \
--user regisb \
--repo tutor \
--tag "v$$(make -s version)" \
--name "v$$(make -s version)" \
--description "$$(cat releases/description.md)" || true
docker run --rm -e "GITHUB_TOKEN=$$GITHUB_TOKEN" -v "$$(pwd)/dist:/tmp/dist" regis/github-release:latest upload \
--user regisb \
--repo tutor \
--tag "v$$(make -s version)" \
--name "tutor-$$(uname -s)_$$(uname -m)" \
--file /tmp/dist/tutor \
--replace
ci-images: ## Build and push docker images to hub.docker.com
python setup.py develop
tutor images build all

View File

@ -30,7 +30,7 @@ Tutor 🎓 Open edX 1-click install for everyone
Quickstart
----------
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>`_)
1. Install the `latest stable release <https://github.com/regisb/tutor/releases>`_ of Tutor
2. Run ``tutor local quickstart``
3. You're done!

8
docs/release.md Normal file
View File

@ -0,0 +1,8 @@
Tutor can be installed simply by downloading the compiled binaries:
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
See the [install docs](https://docs.tutor.overhang.io/install.html) for more install options and instructions.
## Features