Skip to content

Commit

Permalink
release v0.7
Browse files Browse the repository at this point in the history
  • Loading branch information
snarfed committed Jun 24, 2024
1 parent de055d7 commit a072427
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 23 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,34 +147,34 @@ Here's how to package, test, and ship a new release.

```sh
source local/bin/activate.csh
python3 -m unittest discover
python -m unittest discover
```
1. Bump the version number in `pyproject.toml` and `docs/conf.py`. `git grep` the old version number to make sure it only appears in the changelog. Change the current changelog entry in `README.md` for this new version from _unreleased_ to the current date.
1. Build the docs. If you added any new modules, add them to the appropriate file(s) in `docs/source/`. Then run `./docs/build.sh`. Check that the generated HTML looks fine by opening `docs/_build/html/index.html` and looking around.
1. `git commit -am 'release vX.Y'`
1. Upload to [test.pypi.org](https://test.pypi.org/) for testing.

```sh
python3 -m build
python -m build
setenv ver X.Y
twine upload -r pypitest dist/lexrpc-$ver*
```
1. Install from test.pypi.org.

```sh
cd /tmp
python3 -m venv local
python -m venv local
source local/bin/activate.csh
pip3 uninstall lexrpc # make sure we force pip to use the uploaded version
pip3 install --upgrade pip
pip3 install -i https://test.pypi.org/simple --extra-index-url https://pypi.org/simple lexrpc==$ver
pip uninstall lexrpc # make sure we force pip to use the uploaded version
pip install --upgrade pip
pip install -i https://test.pypi.org/simple --extra-index-url https://pypi.org/simple lexrpc==$ver
deactivate
```
1. Smoke test that the code trivially loads and runs.

```sh
source local/bin/activate.csh
python3
python
# run test code below
deactivate
```
Expand Down Expand Up @@ -227,7 +227,7 @@ Here's how to package, test, and ship a new release.
## Changelog
### 0.7 - unreleased
### 0.7 - 2024-06-24
* Fix websocket subscription server hang with blocking server XRPC methods due to exhausting worker thread pool ([#8](https://github.com/snarfed/lexrpc/issues/8)).
* Add `truncate` kwarg to `Client` and `Server` constructors to automatically truncate (ellipsize) string values that are longer than their ``maxGraphemes`` or ``maxLength`` in their lexicon. Defaults to `False`.
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,9 @@
# built documents.
#
# The short X.Y version.
version = '0.6'
version = '0.7'
# The full version, including alpha/beta/rc tags.
release = '0.6'
release = '0.7'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
56 changes: 44 additions & 12 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ Here’s how to package, test, and ship a new release.
.. code:: sh
source local/bin/activate.csh
python3 -m unittest discover
python -m unittest discover
2. Bump the version number in ``pyproject.toml`` and ``docs/conf.py``.
``git grep`` the old version number to make sure it only appears in
Expand All @@ -219,7 +219,7 @@ Here’s how to package, test, and ship a new release.

.. code:: sh
python3 -m build
python -m build
setenv ver X.Y
twine upload -r pypitest dist/lexrpc-$ver*
Expand All @@ -228,19 +228,19 @@ Here’s how to package, test, and ship a new release.
.. code:: sh
cd /tmp
python3 -m venv local
python -m venv local
source local/bin/activate.csh
pip3 uninstall lexrpc # make sure we force pip to use the uploaded version
pip3 install --upgrade pip
pip3 install -i https://test.pypi.org/simple --extra-index-url https://pypi.org/simple lexrpc==$ver
pip uninstall lexrpc # make sure we force pip to use the uploaded version
pip install --upgrade pip
pip install -i https://test.pypi.org/simple --extra-index-url https://pypi.org/simple lexrpc==$ver
deactivate
7. Smoke test that the code trivially loads and runs.

.. code:: sh
source local/bin/activate.csh
python3
python
# run test code below
deactivate
Expand Down Expand Up @@ -311,6 +311,38 @@ Here’s how to package, test, and ship a new release.
Changelog
---------

0.7 - 2024-06-24
~~~~~~~~~~~~~~~~

- Fix websocket subscription server hang with blocking server XRPC
methods due to exhausting worker thread pool
(`#8 <https://github.com/snarfed/lexrpc/issues/8>`__).
- Add ``truncate`` kwarg to ``Client`` and ``Server`` constructors to
automatically truncate (ellipsize) string values that are longer than
their ``maxGraphemes`` or ``maxLength`` in their lexicon. Defaults to
``False``.
- Add new ``base.XrpcError`` exception type for named errors in method
definitions.
- ``flask_server``:

- Handle ``base.XrpcError``, convert to `JSON error
response <https://atproto.com/specs/xrpc#error-responses>`__ with
``error`` and ``message`` fields.

- ``Client``:

- Bug fix for calls with binary inputs that refresh the access
token. Calls with binary input now buffer the entire input in
memory.
(`snarfed/bridgy#1670 <https://github.com/snarfed/bridgy/issues/1670>`__)
- Bug fix: omit null (``None``) parameters instead of passing them
with string value ``None``.

- Update bundled ``app.bsky`` and ``com.atproto`` lexicons, as of
`bluesky-social/atproto@15cc6ff37c326d5c186385037c4bfe8b60ea41b1 <https://github.com/bluesky-social/atproto/commit/15cc6ff37c326d5c186385037c4bfe8b60ea41b1>`__.

.. _section-1:

0.6 - 2024-03-16
~~~~~~~~~~~~~~~~

Expand All @@ -320,7 +352,7 @@ Changelog
- Update bundled ``app.bsky`` and ``com.atproto`` lexicons, as of
`bluesky-social/atproto@f45eef3 <https://github.com/bluesky-social/atproto/commit/f45eef3414f8827ba3a6958a7040c7e38bfd6282>`__.

.. _section-1:
.. _section-2:

0.5 - 2023-12-10
~~~~~~~~~~~~~~~~
Expand All @@ -335,7 +367,7 @@ Changelog
- Bug fix: don’t infinite loop if ``refreshSession`` fails.
- Other minor authentication bug fixes.

.. _section-2:
.. _section-3:

0.4 - 2023-10-28
~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -376,7 +408,7 @@ Changelog
- Add the ``error`` field to the JSON response bodies for most error
responses.

.. _section-3:
.. _section-4:

0.3 - 2023-08-29
~~~~~~~~~~~~~~~~
Expand All @@ -388,7 +420,7 @@ Changelog
- Add new ``Server.register`` method for manually registering handlers.
- Bug fix for server ``@method`` decorator.

.. _section-4:
.. _section-5:

0.2 - 2023-03-13
~~~~~~~~~~~~~~~~
Expand All @@ -405,7 +437,7 @@ put more effort into matching and fully implementing them. Stay tuned!
format <https://github.com/snarfed/atproto/commit/63b9873bb1699b6bce54e7a8d3db2fcbd2cfc5ab>`__.
Original format is no longer supported.

.. _section-5:
.. _section-6:

0.1 - 2022-12-13
~~~~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ where = ['.']

[project]
name = 'lexrpc'
version = '0.6'
version = '0.7'
authors = [
{ name='Ryan Barrett', email='lexrpc@ryanb.org' },
]
Expand Down

0 comments on commit a072427

Please sign in to comment.