Add Remotes.Remote for Forgejo (#2857)

Author: alametti

CHANGELOG.md

@@ -3,6 +3,12 @@
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased
+
+### Added
+
+* Added `Remotes.Forgejo` for specifying a `Remote` hosted on a Forgejo instance (such as codeberg.org). ([#2857])
+
 ## Version [v1.16.1] - 2025-11-21
 
 ### Fixed

docs/src/lib/remote-links.md

@@ -53,7 +53,7 @@ Note that enabling this option can cause documentation builds to fail due to net
 
 !!! note
 
-    The [`Remotes` API](@ref remotes-api) can be used to implement the methods to compute the remote URLs (for now, Documenter only supports [GitHub](@ref Remotes.GitHub) and [GitLab](@ref Remotes.GitLab) natively).
+    The [`Remotes` API](@ref remotes-api) can be used to implement the methods to compute the remote URLs (for now, Documenter supports [GitHub](@ref Remotes.GitHub), [GitLab](@ref Remotes.GitLab) and [Forgejo](@ref Remotes.Forgejo) natively).
 
 [^1]: There is an exception to this: links to Julia `Base` module source files.
       But Documenter already known how to handle those correctly, and they are really only relevant to the Julia main manual build.
@@ -84,6 +84,7 @@ The rules are as follows:
 Documenter.Remotes
 Documenter.Remotes.GitHub
 Documenter.Remotes.GitLab
+Documenter.Remotes.Forgejo
 ```
 
 The following types and functions and relevant when creating custom

src/utilities/Remotes.jl

@@ -173,6 +173,53 @@ function fileurl(remote::GitLab, ref::AbstractString, filename::AbstractString,
 end
 issueurl(remote::GitLab, issuenumber) = "$(repourl(remote))/-/issues/$issuenumber"
 
+"""
+    Forgejo(host, user, repo)
+    Forgejo(remote)
+
+Represents a remote Git repository hosted on Forgejo (for example,
+[Codeberg](https://codeberg.org)). The repository is
+identified by the host, name of the user (or organization), and the
+repository. For example:
+
+```julia
+makedocs(
+    repo = Forgejo("codeberg.org", "JuliaDocs", "Documenter.jl")
+)
+```
+
+The single argument constructor assumes that the host, end user and
+repository parts are separated by a slash (e.g.,
+`codeberg.org/JuliaDocs/Documenter.jl`).
+"""
+struct Forgejo <: Remotes.Remote
+    host::String
+    user::String
+    repo::String
+end
+function Forgejo(remote::AbstractString)
+    host, user, repo = split(remote, '/')
+    return Forgejo(host, user, repo)
+end
+repourl(
+    remote::Forgejo,
+) = "https://$(remote.host)/$(remote.user)/$(remote.repo)"
+function fileurl(
+        remote::Forgejo,
+        ref::AbstractString,
+        filename::AbstractString,
+        linerange,
+    )
+    url = "$(repourl(remote))/src/commit/$(ref)/$(filename)"
+    isnothing(linerange) && return url
+    lstart, lend = first(linerange), last(linerange)
+    return (lstart == lend) ? "$(url)#L$(lstart)" : "$(url)#L$(lstart)-L$(lend)"
+end
+issueurl(
+    remote::Forgejo,
+    issuenumber,
+) = "$(repourl(remote))/issues/$issuenumber"
+
 ############################################################################
 # Handling of URL string templates (deprecated, for backwards compatibility)
 #

test/remotes.jl

@@ -1,7 +1,7 @@
 module RemoteTests
 using Test
 using Documenter
-using .Remotes: repofile, repourl, issueurl, URL, GitHub, GitLab
+using .Remotes: repofile, repourl, issueurl, URL, GitHub, GitLab, Forgejo
 
 @testset "RepositoryRemote" begin
     let r = URL("https://github.com/FOO/BAR/blob/{commit}{path}#{line}")
@@ -95,6 +95,25 @@ using .Remotes: repofile, repourl, issueurl, URL, GitHub, GitLab
         @test repofile(r, "mybranch", "src/foo.jl", 5:8) == "https://gitlab.com/JuliaDocs/Documenter.jl/-/tree/mybranch/src/foo.jl#L5-L8"
         @test issueurl(r, "123") == "https://gitlab.com/JuliaDocs/Documenter.jl/-/issues/123"
     end
+
+    # Forgejo remote
+    let r = Forgejo("git.mydomain.tld", "JuliaDocs", "Documenter.jl")
+        @test repourl(r) == "https://git.mydomain.tld/JuliaDocs/Documenter.jl"
+        @test repofile(r, "mybranch", "src/foo.jl") == "https://git.mydomain.tld/JuliaDocs/Documenter.jl/src/commit/mybranch/src/foo.jl"
+        @test repofile(r, "mybranch", "src/foo.jl", 5) == "https://git.mydomain.tld/JuliaDocs/Documenter.jl/src/commit/mybranch/src/foo.jl#L5"
+        @test repofile(r, "mybranch", "src/foo.jl", 5:5) == "https://git.mydomain.tld/JuliaDocs/Documenter.jl/src/commit/mybranch/src/foo.jl#L5"
+        @test repofile(r, "mybranch", "src/foo.jl", 5:8) == "https://git.mydomain.tld/JuliaDocs/Documenter.jl/src/commit/mybranch/src/foo.jl#L5-L8"
+        @test issueurl(r, "123") == "https://git.mydomain.tld/JuliaDocs/Documenter.jl/issues/123"
+    end
+
+    let r = Forgejo("codeberg.org/JuliaDocs/Documenter.jl")
+        @test repourl(r) == "https://codeberg.org/JuliaDocs/Documenter.jl"
+        @test repofile(r, "mybranch", "src/foo.jl") == "https://codeberg.org/JuliaDocs/Documenter.jl/src/commit/mybranch/src/foo.jl"
+        @test repofile(r, "mybranch", "src/foo.jl", 5) == "https://codeberg.org/JuliaDocs/Documenter.jl/src/commit/mybranch/src/foo.jl#L5"
+        @test repofile(r, "mybranch", "src/foo.jl", 5:5) == "https://codeberg.org/JuliaDocs/Documenter.jl/src/commit/mybranch/src/foo.jl#L5"
+        @test repofile(r, "mybranch", "src/foo.jl", 5:8) == "https://codeberg.org/JuliaDocs/Documenter.jl/src/commit/mybranch/src/foo.jl#L5-L8"
+        @test issueurl(r, "123") == "https://codeberg.org/JuliaDocs/Documenter.jl/issues/123"
+    end
 end
 
 end # module