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

Update markdown requirement from <3.6,>=3.4 to >=3.4,<3.7 #1352

Merged
merged 2 commits into from
Mar 18, 2024

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Mar 18, 2024

Updates the requirements on markdown to permit the latest version.

Release notes

Sourced from markdown's releases.

Release 3.6

Changed

Refactor TOC Sanitation

  • All postprocessors are now run on heading content.
  • Footnote references are now stripped from heading content. Fixes #660.
  • A more robust striptags is provided to convert headings to plain text. Unlike, the markupsafe implementation, HTML entities are not unescaped.
  • The plain text name, rich html, and unescaped raw data-toc-label are saved to toc_tokens, allowing users to access the full rich text content of the headings directly from toc_tokens.
  • The value of data-toc-label is sanitized separate from heading content before being written to name. This fixes a bug which allowed markup through in certain circumstances. To access the raw unsanitized data, retrieve the value from token['data-toc-label'] directly.
  • An html.unescape call is made just prior to calling slugify so that slugify only operates on Unicode characters. Note that html.unescape is not run on name, html, or data-toc-label.
  • The functions get_name and stashedHTML2text defined in the toc extension are both deprecated. Instead, third party extensions should use some combination of the new functions run_postprocessors, render_inner_html and striptags.

Fixed

  • Include scripts/*.py in the generated source tarballs (#1430).
  • Ensure lines after heading in loose list are properly detabbed (#1443).
  • Give smarty tree processor higher priority than toc (#1440).
  • Permit carets (^) and square brackets (]) but explicitly exclude backslashes (\) from abbreviations (#1444).
  • In attribute lists (attr_list, fenced_code), quoted attribute values are now allowed to contain curly braces (}) (#1414).
Changelog

Sourced from markdown's changelog.

[3.6] -- 2024-03-14

Changed

Refactor TOC Sanitation

  • All postprocessors are now run on heading content.
  • Footnote references are now stripped from heading content. Fixes #660.
  • A more robust striptags is provided to convert headings to plain text. Unlike, the markupsafe implementation, HTML entities are not unescaped.
  • The plain text name, rich html, and unescaped raw data-toc-label are saved to toc_tokens, allowing users to access the full rich text content of the headings directly from toc_tokens.
  • The value of data-toc-label is sanitized separate from heading content before being written to name. This fixes a bug which allowed markup through in certain circumstances. To access the raw unsanitized data, retrieve the value from token['data-toc-label'] directly.
  • An html.unescape call is made just prior to calling slugify so that slugify only operates on Unicode characters. Note that html.unescape is not run on name, html, or data-toc-label.
  • The functions get_name and stashedHTML2text defined in the toc extension are both deprecated. Instead, third party extensions should use some combination of the new functions run_postprocessors, render_inner_html and striptags.

Fixed

  • Include scripts/*.py in the generated source tarballs (#1430).
  • Ensure lines after heading in loose list are properly detabbed (#1443).
  • Give smarty tree processor higher priority than toc (#1440).
  • Permit carets (^) and square brackets (]) but explicitly exclude backslashes (\) from abbreviations (#1444).
  • In attribute lists (attr_list, fenced_code), quoted attribute values are now allowed to contain curly braces (}) (#1414).

[3.5.2] -- 2024-01-10

Fixed

  • Fix type annotations for convertFile - it accepts only bytes-based buffers. Also remove legacy checks from Python 2 (#1400)
  • Remove legacy import needed only in Python 2 (#1403)
  • Fix typo that left the attribute AdmonitionProcessor.content_indent unset (#1404)
  • Fix edge-case crash in InlineProcessor with AtomicString (#1406).
  • Fix edge-case crash in codehilite with an empty code tag (#1405).
  • Improve and expand type annotations in the code base (#1401).
  • Fix handling of bogus comments (#1425).

[3.5.1] -- 2023-10-31

... (truncated)

Commits
  • e524b8f Bump version to 3.6
  • 3d8afc6 Allow attr_list quoted values to contain curly braces
  • 9edba85 Refactor abbr escaping
  • e4ab4a6 Refactor TOC sanitation
  • a18765c Explicitly omit carot and backslash from abbr
  • 421f1e8 Give smarty tree processor higher priority than toc
  • c334a3e Ensure lines after heading in loose list are properly detabbed
  • ea92856 Update the license template so GitHub can detect it
  • a2effd6 Disable mkdocstrings show_symbol_type_toc option to work around searching iss...
  • 91f9a12 Restore Attribute symbol type in mkdocstrings template
  • Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Updates the requirements on [markdown](https://github.com/Python-Markdown/markdown) to permit the latest version.
- [Release notes](https://github.com/Python-Markdown/markdown/releases)
- [Changelog](https://github.com/Python-Markdown/markdown/blob/master/docs/changelog.md)
- [Commits](Python-Markdown/markdown@3.4...3.6)

---
updated-dependencies:
- dependency-name: markdown
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Mar 18, 2024
Copy link

codecov bot commented Mar 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.52%. Comparing base (2167222) to head (22e62ed).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1352   +/-   ##
=======================================
  Coverage   79.52%   79.52%           
=======================================
  Files         114      114           
  Lines        4737     4737           
  Branches      637      637           
=======================================
  Hits         3767     3767           
  Misses        759      759           
  Partials      211      211           

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

@benjaoming
Copy link
Member

With the many changes to the DOC in the TOC extension, I both wonder if we need to update our own from the latest upstream version -- and indeed if anything has broken.

@oscarmcm
Copy link
Member

I think its a good time to update to the latest version.

@benjaoming
Copy link
Member

Yes, agreed.

We can also merge this PR and then review the demo deployment and open issues based on that?

@oscarmcm
Copy link
Member

sounds good, means we'll delay release for Django 5? or should we release a new version with Django 5 support and move the BS upgrade and this MD update to the next big one?

@benjaoming
Copy link
Member

I've tested this locally now, and the Markdown upgrade works for me -- it renders all the demo data fine, [TOC] is also fine.

@benjaoming benjaoming merged commit 1da1368 into main Mar 18, 2024
17 checks passed
@benjaoming benjaoming deleted the dependabot/pip/markdown-gte-3.4-and-lt-3.7 branch March 18, 2024 21:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants