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

haskellPackages.pandoc-sidenote: 0.19.0.0 -> 0.20.0.0, remove broken #93421

Merged
merged 1 commit into from Apr 26, 2021

Conversation

minijackson
Copy link
Member

Motivation for this change

pandoc-sidenote 0.20.0.0 does compile and work with our current version of pandoc. It just isn't released on hackage: jez/pandoc-sidenote#14

I'm fairly new to nixpkgs' haskell ecosystem, please do tell if there is a better way to do this.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

@cdepillabout
Copy link
Member

@minijackson Thanks for trying to fix this up.

Normally we don't completely overwrite packages this way, since someone will have to remember to undo it when it is updated upstream.

The first thing I'd suggest you do is to create an issue upstream asking for a new release. Normally package maintainers are pretty happy to make a new release for compatibility purposes.

If you make an issue on the upstream repo and the author doesn't reply, then we should try to fix this up in nixpkgs.

Normally we do it by just calling fetchpatch on a GitHub commit or PR that is implementing the compatibility fix upstream. There should be a few examples of people doing this in the configuration-common.nix file.

@cdepillabout
Copy link
Member

Oh, I just read the issue you linked to in the code.

I'd post a comment to that issue urging the author to make another release to Hackage.

However, if the author's decision is to not make any more releases to Hackage, than we have a separate way of supporting packages that aren't actually on hackage. You might want to take a quick look at the pkgs/development/haskell-modules/non-hackage-packages.nix file.

I guess another solution is to take over the package on Hackage and do the uploads in place of the actual author.

Copy link
Member

@peti peti left a comment

Choose a reason for hiding this comment

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

I very much prefer a solution that gets a proper release onto Hackage. Overriding the src attribute of a released package is really a lost resort kind-of solution that I'd rather avoid.

@peti
Copy link
Member

peti commented Aug 28, 2020

Are there any news about this endeavor? @minijackson, did you have any success convincing upstream to release a new version?

@minijackson
Copy link
Member Author

@peti I think you have as much information as I have, I haven't been contacting the maintainer of pandoc-sidenote, and I haven't seen a response in the aforementioned issue upstream

barrucadu added a commit to barrucadu/barrucadu.dev that referenced this pull request Nov 7, 2020
@cdepillabout
Copy link
Member

@minijackson Are you still interested in this?

On jez/pandoc-sidenote#14 (comment), the author of this package says that he'd be happy for someone to takeover this package on Hackage, so maybe you could contact the Hackage maintainers and ask to be added as a maintainer for this package? That would allow you to upload 0.20.0.0.

@minijackson
Copy link
Member Author

@cdepillabout Ah well, it'd be awesome, but I do not have nearly enough knowledge of Haskell, nor Pandoc / Pandoc-sidenote to do that, I'm merely just an end user ^^

@cdepillabout
Copy link
Member

cdepillabout commented Feb 7, 2021

The author released a new version to Hackage: https://hackage.haskell.org/package/pandoc-sidenote-0.22.1.0

In the next couple days, you may want to rebase this PR on haskell-updates and see if pandoc-sidenote now builds. If you have any trouble with this, please feel free to respond here.

(Also, saying thanks to the author on jez/pandoc-sidenote#14 would probably be a kind gesture!)

@iFreilicht
Copy link
Contributor

@minijackson All you need to do at this point is to revert the changes you made to configuration-common.nix, but leave the change to configuration-hackage2nix.yaml intact.

The version of pandoc-sidenote released on hackage is compatible with the version of pandoc in nixpkgs, so once it's not marked as broken anymore, it can at least be distributed to unstable.

Correct me if this is wrong, I'm relatively new to nix :)

@minijackson
Copy link
Member Author

This should be good now, sorry for the delay

@minijackson minijackson requested a review from peti April 26, 2021 20:32
@sternenseemann sternenseemann merged commit 8f19637 into NixOS:master Apr 26, 2021
@sternenseemann
Copy link
Member

Can confirm. Thank you!

@sternenseemann
Copy link
Member

Whoops, this should've gone to haskell-updates. I've cherry-picked this patch on top of that branch additionally.

@minijackson minijackson deleted the pandoc-sidenote-enable branch April 27, 2021 09:49
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

6 participants