Rooba
/
tqdm
mirror of https://github.com/tqdm/tqdm.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add docker documentation

This commit is contained in:
Casper da Costa-Luis 2019-03-02 22:27:19 +00:00
parent 0e48c1f575
commit d98871ea08
No known key found for this signature in database
GPG Key ID: 986B408043AE090D
2 changed files with 23 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
CONTRIBUTING.md
View File

@ -231,11 +231,22 @@ running `make` within the wiki repository.
[wiki]: https://github.com/tqdm/tqdm/wiki
Docker images may be uploaded to <https://hub.docker.com/r/tqdm/tqdm>.
Assuming `docker` is
[installed](https://docs.docker.com/install/linux/docker-ce/ubuntu/):
```
make -B docker
docker login
docker push tqdm/tqdm:latest
docker push tqdm/tqdm:$(docker run -i --rm tqdm/tqdm -v)
```
Snaps may be uploaded to <https://snapcraft.io/tqdm>.
Assuming `snapcraft` is installed (`snap install snapcraft --classic --beta`):
```
[python setup.py] make snap
make snap
snapcraft login
snapcraft push tqdm*.snap --release stable
```
@ -291,16 +302,20 @@ For experienced devs, once happy with local master:
9. **`[AUTO:TravisCI]`** upload to PyPI. either:
a) `[python setup.py] make pypi`, or
b) `twine upload -s -i $(git config user.signingkey) dist/tqdm-*`
10. upload to snapcraft:
a) `[python setup.py] make snap`, and
10. **`[AUTO:TravisCI]`** upload to docker hub:
a) `make -B docker`
b) `docker push tqdm/tqdm:latest`
c) `docker push tqdm/tqdm:$(docker run -i --rm tqdm/tqdm -v)`
11. upload to snapcraft:
a) `make snap`, and
b) `snapcraft push tqdm*.snap --release stable`
11. create new release on <https://github.com/tqdm/tqdm/releases>
12. create new release on <https://github.com/tqdm/tqdm/releases>
a) add helpful release notes
b) **`[AUTO:TravisCI]`** attach `dist/tqdm-*` binaries
(usually only `*.whl*`)
12. **`[SUB]`** run `make` in the `wiki` submodule to update release notes
13. **`[SUB]`** run `make deploy` in the `docs` submodule to update website
14. **`[SUB]`** accept the automated PR in the `feedstock` submodule to update conda
13. **`[SUB]`** run `make` in the `wiki` submodule to update release notes
14. **`[SUB]`** run `make deploy` in the `docs` submodule to update website
15. **`[SUB]`** accept the automated PR in the `feedstock` submodule to update conda
Key:

1
Makefile
View File

@ -159,5 +159,6 @@ docker:
@make coverclean
@make clean
docker build . -t tqdm/tqdm
docker tag tqdm/tqdm:latest tqdm/tqdm:$(shell docker run -i --rm tqdm/tqdm -v)
none:
# used for unit testing