FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

📝💅 Split trivial change log category into 3 by webknjaz · Pull Request #12501 · pytest-dev/pytest · GitHub

/ pytest Public

📝💅 Split trivial change log category into 3 - #12501

Merged
RonnyPfannschmidt merged 5 commits into
pytest-dev:mainfrom
webknjaz:maintenance/changelog-categories
Jun 21, 2024
ConversationCommits (5)ChecksFiles changed
Merged

📝💅 Split trivial change log category into 3#12501
RonnyPfannschmidt merged 5 commits into
pytest-dev:mainfrom
webknjaz:maintenance/changelog-categories

Conversation

webknjaz commented Jun 20, 2024

Copy link
Copy Markdown
Member

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 added a commit to webknjaz/pytest that referenced this pull request Jun 20, 2024
📝 Add a change note for PR pytest-dev#12501
a506c06
webknjaz force-pushed the maintenance/changelog-categories branch from 6955ad6 to a506c06 Compare June 20, 2024 18:06
psf-chronographer Bot added the bot:chronographer:provided (automation) changelog entry is part of PR label Jun 20, 2024
webknjaz marked this pull request as ready for review June 20, 2024 18:08

webknjaz commented Jun 20, 2024

Copy link
Copy Markdown
Member Author

FTR, some of the reasoning/justification is present in this external discussion: pypa/pip#12555.

webknjaz added a commit to webknjaz/pytest that referenced this pull request Jun 20, 2024
📝 Add a change note for PR pytest-dev#12501
94d3289
webknjaz force-pushed the maintenance/changelog-categories branch from a506c06 to 94d3289 Compare June 20, 2024 20:00

RonnyPfannschmidt commented Jun 21, 2024

Copy link
Copy Markdown
Member

should this backport?

RonnyPfannschmidt requested changes Jun 21, 2024
View reviewed changes
Comment thread .pre-commit-config.yaml Outdated
RonnyPfannschmidt mentioned this pull request Jun 21, 2024
Merged
4 tasks
webknjaz added 2 commits June 21, 2024 13:34
📝 Add comments to change note categories
0cf92cf
📝 Extend change log title meanings
45a89ec 
This patch makes them more verbose so that they are clearer to the
readers.
webknjaz added a commit to webknjaz/pytest that referenced this pull request Jun 21, 2024
📝 Add a change note for PR pytest-dev#12501
36fda08
webknjaz force-pushed the maintenance/changelog-categories branch from 94d3289 to bea6522 Compare June 21, 2024 11:34
webknjaz added 3 commits June 21, 2024 13:35
📝💅 Split trivial change log category into 3
03be1ed 
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.
🎨 Set up Git to only allow certain change notes
3ce1d65
📝 Add a change note for PR pytest-dev#12501
e73db68
webknjaz force-pushed the maintenance/changelog-categories branch from bea6522 to e73db68 Compare June 21, 2024 11:35
RonnyPfannschmidt approved these changes Jun 21, 2024
View reviewed changes

RonnyPfannschmidt left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

❤️

webknjaz commented Jun 21, 2024

Copy link
Copy Markdown
Member Author

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

RonnyPfannschmidt merged commit b08b6d1 into pytest-dev:main Jun 21, 2024

patchback Bot commented Jun 21, 2024 •
edited
Loading

Copy link
Copy Markdown

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

❌ Failed to cleanly apply b08b6d1 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 📝💅 Split trivial change log category into 3 #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 📝💅 Split trivial change log category into 3 #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 pushed a commit to webknjaz/pytest that referenced this pull request Jun 21, 2024
Merge pull request pytest-dev#12501 from webknjaz/maintenance/changel…
277951f 
…og-categories

📝💅 Split trivial change log category into 3

(cherry picked from commit b08b6d1)
webknjaz mentioned this pull request Jun 21, 2024
Merged

webknjaz commented Jun 21, 2024

Copy link
Copy Markdown
Member Author

Manual backport PR: #12506

RonnyPfannschmidt added a commit that referenced this pull request Jun 21, 2024
Merge pull request #12506 from webknjaz/backports/8.2.x/b08b6d1/pr-12501
780d0c1 
[PR #12501/b08b6d1 backport][8.2.x] 📝💅 Split trivial change log category into 3
webknjaz added the type: infrastructure improvement to development/releases/CI structure label Jun 26, 2024
Glyphack pushed a commit to Glyphack/pytest that referenced this pull request Jul 30, 2024
📝 Add a change note for PR pytest-dev#12501
9a77d47
Liam-DeVoe mentioned this pull request Oct 23, 2025
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

RonnyPfannschmidt RonnyPfannschmidt approved these changes

Assignees

No one assigned

Labels

bot:chronographer:provided (automation) changelog entry is part of PR type: infrastructure improvement to development/releases/CI structure

Projects

pytest sprint 2024
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

Back | FazBrowse Home | New Git URL