1
1
Development
2
2
===========
3
3
4
- To contribute to `pytest-variables ` you can use `Pipenv `_ to manage
4
+ To contribute to `pytest-variables ` you can use `Poetry < https://python-poetry.org/ > `_ to manage
5
5
a python virtual environment and `pre-commit <https://pre-commit.com/ >`_ to help you with
6
6
styling and formatting.
7
7
8
8
To setup the virtual environment and pre-commit, run:
9
9
10
10
.. code-block :: bash
11
11
12
- $ pipenv install --dev
13
- $ pipenv run pre-commit install
12
+ $ poetry install
13
+ $ poetry run pre-commit install
14
14
15
- If you're not using `Pipenv `_ , to install `pre-commit `, run:
15
+ If you're not using `` Poetry `` , to install `` pre-commit ` `, run:
16
16
17
17
.. code-block :: bash
18
18
19
19
$ pip install pre-commit
20
20
$ pre-commit install
21
21
22
+
22
23
Automated Testing
23
24
-----------------
24
25
25
- All pull requests and merges are tested in `Travis CI <https://travis-ci.org/ >`_
26
- based on the ``.travis.yml `` file.
27
-
28
- Usually, a link to your specific travis build appears in pull requests, but if
29
- not, you can find it on the
30
- `pull requests page <https://travis-ci.org/pytest-dev/pytest-variables/pull_requests >`_
31
-
32
- The only way to trigger Travis CI to run again for a pull request, is to submit
33
- another change to the pull branch.
34
-
35
- You can do this with `git commit --allow-empty `
26
+ All pull requests and merges are tested in `GitHub Actions <https://docs.github.com/en/actions >`_
27
+ based on the workflows defined in ``.github/workflows ``.
36
28
37
29
Running Tests
38
30
-------------
39
31
40
- You will need `Tox <http ://tox.testrun.org / >`_ installed to run the tests
41
- against the supported Python versions. If you're using `Pipenv `_ it will be
32
+ You will need `Tox <https ://tox.wiki/en/latest / >`_ installed to run the tests
33
+ against the supported Python versions. If you're using `` Poetry `` it will be
42
34
installed for you.
43
35
44
- With `Pipenv `_ , run:
36
+ With `` Poetry `` , run:
45
37
46
38
.. code-block :: bash
47
39
48
- $ pipenv run tox
40
+ $ poetry run tox
49
41
50
42
Otherwise, to install and run, do:
51
43
@@ -59,11 +51,12 @@ Releasing a new version
59
51
60
52
Follow these steps to release a new version of the project:
61
53
62
- 1. Update your local master with the upstream master (``git pull --rebase upstream master ``)
63
- 2. Create a new branch and update ``CHANGES.rst `` with the new version, today's date, and all changes/new features
64
- 3. Commit and push the new branch and then create a new pull request
65
- 4. Wait for tests and reviews and then merge the branch
66
- 5. Once merged, update your local master again (``git pull --rebase upstream master ``)
67
- 6. Tag the release with the new release version (``git tag v<new tag> ``)
68
- 7. Push the tag (``git push upstream --tags ``)
69
- 8. Done. You can monitor the progress on `Travis <https://travis-ci.org/pytest-dev/pytest-variables/ >`_
54
+ #. Update your local master with the upstream master (``git pull --rebase upstream master ``)
55
+ #. Create a new branch and update ``CHANGES.rst `` with the new version, today's date, and all changes/new features
56
+ #. Update ``pyproject.toml `` with the new version
57
+ #. Commit and push the new branch and then create a new pull request
58
+ #. Wait for tests and reviews and then merge the branch
59
+ #. Once merged, update your local master again (``git pull --rebase upstream master ``)
60
+ #. Tag the release with the new release version (``git tag v<new tag> ``)
61
+ #. Push the tag (``git push upstream --tags ``)
62
+ #. Done.
0 commit comments