Skip to content

Update instructions for releasing and migrate changelog - #407

Merged
sdb9696 merged 1 commit into
python-ring-doorbell:masterfrom
sdb9696:janitor/update_releasing
Aug 21, 2024
Merged

Update instructions for releasing and migrate changelog#407
sdb9696 merged 1 commit into
python-ring-doorbell:masterfrom
sdb9696:janitor/update_releasing

Conversation

@sdb9696

@sdb9696 sdb9696 commented Aug 21, 2024

Copy link
Copy Markdown
Member

sphinx-github-changelog was failing silently and is probably a bit too flaky as a result. This PR migrates to a local generator that creates a changelog in source control and supports markdown in the docs to include the generated changelog.

  • Migrate from sphinx-github-changelog to github_changelog_generator.
  • Add myst-parser for markdown support in docs.
  • Update release instructions with more detail and new changelog process.

@coveralls

Copy link
Copy Markdown

Coverage Status

coverage: 77.812%. remained the same
when pulling 041d150 on sdb9696:janitor/update_releasing
into 46a306a on tchellomello:master.

@sdb9696
sdb9696 merged commit 9a9221d into python-ring-doorbell:master Aug 21, 2024
@sdb9696
sdb9696 deleted the janitor/update_releasing branch August 21, 2024 11:14
@sdb9696 sdb9696 added this to the 0.9.0 milestone Aug 21, 2024
@sdb9696 sdb9696 added the maintenance Project improvements and maintenance label Aug 21, 2024
@sdb9696 sdb9696 mentioned this pull request Aug 21, 2024
sdb9696 added a commit that referenced this pull request Aug 21, 2024
## [0.9.0](https://github.com/tchellomello/python-ring-doorbell/tree/0.9.0) (2024-08-21)

[Full Changelog](0.8.12...0.9.0)

**Release highlights:**

- Async support for the library
- Removed python 3.8 support

**Breaking changes:**

- Synchronous api calls are now deprecated.  For example calling `Ring.update_data()` will emit a deprecation warning to use `await Ring.async_update_data()` which should be run within an event loop via `asyncio.run()`.  See `test.py` for an example.
- Calling the deprecated sync api methods from inside a running event loop is not supported.  This is unlikely to affect many consumers as the norm if running in an event loop is to make synchronous api calls from an executor thread.
- Python 3.8 is no longer officially supported and could break in future releases.

**Breaking change pull requests:**

- Drop python3.8 support and enable python3.13 in the CI [\#398](#398) (@sdb9696)

**Implemented enhancements:**

- Make library fully async [\#361](#361) (@sdb9696)

**Fixed bugs:**

- Small change to modify the timestamp [\#378](#378) (@AndrewMohawk)

**Project maintenance:**

- Update instructions for releasing and migrate changelog [\#407](#407) (@sdb9696)
- Add .vscode folder to gitignore [\#397](#397) (@sdb9696)
- Update dependencies [\#396](#396) (@sdb9696)
- Reduce lock and stale workflow frequency [\#388](#388) (@sdb9696)
@github-actions github-actions Bot locked and limited conversation to collaborators Aug 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

maintenance Project improvements and maintenance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants