Skip to content
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.

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

Stop including the changelog on PyPI #6156

Merged
merged 2 commits into from
Oct 28, 2021
Merged

Conversation

webknjaz
Copy link
Member

What do these changes do?

$sbj

Are there changes in behavior for the user?

They'll have to check out the change log in the docs.

Related issue number

#6153

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> for example (588.bugfix)
    • if you don't have an issue_id change it to the pr id after creating the pr
    • ensure type is one of the following:
      • .feature: Signifying a new feature.
      • .bugfix: Signifying a bug fix.
      • .doc: Signifying a documentation improvement.
      • .removal: Signifying a deprecation or removal of public API.
      • .misc: A ticket has been closed, but it is not of interest to users.
    • Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Oct 28, 2021
@webknjaz webknjaz merged commit eb5f740 into master Oct 28, 2021
@webknjaz webknjaz deleted the maintenance/no-changelog-on-pypi branch October 28, 2021 17:02
@patchback
Copy link
Contributor

patchback bot commented Oct 28, 2021

Backport to 3.8: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply eb5f740 on top of patchback/backports/3.8/eb5f74038f51cacbac02b4883fe046418e5ad40b/pr-6156

Backporting merged PR #6156 into master

  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/aio-libs/aiohttp.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/3.8/eb5f74038f51cacbac02b4883fe046418e5ad40b/pr-6156 upstream/3.8
  4. Now, cherry-pick PR Stop including the changelog on PyPI #6156 contents into that branch:
    $ git cherry-pick -x eb5f74038f51cacbac02b4883fe046418e5ad40b
    If it'll yell at you with something like fatal: Commit eb5f74038f51cacbac02b4883fe046418e5ad40b is a merge but no -m option was given., add -m 1 as follows intead:
    $ git cherry-pick -m1 -x eb5f74038f51cacbac02b4883fe046418e5ad40b
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Stop including the changelog on PyPI #6156 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.8/eb5f74038f51cacbac02b4883fe046418e5ad40b/pr-6156
  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.

@aio-libs-github-bot
Copy link
Contributor

💔 Backport was not successful

The PR was attempted backported to the following branches:

  • ❌ 3.8: Commit could not be cherrypicked due to conflicts

webknjaz added a commit that referenced this pull request Oct 28, 2021
* Stop including the changelog on PyPI

* Add a change note for PR #6156

(cherry picked from commit eb5f740)
webknjaz added a commit that referenced this pull request Oct 28, 2021
#6158)

* Stop including the changelog on PyPI

* Add a change note for PR #6156

(cherry picked from commit eb5f740)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot:chronographer:provided There is a change note present in this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant