Skip to content

Integrate Towncrier configuration #823

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 8 commits into from
Nov 29, 2021
Merged

Integrate Towncrier configuration #823

merged 8 commits into from
Nov 29, 2021

Conversation

webknjaz
Copy link
Contributor

No description provided.

webknjaz added a commit to webknjaz/proxy.py that referenced this pull request Nov 29, 2021
@webknjaz
Add a change note for PR abhinavsingh#823
54bfc29
@webknjaz webknjaz force-pushed the maintenance/towncrier branch from 9b2af8c to 54bfc29 Compare November 29, 2021 03:01
@webknjaz
Copy link
Contributor Author

@abhinavsingh this adds the basic infrastructure for the changelog management. To use it, currently, you have to manually run tox -e make-changelog -- <your desired version> and then commit and push the changes (which will git rm the fragments and render them in CHANGELOG.md).
You can also preview a draft (printed out in the console output) if you skip the arguments, to do this, just run tox -e make-changelog.

webknjaz
webknjaz commented Nov 29, 2021
View reviewed changes
.github/chronographer.yml
@@ -0,0 +1,11 @@
---
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add https://github.com/apps/psf-chronographer to make use of this config. It's a simple check for whether the PR authors didn't forget to add a change note. The config is currently set up to ignore PRs from known bots.

webknjaz added a commit to webknjaz/proxy.py that referenced this pull request Nov 29, 2021
@webknjaz
Add a change note for PR abhinavsingh#823
dfda600
@webknjaz webknjaz force-pushed the maintenance/towncrier branch from 54bfc29 to dfda600 Compare November 29, 2021 03:06
webknjaz
webknjaz commented Nov 29, 2021
View reviewed changes
webknjaz
webknjaz commented Nov 29, 2021
View reviewed changes
webknjaz
webknjaz commented Nov 29, 2021
View reviewed changes
docs/changelog-fragments.d/README.md
@@ -0,0 +1,76 @@
# Adding change notes with your PRs
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This document shows up on GitHub when somebody navigates to the change notes directory: https://github.com/webknjaz/proxy.py/blob/maintenance/towncrier/docs/changelog-fragments.d/.
You can point the PR authors here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's also included in the Sphinx docs.

webknjaz
webknjaz commented Nov 29, 2021
View reviewed changes
pyproject.toml
Comment on lines +24 to +60
[[tool.towncrier.section]]
path = ""

[[tool.towncrier.type]]
directory = "bugfix"
name = "Bugfixes"
showcontent = true

[[tool.towncrier.type]]
directory = "feature"
name = "Features"
showcontent = true

[[tool.towncrier.type]]
directory = "deprecation"
name = "Deprecations (removal in next major release)"
showcontent = true

[[tool.towncrier.type]]
directory = "breaking"
name = "Backward incompatible changes"
showcontent = true

[[tool.towncrier.type]]
directory = "doc"
name = "Documentation"
showcontent = true

[[tool.towncrier.type]]
directory = "misc"
name = "Miscellaneous"
showcontent = true

[[tool.towncrier.type]]
directory = "internal"
name = "Contributor-facing changes"
showcontent = true
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are the categories for possible changelog subsections. The fragment files should be named <issue/pr number>.<category from this list>.rst for Towncrier to properly work with it. If you want a note under several categories, make a symlink with an additional name.

webknjaz added a commit to webknjaz/proxy.py that referenced this pull request Nov 29, 2021
@webknjaz
Add a change note for PR abhinavsingh#823
e0321c9
@webknjaz webknjaz force-pushed the maintenance/towncrier branch from d13e342 to e0321c9 Compare November 29, 2021 03:30
webknjaz added a commit to webknjaz/proxy.py that referenced this pull request Nov 29, 2021
@webknjaz
Add a change note for PR abhinavsingh#823
4f44119
@webknjaz webknjaz force-pushed the maintenance/towncrier branch from e0321c9 to 4f44119 Compare November 29, 2021 09:46
@webknjaz webknjaz force-pushed the maintenance/towncrier branch from 4f44119 to 4f8503e Compare November 29, 2021 12:47
@webknjaz
Copy link
Contributor Author

@abhinavsingh I think I've fixed all the spelling offenses and this should be good to go now.

abhinavsingh
abhinavsingh reviewed Nov 29, 2021
View reviewed changes
.github/chronographer.yml
- dependabot
- patchback
humans:
- pyup-bot
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

jFYI, I have removed all pyup integrations.

abhinavsingh
abhinavsingh reviewed Nov 29, 2021
View reviewed changes
@abhinavsingh abhinavsingh merged commit 6aee778 into abhinavsingh:develop Nov 29, 2021
abhinavsingh added a commit that referenced this pull request Dec 1, 2021
@abhinavsingh @dependabot
@pre-commit-ci @webknjaz
v2.4.0rc2 (#838)
e473eb1 
* Merge pull request #825 from abhinavsingh/dependabot/pip/pylint-2.12.1

pip prod(deps): bump pylint from 2.11.1 to 2.12.1

* Bump ncipollo/release-action from 1.8.10 to 1.9.0 (#826)

Bumps [ncipollo/release-action](https://github.com/ncipollo/release-action) from 1.8.10 to 1.9.0.
- [Release notes](https://github.com/ncipollo/release-action/releases)
- [Commits](ncipollo/release-action@v1.8.10...v1.9.0)

---
updated-dependencies:
- dependency-name: ncipollo/release-action
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Abhinav Singh <[email protected]>

* npm: bump rollup-plugin-copy from 3.3.0 to 3.4.0 in /dashboard (#824)

Bumps [rollup-plugin-copy](https://github.com/vladshcherbin/rollup-plugin-copy) from 3.3.0 to 3.4.0.
- [Release notes](https://github.com/vladshcherbin/rollup-plugin-copy/releases)
- [Commits](vladshcherbin/rollup-plugin-copy@3.3.0...3.4.0)

---
updated-dependencies:
- dependency-name: rollup-plugin-copy
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Abhinav Singh <[email protected]>

* Add benchmarks comparison for `proxy.py`, `tornado`, `aiohttp`, `flask` (#827)

* Add benchmarks for `proxy.py`, `tornado`, `aiohttp`, `flask`

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Lint happy

* Disable W0223 for tornado

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Integrate Towncrier configuration (#823)

* Move changelog out of README into a separate file

* Expose the changelog to Sphinx

* Integrate Towncrier configuration into the repo

* Include the change fragment docs in Sphinx

* Add a config for the Chronographer GitHub App

* Add a change note for PR #823

* Update CHANGELOG.md

Co-authored-by: Abhinav Singh <[email protected]>

* Add `benchmark` results to `README.md` (#828)

* Add benchmark results to top-level README

* mypy

* Push down WIP example

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Spelling

* Link rtfd within `Internal Documentation` for now

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* pip prod(deps): bump types-paramiko from 2.8.1 to 2.8.2 (#831)

Bumps [types-paramiko](https://github.com/python/typeshed) from 2.8.1 to 2.8.2.
- [Release notes](https://github.com/python/typeshed/releases)
- [Commits](https://github.com/python/typeshed/commits)

---
updated-dependencies:
- dependency-name: types-paramiko
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* npm: bump js-cookie from 2.2.1 to 3.0.1 in /dashboard (#830)

Bumps [js-cookie](https://github.com/js-cookie/js-cookie) from 2.2.1 to 3.0.1.
- [Release notes](https://github.com/js-cookie/js-cookie/releases)
- [Changelog](https://github.com/js-cookie/js-cookie/blob/master/.release-it.json)
- [Commits](js-cookie/js-cookie@v2.2.1...v3.0.1)

---
updated-dependencies:
- dependency-name: js-cookie
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Abhinav Singh <[email protected]>

* Optimizations & Update Benchmark Results (#832)

* Bail out of lock earlier

* Avoid calling `get_events` for unfinished work tasks.  Use `cached_property` for `HttpParser` optimization

* Add `type: ignore[no-any-return]`, odd scenario

* We dont have to rebuild response packet repeatedly within `WebServerPlugin`

* Parse line and header in one invocation

* Minor optimizations and update benchmark to use `oha` instead of `hey`

* Remove `flask` from benchmark, only benchmark `asgi` or `async` based libraries.  Use `uvicorn` and 10 workers for `blacksheep`.  Use `oha` instead of `hey`

* Add benchmark for `starlette`

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Add missing dep

* pre-commit

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* [ProxyPoolPlugin] Avoid remote proxy of private IP requests (#833)

* Avoid proxy of requests to private IP within `ProxyPoolPlugin`

* Fix tests

* spell fix

* No content length or chunked case can occur with `HTTP/1.1` too (#834)

* No content length or chunked case can occur with `HTTP/1.1` too

* `WPS331` false-positive

* npm: bump eslint-plugin-standard from 4.1.0 to 5.0.0 in /dashboard (#835)

Bumps [eslint-plugin-standard](https://github.com/standard/eslint-plugin-standard) from 4.1.0 to 5.0.0.
- [Release notes](https://github.com/standard/eslint-plugin-standard/releases)
- [Commits](standard/eslint-plugin-standard@v4.1.0...v5.0.0)

---
updated-dependencies:
- dependency-name: eslint-plugin-standard
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* pip prod(deps): bump twine from 3.5.0 to 3.6.0 (#836)

Bumps [twine](https://github.com/pypa/twine) from 3.5.0 to 3.6.0.
- [Release notes](https://github.com/pypa/twine/releases)
- [Changelog](https://github.com/pypa/twine/blob/main/docs/changelog.rst)
- [Commits](pypa/twine@3.5.0...3.6.0)

---
updated-dependencies:
- dependency-name: twine
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* `task.result` can throw (#837)

* `task.result` can raise exception

* Remove redundant `except`

* Fix doc spell.  We need to fix it well, currently strategy feels dumb and PITA

* Move common words within `spelling_wordlist.txt`

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Sviatoslav Sydorenko <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@abhinavsingh abhinavsingh abhinavsingh left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@webknjaz @abhinavsingh