add Woodpecker

[uncomfyhalomacro]

Draft for now since I am going to add some documentation first :D

Edit by @mortenpi: close #1878

[uncomfyhalomacro]

Currently works during my experiment on adding it

[uncomfyhalomacro]

I still have to figure out autodetection since CI is commonly used as an env var for all forges such as Github
I realized i can just add it as last since CI may return woodpecker or drone

[uncomfyhalomacro]

@mortenpi @fredrikekre fixed a lot of typos now that i missed and i rebased it so and forced push with lease to make the history clean. Works fine now on my project that i tested this branch on.

[fredrikekre]

Please use 4 space indent. Can you also add a note about this in the CHANGELOG.md file?

[uncomfyhalomacro]

This should be ready for another review now 😄

[fredrikekre]

Looks fine, can you add some tests to https://github.com/JuliaDocs/Documenter.jl/blob/master/test/deployconfig.jl?

[mortenpi]

Looks great for the most part, just some nitpicks.

• Do you have an example run on Codeberg/Woopecker that uses this branch?
• I don't think the PR is up to date with master? There should be some conflicts in the CHANGELOG.

[uncomfyhalomacro]

Looks great for the most part, just some nitpicks.

* Do you have an example run on Codeberg/Woopecker that uses this branch?

* I don't think the PR is up to date with master? There should be some conflicts in the CHANGELOG.

https://codeberg.org/uncomfyhalomacro/SBOL3.jl/src/branch/main/.woodpecker/.doc-woodpecker-experiment.yml I experimented this on my soon-ish to start project of mine. Result will update my pages branch https://codeberg.org/uncomfyhalomacro/SBOL3.jl/src/branch/pages. -> the result would be this https://uncomfyhalomacro.codeberg.page/SBOL3.jl/dev/

I will rebase from upstream branch then :D and fix some conflicts

[uncomfyhalomacro]

Just found an issue on the rendered pages where if I click the edit button, it gives the wrong link even with correct root URL. I have to fix and resolve results from the code review later.

[mortenpi]

If the edit link behavior was something that just appeared, then it might also be something from #1808.

[uncomfyhalomacro]

If the edit link behavior was something that just appeared, then it might also be something from #1808.

nah i found out it was something else haha. anyway. it is ready for review now (again) :D

[mortenpi]

it is ready for review now (again) :D

Did you forget to push? I see you marked the comments resolved, but I believe the code hasn't changed?

[uncomfyhalomacro]

it is ready for review now (again) :D

Did you forget to push? I see you marked the comments resolved, but I believe the code hasn't changed?

No, it has changed. I just need to push one more to resolve authenticated_repo_url.

EDIT: resolved in commit bc81ef6

[mortenpi]

Cool! I think this LGTM now, other than the two minor things.

Do you links to a run on Codeberg with the latest version of this here by any chance, including the CI logs?

[uncomfyhalomacro]

Cool! I think this LGTM now, other than the two minor things.

Do you links to a run on Codeberg with the latest version of this here by any chance, including the CI logs?

https://ci.codeberg.org/uncomfyhalomacro/SBOL3.jl/build/12/1 here 😄

Configuration used:

matrix:
  JULIA_VERSION:
    - 1.7.3-alpine
  platform:
    - linux/amd64
platform: ${platform}
pipeline:
  build:
    when:
      branch:
        - main
    image: julia:${JULIA_VERSION}
    commands:
      - apk add git
      - julia -e 'using Pkg; Pkg.develop(url="https://codeberg.org/uncomfyhalomacro/SBOL3.jl");'
      - rm docs/Project.toml
      - julia --project=docs/ -e 'using Pkg; Pkg.add(url="https://github.com/uncomfyhalomacro/Documenter.jl", rev="woodpecker"); Pkg.add(url="https://codeberg.org/uncomfyhalomacro/SBOL3.jl")'
      - julia --project=docs/ docs/make.jl
    secrets: [ project_access_token ]

[mortenpi]

Hmm. In the configuration, unless I am mistaken, but:

• julia -e 'using Pkg; Pkg.develop(url="https://codeberg.org/uncomfyhalomacro/SBOL3.jl");' will just add SBOL3 into the global environment, which seems unnecessary?
• The rm docs/Project.toml seems unnecessary -- you can just modify the existing environment. In fact, usually you'd want to just add current package as dev dep and then Pkg.instantiate it, especially if you have a bunch of other packages there.
• Pkg.add(url="https://codeberg.org/uncomfyhalomacro/SBOL3.jl") will make the documentation build use your main version no matter what. You should do Pkg.develop(path=pwd()) instead, to make sure you're using SBOL3 from the checked out repository.

[uncomfyhalomacro]

Hmm. In the configuration, unless I am mistaken, but:

* `julia -e 'using Pkg; Pkg.develop(url="https://codeberg.org/uncomfyhalomacro/SBOL3.jl");'` will just add SBOL3 into the global environment, which seems unnecessary?

* The `rm docs/Project.toml` seems unnecessary -- you can just modify the existing environment. In fact, usually you'd want to just add current package as dev dep and then `Pkg.instantiate` it, especially if you have a bunch of other packages there.

* `Pkg.add(url="https://codeberg.org/uncomfyhalomacro/SBOL3.jl")` will make the documentation build use your `main` version no matter what. You should do `Pkg.develop(path=pwd())` instead, to make sure you're using SBOL3 from the checked out repository.

For the first one. Yeah I can remove it because that is just an experimentation for finding some issues from Pkg. It was because I have many errors caused by Pkg.jl. This is because the package is not yet registered so even with julia --project=docs/ using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate() that will error. So that is my workaround for now.

As for the second one, i have to remove it otherwise, it will instantiate an non-existing UUID (not registered). So removing Project.toml then adding the packages manually fixes my issue.

Third one, I think i stated the reason in the first one.

[uncomfyhalomacro]

It is a separate issue. Maybe I should have open an issue in Pkg.jl hmm

Logs for why i use Pkg.add instead of the usual Pkg.develop(PackageSpec(path=pwd())): https://ci.codeberg.org/uncomfyhalomacro/SBOL3.jl/build/2/9

If you have a registered package, it should be fine.

[mortenpi]

Logs for why i use Pkg.add instead of the usual Pkg.develop(PackageSpec(path=pwd())): https://ci.codeberg.org/uncomfyhalomacro/SBOL3.jl/build/2/9

If you put the add after the develop it should be fine I believe. The standard setup definitely works for unregistered packages.

[uncomfyhalomacro]

Logs for why i use Pkg.add instead of the usual Pkg.develop(PackageSpec(path=pwd())): https://ci.codeberg.org/uncomfyhalomacro/SBOL3.jl/build/2/9

If you put the add after the develop it should be fine I believe. The standard setup definitely works for unregistered packages.

Going to try that

[uncomfyhalomacro]

@mortenpi well that worked. thanks! https://ci.codeberg.org/SynBioJulia/SBOL3.jl/build/1/3 anyway just ignore the part where Documenter fails. Forgot to update my repository link. I moved my project to an org.

[uncomfyhalomacro]

One more documentation on how to generate SSH keys and converting the private key to a base64 key and then another review so this could be merged

[uncomfyhalomacro]

@fredrikekre @mortenpi This is ready to be merged. You can review again I guess.

[mortenpi]

@uncomfyhalomacro Would you be okay using the master branch of Documenter for a while? It's going to be a while before we tag 0.28.0, but I am not sure I want to go through the hassle of backporting this unless it's really necessary.

[uncomfyhalomacro]

It should be fine! No worries 😄

[mortenpi]

Cool. And thanks a lot for iterating on the PR!