Skip to content
This repository was archived by the owner on Dec 10, 2019. It is now read-only.

Commit e273d5e

Browse files
jisantucjisantuc
authored
Improve changelog processes (#69)
1 parent 00c411b commit e273d5e

File tree

4 files changed

+57
-55
lines changed

4 files changed

+57
-55
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Overview
2+
3+
Brief description of what this PR does, and why it is needed.
4+
5+
### Checklist
6+
7+
- [ ] Description of PR is in an appropriate section of the [changelog](https://github.com/raster-foundry/raster-foundry-python-client/blob/develop/CHANGELOG.rst) and grouped with similar changes if possible
8+
9+
### Demo
10+
11+
Optional. Screenshots, `curl` examples, etc.
12+
13+
### Notes
14+
15+
Optional. Ancillary topics, caveats, alternative strategies that didn't work out, anything else.
16+
17+
18+
## Testing Instructions
19+
20+
* How to test this PR
21+
* Prefer bulleted description
22+
* Start after checking out this branch
23+
* Include any setup required, such as bundling scripts, restarting services, etc.
24+
* Include test case, and expected output
25+
26+
Closes #XXX

‎CHANGELOG.rst

+30-21
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,31 @@
11
Change Log
22
==========
33

4+
`Unreleased <https://github.com/raster-foundry/raster-foundry/tree/develop>`__
5+
------------------------------------------------------------------------------
6+
7+
Added
8+
~~~~~
9+
10+
Changed
11+
~~~~~~~
12+
13+
- Switched to `keepachangelog <https://keepachangelog.com/en/1.0.0/>`__
14+
CHANGELOG format
15+
`#69 <https://github.com/raster-foundry/raster-foundry-api-spec/pull/69>`__
16+
17+
Deprecated
18+
~~~~~~~~~~
19+
20+
Removed
21+
~~~~~~~
22+
23+
Fixed
24+
~~~~~
25+
26+
Security
27+
~~~~~~~~
28+
429
`0.7.0 <https://github.com/raster-foundry/raster-foundry-python-client/tree/0.7.0>`__ (2018-09-27)
530
--------------------------------------------------------------------------------------------------
631

@@ -14,8 +39,6 @@ Changelog <https://github.com/raster-foundry/raster-foundry-python-client/compar
1439
- Point to permanent location by default for spec
1540
`#59 <https://github.com/raster-foundry/raster-foundry-python-client/pull/59>`__
1641

17-
.. _section-1:
18-
1942
`0.6.0 <https://github.com/raster-foundry/raster-foundry-python-client/tree/0.6.0>`__ (2018-05-14)
2043
--------------------------------------------------------------------------------------------------
2144

@@ -31,8 +54,6 @@ Changelog <https://github.com/raster-foundry/raster-foundry-python-client/compar
3154
- Updates for Raster Vision integration
3255
`#44 <https://github.com/raster-foundry/raster-foundry-python-client/pull/44>`__
3356

34-
.. _section-2:
35-
3657
`0.5.0 <https://github.com/raster-foundry/raster-foundry-python-client/tree/0.5.0>`__ (2018-01-26)
3758
--------------------------------------------------------------------------------------------------
3859

@@ -49,19 +70,17 @@ Changelog <https://github.com/raster-foundry/raster-foundry-python-client/compar
4970
`#38 <https://github.com/raster-foundry/raster-foundry-python-client/pull/38>`__
5071
- Add method to evaluate a raster-vision model
5172
`#36 <https://github.com/raster-foundry/raster-foundry-python-client/pull/36>`__
52-
- Add options to start_prep_train_data
73+
- Add options to start\_prep\_train\_data
5374
`#34 <https://github.com/raster-foundry/raster-foundry-python-client/pull/34>`__
5475
- Add Planet Upload Support
5576
`#33 <https://github.com/raster-foundry/raster-foundry-python-client/pull/33>`__
56-
- Add method to start prep_train_data job
77+
- Add method to start prep\_train\_data job
5778
`#32 <https://github.com/raster-foundry/raster-foundry-python-client/pull/32>`__
5879
- Start raster-vision predict job
5980
`#30 <https://github.com/raster-foundry/raster-foundry-python-client/pull/30>`__
6081
- Include missing install command in README
6182
`#28 <https://github.com/raster-foundry/raster-foundry-python-client/pull/28>`__
6283

63-
.. _section-3:
64-
6584
`0.4.1 <https://github.com/raster-foundry/raster-foundry-python-client/tree/0.4.1>`__ (2017-09-27)
6685
--------------------------------------------------------------------------------------------------
6786

@@ -75,8 +94,6 @@ Changelog <https://github.com/raster-foundry/raster-foundry-python-client/compar
7594
- Fix ipyleaflet install
7695
`#25 <https://github.com/raster-foundry/raster-foundry-python-client/pull/25>`__
7796

78-
.. _section-4:
79-
8097
`0.4.0 <https://github.com/raster-foundry/raster-foundry-python-client/tree/0.4.0>`__ (2017-09-07)
8198
--------------------------------------------------------------------------------------------------
8299

@@ -85,13 +102,12 @@ Changelog <https://github.com/raster-foundry/raster-foundry-python-client/compar
85102

86103
**Merged pull requests:**
87104

88-
- Add \*args and \**kwargs to no_op function in notebook support check
105+
- Add \*args and \*\*kwargs to no\_op function in notebook support
106+
check
89107
`#24 <https://github.com/raster-foundry/raster-foundry-python-client/pull/24>`__
90108
- Include Uploads example notebook
91109
`#23 <https://github.com/raster-foundry/raster-foundry-python-client/pull/23>`__
92110

93-
.. _section-5:
94-
95111
`0.3.0 <https://github.com/raster-foundry/raster-foundry-python-client/tree/0.3.0>`__ (2017-08-15)
96112
--------------------------------------------------------------------------------------------------
97113

@@ -103,8 +119,6 @@ Changelog <https://github.com/raster-foundry/raster-foundry-python-client/compar
103119
- Bump cryptography version to 2.x
104120
`#22 <https://github.com/raster-foundry/raster-foundry-python-client/pull/22>`__
105121

106-
.. _section-6:
107-
108122
`0.2.1 <https://github.com/raster-foundry/raster-foundry-python-client/tree/0.2.1>`__ (2017-08-10)
109123
--------------------------------------------------------------------------------------------------
110124

@@ -116,8 +130,6 @@ Changelog <https://github.com/raster-foundry/raster-foundry-python-client/compar
116130
- Correct repo references
117131
`#21 <https://github.com/raster-foundry/raster-foundry-python-client/pull/21>`__
118132

119-
.. _section-7:
120-
121133
`0.2.0 <https://github.com/raster-foundry/raster-foundry-python-client/tree/0.2.0>`__ (2017-08-10)
122134
--------------------------------------------------------------------------------------------------
123135

@@ -143,8 +155,6 @@ Changelog <https://github.com/raster-foundry/raster-foundry-python-client/compar
143155
- Add leaflet support to project model
144156
`#2 <https://github.com/raster-foundry/raster-foundry-python-client/pull/2>`__
145157

146-
.. _section-8:
147-
148158
`0.1.0 <https://github.com/raster-foundry/raster-foundry-python-client/tree/0.1.0>`__ (2017-05-04)
149159
--------------------------------------------------------------------------------------------------
150160

@@ -155,6 +165,5 @@ Changelog <https://github.com/raster-foundry/raster-foundry-python-client/compar
155165

156166
- Port Python client from main repository
157167
`#1 <https://github.com/raster-foundry/raster-foundry-python-client/pull/1>`__
158-
159168
- *This Change Log was automatically generated
160-
by*\ `github_changelog_generator <https://github.com/skywinder/Github-Changelog-Generator>`__
169+
by*\ `github\_changelog\_generator <https://github.com/skywinder/Github-Changelog-Generator>`__

‎MANIFEST.in

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ include spec.yml
22
include LICENSE.txt
33
include CHANGELOG.rst
44

5+
recursive-include .github *
56
recursive-include tests *
67
recursive-include examples *.ipynb
78
recursive-include scripts *

‎README.rst

-34
Original file line numberDiff line numberDiff line change
@@ -70,37 +70,3 @@ The test suite execution process is managed by ``tox``:
7070
.. code:: bash
7171
7272
$ tox
73-
74-
75-
Releases
76-
--------
77-
78-
Releases are automatically published to PyPI through Travis CI when commits are tagged. The following ``git flow`` commands lead to a tagged commit that can be pushed to GitHub:
79-
80-
81-
.. code:: bash
82-
83-
$ git flow release start X.Y.Z
84-
$ docker run -ti --rm -v "${PWD}:/changelog" -w "/changelog" "quay.io/azavea/github-changelog-generator:v1.14.3" \
85-
--token "${GITHUB_TOKEN}" \
86-
--future-release "X.Y.Z" \
87-
--no-issues \
88-
--no-author \
89-
--release-branch develop
90-
$ pandoc CHANGELOG.md -o CHANGELOG.rst
91-
$ rm CHANGELOG.md
92-
$ vim setup.py
93-
$ git commit -m "X.Y.Z"
94-
$ git flow release publish X.Y.Z
95-
$ git flow release finish X.Y.Z
96-
97-
98-
After you've completed the ``git flow`` steps above, you'll need to push the changes from your local repository to the GitHub repository:
99-
100-
.. code:: bash
101-
102-
$ git checkout develop
103-
$ git push origin develop
104-
$ git checkout master
105-
$ git push origin master
106-
$ git push --tags

0 commit comments

Comments
 (0)