Support custom tag prefix for release docs

[hannahilea]

Implement #1792. Is non-breaking.

• support tag_prefix:
  • in version_tag_strip_build
    • tests
  • thread through deploy_folder
    • tests
  • thread through deploydocs
    • tests
• docstrings updated
• docs (examples) updated
  • add test for monorepo behavior as described in docs
• do lint pass
• update changelog

Edit by @mortenpi: close #1792, close #1291

[hannahilea]

wip - next step: update/redo current pr's approach to deploydocs to save in subdir and not prefix links

[hannahilea]

This is my first PR for this repo, so let me know if there are additional tests/docs/etc that I should include here!

This implementation is non-breaking, so could potentially be included in (or back-ported to) a v0.27 patch. Since the changelog shows the next unreleased version as 0.28.0 (and I see that this issue has been added to the 0.28.0 milestone) I've only added it to the changelog's 0.28.0 section.

Also, from #1792 I considered

Another possibility would be to allow the user to pass a full regex, requiring it to have one capture group which would have to capture the pure version number (i.e. something like tag_regex = r"^MyPackage-([0-9-+.]+)$"; optionally with a named capture group). More general, but at the same time more complicated for the user.

I started with the basic prefix option, with the idea that once I got a hang for the structure of the codebase I'd know how complicated the regex option would be to plumb through. After adding the basic prefix option, though, I think that it is sufficient for the original motivating feature request that @ericphanson described (in regards to our particular monorepo). I also think the regex option could introduce complicated implementation around versioned tags that maybe isn't worth taking on until there's a motivating use case without a simpler solution. (I suspect that it would likely be relevant for a non-versioned tag workflow.)

[fredrikekre]

Closes #1291.

[hannahilea]

I'm not sure why the changelog CI is failing---when I ran it locally yesterday it passed. Any hints on what might be failing there would be welcome!

[mortenpi]

I'm not sure why the changelog CI is failing

You just need to add the Markdown link definition to the PR at the bottom of the file.

[hannahilea]

thanks! added.

[mortenpi]

This looks excellent! I presume it's good to go?

Do you happen to have an example run somewhere with the branch?

[hannahilea]

Do you happen to have an example run somewhere with the branch?

Nothing public facing, so I started an example public monorepo (https://github.com/hannahilea/ExampleMonorepo.jl); I ran out of time to try it on this branch but should have the example running tomorrow. Will update when that's up!

[hannahilea]

Do you happen to have an example run somewhere with the branch?

Here's an example monorepo that uses this Documenter.jl branch---note that each package (ExampleMonorepo.jl, SubpackageA.jl, and SubpackageB.jl) was each tagged with a separate version so that it's clear that each docs version is correct:

• Top level (manual git tag: v0.4.0): https://hannahilea.github.io/ExampleMonorepo.jl/stable/
• SubpackageA.jl (manual git tag: SubpackageA-v0.2.0): https://hannahilea.github.io/ExampleMonorepo.jl/SubpackageA/stable/
• SubpackageB.jl (manual git tag: SubpackageB-v0.3.0): https://hannahilea.github.io/ExampleMonorepo.jl/SubpackageB/stable/

[mortenpi]

That looks awesome. Thanks a lot!