|
4 | 4 |
|
5 | 5 | ## Install
|
6 | 6 |
|
7 |
| -**RENAME NOTICE (2022-08-05):** This package will be renamed to `epidatpy`. |
8 |
| -Please adjust all references to the package name accordingly. |
9 |
| -For a short-term fix, the package can be used with the old name by installing with `ref="delphi_epidata-before-rename"`. |
10 |
| - |
11 | 7 | Install latest version:
|
12 | 8 |
|
13 | 9 | ```sh
|
14 | 10 | pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy"
|
15 | 11 | ```
|
16 | 12 |
|
17 |
| -old name version |
18 |
| - |
19 |
| -```sh |
20 |
| -pip install -e "git+https://github.com/cmu-delphi/epidatpy.git@delphi_epidata-before-rename#egg=delphi_epidata" |
21 |
| -``` |
22 |
| - |
23 | 13 | ## Usage
|
24 | 14 |
|
25 | 15 | TODO
|
@@ -53,13 +43,13 @@ inv release # upload the current version to pypi
|
53 | 43 | The release consists of multiple steps which can be all done via the GitHub website:
|
54 | 44 |
|
55 | 45 | 1. Go to [create_release GitHub Action](https://github.com/cmu-delphi/epidatpy/actions/workflows/create_release.yml) and click the `Run workflow` button. Enter the next version number or one of the magic keywords (patch, minor, major) and hit the green `Run workflow` button.
|
56 |
| -1. The action will prepare a new release and will end up with a new [Pull Request](https://github.com/cmu-delphi/epidatpy/pulls) |
57 |
| -1. Let the code owner review the PR and its changes and let the CI check whether everything builds successfully |
58 |
| -1. Once approved and merged, another GitHub action job starts which automatically will |
59 |
| - 1. create a git tag |
60 |
| - 1. create another [Pull Request](https://github.com/cmu-delphi/epidatpy/pulls) to merge the changes back to the `dev` branch |
61 |
| - 1. create a [GitHub release](https://github.com/cmu-delphi/epidatpy/releases) with automatically derived release notes |
62 |
| -1. Done |
| 46 | +2. The action will prepare a new release and will end up with a new [Pull Request](https://github.com/cmu-delphi/epidatpy/pulls) |
| 47 | +3. Let the code owner review the PR and its changes and let the CI check whether everything builds successfully |
| 48 | +4. Once approved and merged, another GitHub action job starts which automatically will |
| 49 | + 1. create a git tag |
| 50 | + 2. create another [Pull Request](https://github.com/cmu-delphi/epidatpy/pulls) to merge the changes back to the `dev` branch |
| 51 | + 3. create a [GitHub release](https://github.com/cmu-delphi/epidatpy/releases) with automatically derived release notes |
| 52 | +5. Done |
63 | 53 |
|
64 | 54 | [mit-image]: https://img.shields.io/badge/License-MIT-yellow.svg
|
65 | 55 | [mit-url]: https://opensource.org/licenses/MIT
|
|
0 commit comments