kopia lustrzana https://github.com/jupyterhub/repo2docker
Add a CONTRIBUTING.md
Thanks to @willingc for editing the release process notespull/224/head
rodzic
a7e2355a39
commit
01522559f2
|
@ -7,12 +7,12 @@ python:
|
|||
install:
|
||||
# Make a wheel and install it to test to catch possible
|
||||
# issues with MANIFEST.in
|
||||
- pip install --no-cache-dir pyyaml pytest wheel
|
||||
- pip install --no-cache-dir -r dev-requirements.txt
|
||||
- python setup.py bdist_wheel
|
||||
- pip install dist/*.whl
|
||||
|
||||
script:
|
||||
# cd into tests so CWD being repo2docker does not hide
|
||||
# cd into tests so CWD being repo2docker does not hide
|
||||
# possible issues with MANIFEST.in
|
||||
- cd tests && pytest -s -v ${REPO_TYPE}
|
||||
|
||||
|
|
|
@ -0,0 +1,139 @@
|
|||
# Local Development
|
||||
|
||||
To develop & test repo2docker locally, you need:
|
||||
|
||||
1. Familiarity with using a command line terminal
|
||||
2. A computer running macOS / Linux
|
||||
3. Some knowledge of git
|
||||
4. At least python 3.4
|
||||
5. Your favorite text editor
|
||||
6. A recent version of [Docker Community Edition](https://www.docker.com/community-edition)
|
||||
|
||||
## Clone the repository
|
||||
|
||||
First, you need to get a copy of the repo2docker git repository on your local
|
||||
disk.
|
||||
|
||||
```bash
|
||||
git clone https://github.com/jupyter/repo2docker
|
||||
```
|
||||
|
||||
This will clone repo2docker into a directory called `repo2docker`. You can
|
||||
make that your current directory with `cd repo2docker`.
|
||||
|
||||
## Set up local virtual environment
|
||||
|
||||
After cloning the repository (or your fork of the repo), you should set up an
|
||||
isolated environment to install libraries required for running / developing
|
||||
repo2docker. There are many ways to do this, and a `virtual environment` is
|
||||
one of them.
|
||||
|
||||
```bash
|
||||
python3 -m venv .
|
||||
source bin/activate
|
||||
pip3 install -e .
|
||||
pip3 install -r dev-requirements.txt
|
||||
```
|
||||
|
||||
This should install all the libraries required for testing & running repo2docker!
|
||||
|
||||
## Verify that docker is installed and running
|
||||
|
||||
If you do not already have [Docker](https://www.docker.com/), you should be able
|
||||
to download and install it for your operating system using the links from the
|
||||
[official website](https://www.docker.com/community-edition). After you have
|
||||
installed it, you can verify that it is working by running the following commands:
|
||||
|
||||
```bash
|
||||
docker version
|
||||
```
|
||||
|
||||
It should output something like:
|
||||
|
||||
```
|
||||
Client:
|
||||
Version: 17.09.0-ce
|
||||
API version: 1.32
|
||||
Go version: go1.8.3
|
||||
Git commit: afdb6d4
|
||||
Built: Tue Sep 26 22:42:45 2017
|
||||
OS/Arch: linux/amd64
|
||||
|
||||
Server:
|
||||
Version: 17.09.0-ce
|
||||
API version: 1.32 (minimum version 1.12)
|
||||
Go version: go1.8.3
|
||||
Git commit: afdb6d4
|
||||
Built: Tue Sep 26 22:41:24 2017
|
||||
OS/Arch: linux/amd64
|
||||
Experimental: false
|
||||
```
|
||||
|
||||
Then you are good to go!
|
||||
|
||||
## Running tests
|
||||
|
||||
We have a lot of tests for various cases supported by repo2docker in the `tests/`
|
||||
subdirectory. These use [py.test](https://docs.pytest.org/).
|
||||
|
||||
You can run all the tests with:
|
||||
|
||||
```bash
|
||||
py.test -s tests/*
|
||||
```
|
||||
|
||||
If you want to run a specific test, you can do so with:
|
||||
|
||||
```bash
|
||||
py.test -s tests/<path-to-test>
|
||||
```
|
||||
|
||||
# Release Process
|
||||
|
||||
We try to make a release of repo2docker every few months if possible.
|
||||
|
||||
## Access
|
||||
|
||||
To release repo2docker, you will need proper access credentials prior to beginning the process.
|
||||
|
||||
1. Access to the PyPI package for repo2docker
|
||||
2. Access to push tags to the jupyter/repo2docker repository
|
||||
3. Acess to push images to dockerhub on jupyter/repo2docker
|
||||
|
||||
If you do not have access to any of these, please contact a current maintainer of the project!
|
||||
|
||||
## Steps
|
||||
|
||||
1. Make a PR bumping version number of repo2docker in the
|
||||
`setup.py` file (like https://github.com/jupyter/repo2docker/pull/221),
|
||||
get it merged, and make sure your local checkout is the
|
||||
same as `master` on GitHub.
|
||||
|
||||
2. In your environment, install packages needed to make releases:
|
||||
```bash
|
||||
pip install wheel twine
|
||||
```
|
||||
|
||||
3. Clean out the `dist` directory and then build the `wheel` and `tar.gz` files:
|
||||
```bash
|
||||
rm -f dist/*
|
||||
python setup.py sdist bdist_wheel
|
||||
```
|
||||
4. Once tests pass, time to upload!
|
||||
```bash
|
||||
twine upload dist/*
|
||||
```
|
||||
|
||||
This might ask for your PyPI username and password.
|
||||
|
||||
5. Make a git tag and push it to GitHub:
|
||||
```bash
|
||||
git tag -a v<version>
|
||||
git push official --tags
|
||||
```
|
||||
|
||||
6. Tag and push a docker image:
|
||||
```bash
|
||||
docker build -t jupyter/repo2docker:v<version> .
|
||||
docker push jupyter/repo2docker:v<version>
|
||||
```
|
|
@ -0,0 +1,3 @@
|
|||
pyyaml
|
||||
pytest
|
||||
wheel
|
Ładowanie…
Reference in New Issue