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

Please enable CI build of documentation #86

Closed
mgkuhn opened this issue May 31, 2021 · 4 comments
Closed

Please enable CI build of documentation #86

mgkuhn opened this issue May 31, 2021 · 4 comments

Comments

@mgkuhn
Copy link
Collaborator

mgkuhn commented May 31, 2021

In commit 75d6ddc (part of PR #74) I added a CI build target for documentation formatted by Documenter.jl. Could you please complete the steps needed to host this documentation on GitHub pages (setting up the SSH key, check again that everything is still in line with the latest conventions), and then add to the README.md the customary shields:

(Alternatively, if you allow me to join the JuliaIO organization, I'd also be delighted to finish this myself.)

@IanButterworth
Copy link
Member

Alternatively, if you allow me to join the JuliaIO organization, I'd also be delighted to finish this myself.

Sorry, I stalled on this when it was brought up before. I just invited you!

The love this package needs has been on my mind for a while. Appreciate the help!

@mgkuhn
Copy link
Collaborator Author

mgkuhn commented May 31, 2021

@IanButterworth Thanks. Having accepted the invite appears to have enabled me now to close issues and merge PRs, but it still doesn't give me access to the “Settings” tab of this repo, which I need to use to install SSH deploy keys.

Also, does JuliaIO have any preference whether to use Travis CI or GitHub Actions to deploy gh-pages documentation? I'd quite like to deploy documentation for tagged versions, which I believe requires using the route GitHub Actions with SSH authentication, also for Tag Bot. (It's all become a bit complex since I last did this.)

@IanButterworth
Copy link
Member

IanButterworth commented May 31, 2021

Ah yes, I just elevated your perms for this repo.

Travis CI for FOSS projects isn't really an option anymore. I'd go with GitHub Actions.

@mgkuhn
Copy link
Collaborator Author

mgkuhn commented Jun 1, 2021

@IanButterworth Thanks, gh-pages documentation via GitHub Actions is now live at https://JuliaIO.github.io/LibSerialPort.jl/dev (“stable” should follow automatically at the next tagged release)

@mgkuhn mgkuhn closed this as completed Jun 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants