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

Enforce towncrier requirements for docs to fix CI #596

Merged
merged 2 commits into from
Aug 16, 2024

Conversation

edgarrmondragon
Copy link
Contributor

What do these changes do?

Enforce towncrier requirements for docs to fix the RTD build:

Are there changes in behavior for the user?

No

Related issue number

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modifications, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep the list in alphabetical order, the file is sorted by name.
  • 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."

CHANGES/596.misc.rst Outdated Show resolved Hide resolved
@bdraco
Copy link
Member

bdraco commented Aug 16, 2024

This is effectively the same change we just had to do for yarl 👍

@bdraco bdraco enabled auto-merge (squash) August 16, 2024 15:55
@bdraco bdraco merged commit 9d26b9b into aio-libs:master Aug 16, 2024
41 of 42 checks passed
Copy link

codecov bot commented Aug 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.28%. Comparing base (267b8a2) to head (44ed211).
Report is 1 commits behind head on master.

❗ There is a different number of reports uploaded between BASE (267b8a2) and HEAD (44ed211). Click for more details.

HEAD has 515 uploads less than BASE
Flag BASE (267b8a2) HEAD (44ed211)
OS-macOS 34 5
VM-macos 34 5
Py-3.11.9 27 4
CI-GHA 151 24
Py-3.10.11 13 2
OS-Linux 87 13
VM-ubuntu 87 13
Py-3.10.14 14 2
Py-3.12.3 27 0
Py-3.9.13 12 2
Py-3.8.18 14 2
OS-Windows 30 5
VM-windows 30 5
Py-3.9.19 13 2
Py-3.8.10 13 2
Py-pypy7.3.16 12 2
Py-pypy7.3.11 6 1
Additional details and impacted files
@@             Coverage Diff              @@
##            master     #596       +/-   ##
============================================
- Coverage   100.00%   75.28%   -24.72%     
============================================
  Files            3       12        +9     
  Lines          333      878      +545     
  Branches        24       60       +36     
============================================
+ Hits           333      661      +328     
- Misses           0      181      +181     
- Partials         0       36       +36     
Flag Coverage Δ
CI-GHA 75.05% <ø> (-24.35%) ⬇️
MyPy 60.18% <ø> (?)
OS-Linux 99.39% <ø> (ø)
OS-Windows 99.22% <ø> (ø)
OS-macOS 98.83% <ø> (ø)
Py-3.10.11 98.06% <ø> (ø)
Py-3.10.14 98.19% <ø> (ø)
Py-3.11.9 98.19% <ø> (ø)
Py-3.12.3 ?
Py-3.12.4 98.19% <ø> (?)
Py-3.8.10 98.83% <ø> (ø)
Py-3.8.18 98.79% <ø> (ø)
Py-3.9.13 98.06% <ø> (ø)
Py-3.9.19 98.19% <ø> (ø)
Py-pypy7.3.11 97.67% <ø> (ø)
Py-pypy7.3.16 96.89% <ø> (ø)
VM-macos 98.83% <ø> (ø)
VM-ubuntu 99.39% <ø> (ø)
VM-windows 99.22% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@edgarrmondragon edgarrmondragon deleted the fix-docs-towncrier branch August 16, 2024 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants