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

Haddocks for main provided by CI #910

Open
jhrcek opened this issue May 13, 2023 · 6 comments
Open

Haddocks for main provided by CI #910

jhrcek opened this issue May 13, 2023 · 6 comments
Labels

Comments

@jhrcek
Copy link

jhrcek commented May 13, 2023

We should have CI produce haddocks for main, and upload them to amazonka.brendanhay.nz.


Original Text: The documentation page https://amazonka.brendanhay.nz/ is missing haddocks for amazonka-ec2.
Is this a bug in docs generating logic or something?

@brendanhay
Copy link
Owner

Unfortunately with the recent Bazel -> Nix Flake changes to the builds the docs are not being generated. I'd really like to use the Cabal haddock-project command - but it's still not generally available, see: #906

If there's no movement here I'll probably just end up with some interim hack to try and package and upload the docs. Apologies for any confusion!

@jhrcek
Copy link
Author

jhrcek commented May 13, 2023

Thanks for explanation and for working on this package.
It's not critical. I guess it would be enough for my purposes to check the docs on hackage later, once 2.0 is released.

@ysangkok
Copy link
Contributor

@brendanhay Would it be possible to generate the docs using a pre-release cabal-install build? After all, most users will consume the docs in rendered form. Most users aren't working on amazonka itself, so they wouldn't need the custom cabal-install build.

@endgame
Copy link
Collaborator

endgame commented Jun 24, 2023

I'm sorry, I don't understand this question.

@brendanhay
Copy link
Owner

brendanhay commented Jun 24, 2023

I think @ysangkok is asking about the haddock-project command which would require using a pre-release cabal-install to generate a standalone haddock bundle we could serve from GitHub pages.

We could try it out in a separate CI job - It'd be worth an experiment to know how long the docs build takes and if it is as trivial as pushing the resulting artefact as a GH pages branch, it'd be nice to have docs for main again.

@endgame endgame added this to the 2.0 milestone Jun 24, 2023
@endgame endgame removed this from the 2.0 milestone Jul 10, 2023
@endgame
Copy link
Collaborator

endgame commented Aug 4, 2023

cabal haddock-project appears to be in cabal-install 3.10. Someone should test this and see if we can CI documentation. I'll retitle this issue.

@endgame endgame changed the title Missing haddock for amazonka-ec2 Haddocks for main provided by CI Aug 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants