search

JuliaDocs / Documenter.jl

A documentation generator for Julia.
https://documenter.juliadocs.org
MIT License
816 stars 480 forks source link

Add Woodpecker in deployments #1878

Closed uncomfyhalomacro closed 2 years ago

uncomfyhalomacro commented 2 years ago

Add support for deploying docs in Gitea instances such as Codeberg. Add woodpecker in doc deployments

mortenpi commented 2 years ago

I don't have any personal experience with Gitea. A couple questions that pop into my head:

  1. Does it have some GitHub Pages type feature for hosting static websites?
  2. How does CI work there usually?
  3. Any public examples of Julia packages hosted there that would like to take advantage of this?
uncomfyhalomacro commented 2 years ago

I don't have any personal experience with Gitea. A couple questions that pop into my head:

1. Does it have some GitHub Pages type feature for hosting static websites?

2. How does CI work there usually?

3. Any public examples of Julia packages hosted there that would like to take advantage of this?

Sorry I was thinking about something else. I was talking about adding https://woodpecker-ci.org

uncomfyhalomacro commented 2 years ago

So to answer the following questions:

  1. https;//codeberg.org supports some form of Pages -> https://docs.codeberg.org/codeberg-pages/
  2. Gitea can use any CI. Codeberg is community gitea and they use Woodpecker CI, a clone of Drone.
  3. Probably my package or other future packages. here is a sample https://codeberg.org/uncomfyhalomacro/SBOL3.jl/src/branch/pages. Although I have got around using hacks through the woodpecker config i made here https://codeberg.org/uncomfyhalomacro/SBOL3.jl/src/branch/main/.woodpecker/.docs.yml
uncomfyhalomacro commented 2 years ago

I can probably open a PR to add Woodpecker. it shouldn't be that hard I suppose

mortenpi commented 2 years ago

As for hosting on Gitea/Codeberg, it looks like it's similar to GitHub then --- you just push to a branch of the same repo (with branch = "pages" in deploydocs). As long as it also supports some form of deploy keys, it should be easy to set up.

For Woodpecker, it should be enough to just create the corresponding DeployConfig (e.g. see the GHA one here). In fact, you should be able to do it all in your make.jl, without having to modify Documenter at all, to test it out.

uncomfyhalomacro commented 2 years ago

Sure! I should try that on my project first by modifying my make.jl with the necessary DeployConfig to test that out.

uncomfyhalomacro commented 2 years ago

Closing in favor of #1880

fredrikekre commented 2 years ago

Can be kept open until that is merged.