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

mailmanPackages.python3: fix markdown support #321136

Merged
merged 1 commit into from
Jun 21, 2024

Conversation

fpletz
Copy link
Member

@fpletz fpletz commented Jun 20, 2024

Description of changes

Fixes the issue reported at https://gitlab.com/mailman/mailman/-/issues/1137. The readme-renderer package needs cmarkgfm for markdown support. Mailman's postorious needs this to render the info field of mailing lists.

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 24.11 Release Notes (or backporting 23.11 and 24.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

Fixes the issue reported at
https://gitlab.com/mailman/mailman/-/issues/1137. The readme-renderer
package needs cmarkgfm for markdown support. Mailman's postorious needs
this to render the info field of mailing lists.
@fpletz fpletz added the backport release-24.05 Backport PR automatically label Jun 20, 2024
@fpletz fpletz requested a review from alyssais June 20, 2024 00:12
@fpletz fpletz merged commit 930b24a into NixOS:master Jun 21, 2024
25 checks passed
@fpletz fpletz deleted the mailman-render-md branch June 21, 2024 14:28
Copy link
Contributor

Successfully created backport PR for release-24.05:


readme-renderer = super.readme-renderer.overridePythonAttrs (_: {
propagatedBuildInputs = [ self.cmarkgfm ];
});
Copy link
Member

Choose a reason for hiding this comment

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

What? Why do we only add this for mailman, and not the general readme-renderer package?

We were about to be able to eliminate the last remaining override…

Copy link
Member

Choose a reason for hiding this comment

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

38 hours is also not a lot of time to leave for maintainer review…

Copy link
Member Author

Choose a reason for hiding this comment

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

Sorry for merging this myself.

The dependency is an optional feature and not strictly required for readme_renderer: https://github.com/pypa/readme_renderer/blob/main/pyproject.toml#L34-L35. Since mailman does require this feature, I thought it would be fitting to add this to the overrides instead of adding the dependency to readme_renderer to follow upstream.

Any other suggestions?

Copy link
Member

Choose a reason for hiding this comment

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

buildPythonPackage has a mechanism to express optional-dependencies, so I think we'd just use that.

https://nixos.org/manual/nixpkgs/unstable/#buildpythonpackage-parameters

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.

None yet

2 participants