Skip to content

Commit ecd4d1b

Browse files
authoredSep 8, 2023
Minor a posteriori fixes on recent PRs (#401)
* Clarify how to install warning * Rename xdem to geoutils * Replace master with main
1 parent f9ecbb7 commit ecd4d1b

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed
 

‎HOW_TO_RELEASE.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,16 @@ An automatic GitHub action will start to push and publish the new release to PyP
2222

2323
### The hard way
2424

25-
1. Go to your local main repository (not the fork) and ensure your master branch is synced:
26-
git checkout master
25+
1. Go to your local main repository (not the fork) and ensure your main branch is synced:
26+
git checkout main
2727
git pull
2828
2. Look over whats-new.rst and the docs. Make sure "What's New" is complete
2929
(check the date!) and add a brief summary note describing the release at the
3030
top.
3131
3. If you have any doubts, run the full test suite one final time!
3232
pytest --run-slow --mpl .
3333
4. Increment the version number "FULLVERSION" in setup.py for PyPI and conda.
34-
5. On the master branch, commit the release in git:
34+
5. On the main branch, commit the release in git:
3535
git commit -a -m 'Release v1.X.Y'
3636
6. Tag the release:
3737
git tag -a v1.X.Y -m 'v1.X.Y'
@@ -43,22 +43,22 @@ An automatic GitHub action will start to push and publish the new release to PyP
4343
twine upload dist/geoutils-1.X.Y*
4444
You will need to be listed as a package owner at
4545
https://pypi.python.org/pypi/geoutils for this to work.
46-
9. Push your changes to master:
47-
git push origin master
46+
9. Push your changes to main:
47+
git push origin main
4848
git push origin --tags
49-
10. Update the stable branch (used by ReadTheDocs) and switch back to master:
49+
10. Update the stable branch (used by ReadTheDocs) and switch back to main:
5050
git checkout stable
51-
git rebase master
51+
git rebase main
5252
git push origin stable
53-
git checkout master
53+
git checkout main
5454
It's OK to force push to 'stable' if necessary.
5555
We also update the stable branch with `git cherrypick` for documentation
5656
only fixes that apply the current released version.
5757
11. Add a section for the next release (v.X.(Y+1)) to doc/whats-new.rst.
58-
12. Commit your changes and push to master again:
58+
12. Commit your changes and push to main again:
5959
git commit -a -m 'Revert to dev version'
60-
git push origin master
61-
You're done pushing to master!
60+
git push origin main
61+
You're done pushing to main!
6262
13. Issue the release on GitHub. Click on "Draft a new release" at
6363
https://github.com/geoutils/geoutils/releases. Type in the version number, but
6464
don't bother to describe it -- we maintain that on the docs instead.
@@ -106,7 +106,7 @@ Then, follow these steps for `NEW_VERSION` (substitute with the actual version n
106106

107107
>>> git add -u && git commit -m "Updated version to NEW_VERSION" # Or whatever you want to tell us :)
108108

109-
>>> git push -u origin master
109+
>>> git push -u origin main
110110
```
111111

112112
An alternative solution to get the sha256sum is to run `sha256sum` on the release file downloaded from GitHub

‎doc/source/how_to_install.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ pip install geoutils
2323
```
2424

2525
```{warning}
26-
Updating packages with `pip` (and sometimes `mamba`) can break your installation. If this happens, re-create an environment from scratch fixing directly all your dependencies.
26+
Updating packages with `pip` (and sometimes `mamba`) can break your installation. If this happens, re-create an environment from scratch pinning directly all your other dependencies during initial solve (e.g., `mamba create -n geoutils-env -c conda-forge geoutils myotherpackage==1.0.0`).
2727
```
2828

2929
## Installing for contributors

0 commit comments

Comments
 (0)
Please sign in to comment.