Merge pull request #254 from joshuacortez/chore/release_v0.5.0

Chore/release v0.5.0

.gitignore

@@ -176,4 +176,7 @@ data/gridxy*.tif
 data/output_0.tif
 notebooks/data
 _proc/
-_docs/
+_docs/
+
+# pypi
+.pypirc

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Release Notes
 
+## 0.5.0
+
+### New Features
+
+- `FastSquareGridGenerator` as a faster equivalent to `SquareGridGenerator` (PR [#253](https://github.com/thinkingmachines/geowrangler/pull/253)) from [@joshuacortez](https://github.com/joshuacortez)
+  - Just like `FastBingTileGenerator`, this is also added in `00_grids.ipynb`.
+
+### Improvements
+- The `generate_grid` method in `SquareGridGenerator` and `FastSquareGridGenerator` shows a warning when the boundary of doesn't fully enclose the AOI. (issue [#147](https://github.com/thinkingmachines/geowrangler/issues/147))
+
 ## 0.4.0
 
 ### New Features

CONTRIBUTING.md

@@ -65,4 +65,10 @@ nbdev_export
   - In notebooks such as tutorial notebooks you may want to add a Google Colab link at the beginning of the notebook for easy accessibility.
   - There is no automatic way yet to update this so it's a manual update of a markdown cell. Since the link points to a notebook in master, testing the Colab button is done after merging. Follow the sample below and replace the notebook name with your contributed notebook name.
   - Sample for notebooks/14_datasets_nightlights.ipynb:
-[![](https://colab.research.google.com/assets/colab-badge.svg "Open in Colab button")](https://colab.research.google.com/github/thinkingmachines/geowrangler/blob/master/notebooks/14_datasets_nightlights.ipynb)
+[![](https://colab.research.google.com/assets/colab-badge.svg "Open in Colab button")](https://colab.research.google.com/github/thinkingmachines/geowrangler/blob/master/notebooks/14_datasets_nightlights.ipynb)
+
+## Updating GitHub pages doc site domain after PR is merged
+- After your PR is merged, go the repo site on GitHub -> `Settings` -> `Pages`
+- Update the Custom Domain to be geowrangler.thinkingmachin.es
+  - We need to update this after every PR merge because GitHub resets the custom domain to blank
+- If you don't have access to `Settings`, then feel free to reach out to the maintainers to update on your behalf.

RELEASE.md

@@ -2,7 +2,7 @@
 
 ## Bumping the version
 
-Run the following. Use `<part>` = 0, 1, 2 for major, minor or patch depending on the release. See https://nbdev.fast.ai/api/release.html#bump-version for more details
+Run the following. Use `<part>` = 0, 1, 2 for major, minor or patch depending on the release. For example if the version is 1.5.2 then the major version is 1, the minor version is 5, and the patch version is 2. See https://nbdev.fast.ai/api/release.html#bump-version for more details
 
 ```
 nbdev_bump_version --part <part>
@@ -33,6 +33,12 @@ The `<REPOSITORY>` value is either `pypi` or `testpypi`.
 ./scripts/publish2pypi.sh <REPOSITORY>
 ```
 
+## Updating release notes and tagging a release
+
+1. Document the release notes in `CHANGELOG.md`
+2. Run `nbdev_release_git` to create entries for the [release page](https://github.com/thinkingmachines/geowrangler/tags). 
+    - You'll need to create a GitHub personal access token for this if you haven't already. See the [nbdev.release docs](https://nbdev.fast.ai/api/release.html#overview), under the `Setup` section, for more details.
+
 ## Submitting
 
-Create a PR and tag it as the release version. The tag should be in the format `vX.Y.Z` where `X.Y.Z` is the major, minor and patch version numbers. 
+Create a PR and tag it as the release version. The tag should be in the format `vX.Y.Z` where `X`, `Y`, and `Z` are the major, minor and patch version numbers respectively. 

geowrangler/__init__.py

@@ -1 +1 @@
-__version__ = "0.4.0"
+__version__ = "0.5.0"

settings.ini

@@ -2,7 +2,7 @@
 host = github
 repo = geowrangler
 lib_name = geowrangler
-version = 0.4.0
+version = 0.5.0
 min_python = 3.8
 license = MIT
 black_formatting = True