Skip to content

Commit

Permalink
Changelog update + v1.0.0 release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
mattheworiordan committed Mar 7, 2017
1 parent a69d54c commit e6f3eb7
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 11 deletions.
26 changes: 25 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,30 @@
# Change Log

## [v0.8.2](https://github.com/ably/ably-python/tree/v0.8.2)
## [v1.0.0](https://github.com/ably/ably-python/tree/v1.0.0)

[Full Changelog](https://github.com/ably/ably-python/compare/v0.8.2...v1.0.0)

### v1.0 release and upgrade notes from v0.8

- See https://github.com/ably/docs/issues/235

**Implemented enhancements:**

- RSC19\*, HP\* - New REST \#request method + HttpPaginatedResponse type [\#78](https://github.com/ably/ably-python/issues/78)
- Update REST library for realtime platform to v1.0 specification [\#77](https://github.com/ably/ably-python/issues/77)

**Closed issues:**

- requests version pin too strict? [\#66](https://github.com/ably/ably-python/issues/66)

**Merged pull requests:**

- Issue\#84 TP4, RSC15a \(test\), RSC19e \(test\), .. [\#87](https://github.com/ably/ably-python/pull/87) ([jdavid](https://github.com/jdavid))
- Fix issue 72 [\#85](https://github.com/ably/ably-python/pull/85) ([jdavid](https://github.com/jdavid))
- Fix README, now using pytest instead of nose [\#83](https://github.com/ably/ably-python/pull/83) ([jdavid](https://github.com/jdavid))
- RSA5, RSA6, RSA10, RSL\*, TM\*, TE6, TD7 [\#82](https://github.com/ably/ably-python/pull/82) ([jdavid](https://github.com/jdavid))

## [v0.8.2](https://github.com/ably/ably-python/tree/v0.8.2) (2017-02-17)
[Full Changelog](https://github.com/ably/ably-python/compare/v0.8.1...v0.8.2)

**Implemented enhancements:**
Expand All @@ -20,6 +43,7 @@
**Merged pull requests:**

- RSC7, RSC11, RSC15, RSC19 [\#81](https://github.com/ably/ably-python/pull/81) ([jdavid](https://github.com/jdavid))
- Several python code repo improvements [\#73](https://github.com/ably/ably-python/pull/73) ([txomon](https://github.com/txomon))
- updated reqests version in requirements [\#67](https://github.com/ably/ably-python/pull/67) ([essweine](https://github.com/essweine))

## [v0.8.1](https://github.com/ably/ably-python/tree/v0.8.1) (2016-03-22)
Expand Down
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,6 @@ The client library is available as a [PyPI package](https://pypi.python.org/pypi
cd ably-python
python setup.py install

#### To run the tests after local install

git submodule init
git submodule update
pip install -r requirements-test.txt
pytest test

## Using the REST API

All examples assume a client and/or channel has been created as follows:
Expand Down Expand Up @@ -139,6 +132,15 @@ You can also view the [community reported Github issues](https://github.com/ably

To see what has changed in recent versions of Bundler, see the [CHANGELOG](CHANGELOG.md).

## Running the test suite

```python
git submodule init
git submodule update
pip install -r requirements-test.txt
pytest test
```

## Contributing

1. Fork it
Expand All @@ -152,9 +154,9 @@ To see what has changed in recent versions of Bundler, see the [CHANGELOG](CHANG

1. Update [`setup.py`](./setup.py) with the new version number
2. Run `python setup.py sdist upload -r pypi` to build and upload this new package to PyPi
3. Run [`github_changelog_generator`](https://github.com/skywinder/Github-Changelog-Generator) to automate the update of the [CHANGELOG](./CHANGELOG.md). Once the CHANGELOG has completed, manually change the `Unreleased` heading and link with the current version number such as `v0.8.2`. Also ensure that the `Full Changelog` link points to the new version tag instead of the `HEAD`. Commit this change.
4. Tag the new version such as `git tag v0.8.2`
5. Push the tag to origin `git push origin v0.8.2`
3. Run [`github_changelog_generator`](https://github.com/skywinder/Github-Changelog-Generator) to automate the update of the [CHANGELOG](./CHANGELOG.md). Once the CHANGELOG has completed, manually change the `Unreleased` heading and link with the current version number such as `v1.0.0`. Also ensure that the `Full Changelog` link points to the new version tag instead of the `HEAD`. Commit this change.
4. Tag the new version such as `git tag v1.0.0`
5. Push the tag to origin `git push origin v1.0.0`

## License

Expand Down

0 comments on commit e6f3eb7

Please sign in to comment.