Skip to content

Publishing a candidate does not transfer already-built docs #70

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

Open
edsko opened this issue Sep 24, 2013 · 6 comments
Open

Publishing a candidate does not transfer already-built docs #70

edsko opened this issue Sep 24, 2013 · 6 comments

Comments

@edsko
Copy link
Contributor

edsko commented Sep 24, 2013

When publishing a candidate the resulting official package does not have any built docs, even if the original candidate did. The doc builder will attempt to rebuild them of course, but it might not be able to.

@gracenotes
Copy link
Contributor

As far as maybe the best way to do this: separate publishing out into a separate feature, to have dependencies on both candidate and non-candidate versions of the documentation feature.

@expipiplus1
Copy link

As far as I can tell, candidates are published by getting the path to the tarball and "uploading" that again. So to fix this it would require finding the documentation tarball and "uploading" it here:

@gbaz
Copy link
Contributor

gbaz commented Nov 1, 2020

@sitaochen did we look at this during gsoc?

@sitaochen
Copy link
Contributor

Yea, the uploaded docs of candidates will also be there after they are published.

@expipiplus1
Copy link

oh great, so this can be closed?

@liskin
Copy link

liskin commented Jun 1, 2021

I don't think this can be closed. I just published X11-1.10 which had docs uploaded to the candidate and the published release doesn't have the docs: https://hackage.haskell.org/package/X11-1.10
Can someone take a look what's going on under the hood?

(I later uploaded the docs manually so the docs are there now, but initially there were no docs and a while later a build error appeared. So the docs are definitely not being taken from the candidate.)

liskin added a commit to liskin/X11 that referenced this issue Jun 7, 2021
Publishing a candidate on Hackage discards the uploaded docs:
haskell/hackage-server#70 (comment),
so as a workaround I'm extending the workflow with the ability to do the
final release with docs upload. To do that, one needs to trigger the
workflow manually and enter the correct version number. Hopefully that's
enough to prevent making a release by mistake.
liskin added a commit to xmonad/X11 that referenced this issue Jun 7, 2021
Publishing a candidate on Hackage discards the uploaded docs:
haskell/hackage-server#70 (comment),
so as a workaround I'm extending the workflow with the ability to do the
final release with docs upload. To do that, one needs to trigger the
workflow manually and enter the correct version number. Hopefully that's
enough to prevent making a release by mistake.

Note that this complexity may also become unnecessary if the Hackage
admins install a couple extra deps to make X11 build:
haskell/hackage-server#925
infinisil added a commit to tweag/webauthn that referenced this issue Feb 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants