|
40 | 40 | and development. If they are not updated, these environments will end |
41 | 41 | up with dependencies loaded from *pip* instead of *conda-forge*. |
42 | 42 |
|
43 | | -00. Run `black` to ensure that the codebase passes minimal style checks. |
| 43 | +00. Run black to ensure that the codebase passes all style checks. |
44 | 44 | This check should only take a few seconds. These checks are also done on |
45 | | - GitHub Actions and are platform independent, so they should not be necessary to |
| 45 | + Travis and are platform independent, so they should not be necessary to |
46 | 46 | replicate locally, but are listed here for completeness. |
47 | 47 | ```sh |
48 | 48 | black --check --diff . |
49 | 49 | ``` |
50 | 50 |
|
51 | | -00. Run the regular test suite on Windows. Most GitHub Actions tests are done on Linux, |
52 | | - Linux (it's faster to start up and run a new clean VM for testing) but most |
53 | | - users are on Windows, and the test suite should also be run on Windows to |
54 | | - ensure that it works on that platform as well. If you |
| 51 | +00. Run the regular test suite on Windows. Travis tests are done on Linux, |
| 52 | + but most users are on Windows, and the test suite should also be run |
| 53 | + on Windows to ensure that it works on that platform as well. If you |
55 | 54 | are not preparing this release on Windows, you should be sure to run |
56 | 55 | at least through this step on a Windows machine before finalizing a |
57 | 56 | release. |
|
67 | 66 | ``` |
68 | 67 |
|
69 | 68 | 00. Test the full-scale regional examples. These examples are big, too |
70 | | - large to run on GitHub Actions, and will take a lot of time (many hours) to |
| 69 | + large to run on Travis, and will take a lot of time (many hours) to |
71 | 70 | download and run. |
72 | 71 | ```sh |
73 | 72 | mkdir tmp-asim |
|
88 | 87 | There are also demo notebooks for estimation, but their functionality |
89 | 88 | is completely tested in the unit tests run previously. |
90 | 89 |
|
| 90 | +00. Use bump2version to tag the release commit and update the |
| 91 | + version number. The following code will generate a "patch" release, |
| 92 | + incrementing the third value in the version number (i.e. "1.2.3" |
| 93 | + becomes "1.2.4"). Alternatively, make a "minor" or "major" release. |
| 94 | + The `--list` command will generate output to your console to confirm |
| 95 | + that the old and new version numbers are what you expect, before you |
| 96 | + push the commit (with the changed version in the code) and tags to |
| 97 | + GitHub. |
| 98 | + ```sh |
| 99 | + bump2version patch --list |
| 100 | + ``` |
| 101 | +
|
| 102 | + It is also possible to make a development pre-release. To do so, |
| 103 | + explicitly set the version number to the next patch plus a ".devN" |
| 104 | + suffix: |
| 105 | +
|
| 106 | + ```sh |
| 107 | + bump2version patch --new-version 1.2.3.dev0 --list |
| 108 | + ``` |
| 109 | +
|
| 110 | + Then, when ready to make a "final" release, set the version by |
| 111 | + explicitly removing the suffix: |
| 112 | + ```sh |
| 113 | + bump2version patch --new-version 1.2.3 --list |
| 114 | + ``` |
| 115 | +
|
| 116 | +00. Push the tagged commit to GitHub. |
| 117 | + ```sh |
| 118 | + git push --tags |
| 119 | + ``` |
| 120 | +
|
91 | 121 | 00. For non-development releases, open a pull request to merge the proposed |
92 | 122 | release into main. The following command will open a web browser for |
93 | 123 | you to create the pull request. |
|
105 | 135 | ```sh |
106 | 136 | gh release create v1.2.3 |
107 | 137 | ``` |
108 | | - The process of creating and tagging a release will automatically |
109 | | - trigger various GitHub Actions scripts to build, test, and publish the |
110 | | - new release to PyPI and conda forge, assuming there are no errors. |
111 | | - |
112 | 138 | For a development pre-release, include the `--prerelease` argument. |
113 | 139 | As the project's policy is that only formally released code is merged |
114 | 140 | to the main branch, any pre-release should also be built against a |
|
129 | 155 | conda deactivate |
130 | 156 | conda env remove -n TEMP-ASIM-DEV |
131 | 157 | ``` |
132 | | -
|
133 | | -00. Change the default redirect page for the ActivitySim documentation to point |
134 | | - to the newly released documentation. The redirect page can be edited |
135 | | - [here](https://github.com/ActivitySim/activitysim/blob/gh-pages/index.html). |
136 | | -
|
137 | | -00. Add the new release to the `switch.json` file. Don't delete the references |
138 | | - for existing old documentation. The switcher can be edited |
139 | | - [here](https://github.com/ActivitySim/activitysim/blob/gh-pages/switcher.json). |
|
0 commit comments