PyAV icon indicating copy to clipboard operation
PyAV copied to clipboard

Upload docs from GitHub Actions

Open mikeboers opened this issue 5 years ago • 5 comments

What the title says.

The docs are currently hosted on one of my personal servers. Any sort of authenticated deployment is acceptable to me. I'm open to writing a tiny Flask app to assist which manages the versioning as well.

mikeboers avatar May 01 '20 18:05 mikeboers

Seems like this might be the most reasonable way to authenticate: https://github.com/marketplace/actions/install-ssh-key

That SSH key could/should be restricted to a small script that deals with versioning.

mikeboers avatar May 01 '20 19:05 mikeboers

It sort of scares me that I could accidentally nuke your server, I'm not sure SSH'ing into your server is a good fit for the public nature of the project.

I see two options:

  • host the docs on readthedocs. I know you mentioned you have some custom logic going on, but sphinx is really very extensible

  • have Github Actions deliver a trigger to your server (with a secret managed in the projects' "secrets") to an HTTP endpoint which actually performs the docs build

jlaine avatar May 01 '20 21:05 jlaine

You can easily restrict a SSH key to only be able to run a single command. That command could accept a tarball of the docs build. I'm not concerned at all TBH.

Could do readthedocs if we can upload a built version.

mikeboers avatar May 02 '20 00:05 mikeboers

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Mar 27 '22 10:03 github-actions[bot]

This is till a goal

jlaine avatar May 09 '22 08:05 jlaine

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Sep 07 '22 04:09 github-actions[bot]

This is still a goal

jlaine avatar Oct 16 '22 10:10 jlaine

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Feb 15 '23 02:02 github-actions[bot]