search

pytest-dev / pytest

The pytest framework makes it easy to write small tests, yet scales to support complex functional testing
https://pytest.org
MIT License
11.64k stars 2.59k forks source link

📝💅 Split trivial change log category into 3 #12501

Closed webknjaz closed 2 weeks ago

webknjaz commented 2 weeks ago

The new change note types are packaging, contrib and misc. packaging is intended for the audience of downstream redistributors. The contrib notes are meant to be documenting news affecting the project contributors, their development, and processes. Finally, misc is for things that don't fit anywhere but are still desired to be documented for some reason.

This patch additionally extends the change log title meanings, making them more verbose and clearer to the readers. Plus, it adds comment annotations in the Towncrier configuration.

webknjaz commented 2 weeks ago

FTR, some of the reasoning/justification is present in this external discussion: https://github.com/pypa/pip/issues/12555.

RonnyPfannschmidt commented 2 weeks ago

should this backport?

webknjaz commented 2 weeks ago

FYI the preview for this PR's change note is rendered @ https://pytest--12501.org.readthedocs.build/en/12501/changelog.html#contributor-facing-changes.

patchback[bot] commented 2 weeks ago

Backport to 8.2.x: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply b08b6d122fa82994b70f5dc1437c936d0e97ada7 on top of patchback/backports/8.2.x/b08b6d122fa82994b70f5dc1437c936d0e97ada7/pr-12501

Backporting merged PR #12501 into main

  1. Ensure you have a local repo clone of your fork. Unless you cloned it from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these instructions you'll refer to it by the name upstream. If you don't have it, here's how you can add it: 
    $ git remote add upstream https://github.com/pytest-dev/pytest.git
  3. Ensure you have the latest copy of upstream and prepare a branch that will hold the backported code: 
    $ git fetch upstream
$ git checkout -b patchback/backports/8.2.x/b08b6d122fa82994b70f5dc1437c936d0e97ada7/pr-12501 upstream/8.2.x
  4. Now, cherry-pick PR #12501 contents into that branch: 
    $ git cherry-pick -x b08b6d122fa82994b70f5dc1437c936d0e97ada7

    If it'll yell at you with something like fatal: Commit b08b6d122fa82994b70f5dc1437c936d0e97ada7 is a merge but no -m option was given., add -m 1 as follows instead:

    $ git cherry-pick -m1 -x b08b6d122fa82994b70f5dc1437c936d0e97ada7
  5. At this point, you'll probably encounter some merge conflicts. You must resolve them in to preserve the patch from PR #12501 as close to the original as possible.
  6. Push this branch to your fork on GitHub: 
    $ git push origin patchback/backports/8.2.x/b08b6d122fa82994b70f5dc1437c936d0e97ada7/pr-12501
  7. Create a PR, ensure that the CI is green. If it's not — update it so that the tests and any other checks pass. This is it! Now relax and wait for the maintainers to process your pull request when they have some cycles to do reviews. Don't worry — they'll tell you if any improvements are necessary when the time comes!

🤖 @patchback I'm built with octomachinery and my source is open — https://github.com/sanitizers/patchback-github-app.

webknjaz commented 2 weeks ago

Manual backport PR: #12506