Add support for Forgejo forge #107

pepicrft · 2025-03-08T12:18:32Z

I'm user of Codeberg, a hosted instance of the Git forge Forgejo, and I'd like to use UBI against repositories in those repos.

Since Forgejo mimics the API of GitHub, the implementation of Forgejo's forge symbol is very much a copy & paste of GitHub's. Please, let me know if you'd want me to extract some common functionality into another module for the purpose of reusability.

autarch · 2025-03-15T14:55:18Z

Hi, thanks for your PR! I'm pretty finicky about my projects (see this blog post for details), so I rarely merge a PR as-is. I can move forward on your PR in one of two ways:

I check it out locally, fiddle with it as needed, merge it locally, and simply close this PR. This will preserve at least one commit with your name on it, but the PR will show up as closed in your GitHub stats.
If you enable me to push directly to your PR branch (which is the default when you make a PR), I can do my fiddling, then force push to your PR branch and merge the resulting PR. Again, this will preserve at least one commit with your name on it, but you also get credit for the PR merge in your GitHub stats. The only downside is that I will be force pushing directly to your PR branch. Note that this will not work if the PR branch is named master. GitHub doesn't allow me to push to the default branch of your fork.

Please let me know which approach you'd prefer. If I don't hear from you before I get around to working on this PR I'll go with option 1.

Thanks again for your contribution!

autarch · 2025-03-16T22:27:23Z

I spent some time trying to tweak this, but I finally realized that Forgejo does not actually have the same API as GitHub, at least not the same as the GH v4 REST API.

Specifically, when you get releases from GitHub, you get something like this:

{
  "assets": [
    {
      "url": "https://api.github.com/repos/houseabsolute/precious/releases/assets/237809592",
      "name": "precious-FreeBSD-x86_64.tar.gz",
  ],
}

But Forgejo doesn't include a url field for assets. You can construct the URL from the asset's id, but even using that constructed URL, it doesn't seem like you can download the actual asset contents that way, unlike GitHub.

autarch · 2025-03-16T22:27:55Z

All of which is to say, this does need its own forge type. But don't work on that now. In working on this myself, I've done a bunch of refactoring that I'd like to finish up first.

pepicrft · 2025-03-17T10:16:10Z

Hi @autarch 👋🏼

First of all, thanks for your transparency. I'm open to whatever method works best for you (I'm not that attached to the idea of having to preserve my name in the work).

But Forgejo doesn't include a url field for assets. You can construct the URL from the asset's id, but even using that constructed URL, it doesn't seem like you can download the actual asset contents that way, unlike GitHub.

This is something I missed completely. Is there anything I can do to help you understand this better?

Thanks a lot for helping move this one forward. I started moving some of my repositories to Codeberg, and being able to use UBI through Mise to install tools would be very valuable.

autarch · 2025-04-12T12:44:42Z

So I think I'm done with the refactoring I was planning on doing. If you want to take a stab at adding support for ForgeJo, that'd be great!

pepicrft · 2025-04-25T15:56:32Z

@autarch I doubt I'll find time in the following weeks to complete this work. Feel free to close it and I'll open a new one if I find the time for it.

autarch · 2025-04-25T17:46:56Z

That's fine. I may take a look at some point, but right now I'm mostly filling my free time up by playing Satisfactory ;)

pepicrft · 2025-05-10T13:42:28Z

@autarch I found some time to work on it. I'd appreciate if you could review the work and let me know how to proceed :)

autarch

This looks good. Thanks! There's a few things missing:

Let's add CODEBERG_TOKEN as an env var to check for a token.
The builder.rs code docs should mention the token env vars.
The ForgeType::from_url code needs to accounts for the codeberg domain.
It'd be great to add an integration test in ubi-cli/tests/ubi.rs. After fixing the above issue, I was able to get https://codeberg.org/Cyborus/forgejo-cli/releases installed using ubi, so I think this is a good one to use for the integration test. Note that it doesn't have a macOS release, so the test code needs to be configured to not run on macOS. You can see a bunch of examples of per-OS conditions in that file already.

Thanks again!

autarch · 2025-05-26T14:42:29Z

ubi/src/forgejo.rs

+        env::remove_var("GITLAB_TOKEN");
+        env::remove_var("CI_JOB_TOKEN");


This should be whatever env var is used for a forgejo token. I think it'd make sense to support both CODEBERG_TOKEN and FORGEJO_TOKEN.

I'd vote for FORGEJO_TOKEN, following my other comments

I'll use FORGEJO_TOKEN. Let me know if you'd want CODEBERG_TOKEN to be added too.

I think we should add both. It doesn't hurt.

autarch · 2025-05-26T14:43:16Z

ubi/src/forge.rs


 const GITHUB_DOMAIN: &str = "github.com";
 const GITLAB_DOMAIN: &str = "gitlab.com";
+const FORGEJO_DOMAIN: &str = "codegerg.org";


This has a typo in the domain name. Also, I think we should just call it CODEBERG_DOMAIN for simplicity.

Well, the software is forgejo, the default instance chosen here codeberg.org, so (apart from the typo) I think thats okay?

I would prefer the variable name to match the actual domain name, just for consistency.

Finkregh

Thanks for the effort!

Finkregh · 2025-07-14T08:50:31Z

ubi/src/forge.rs


 const GITHUB_DOMAIN: &str = "github.com";
 const GITLAB_DOMAIN: &str = "gitlab.com";
+const FORGEJO_DOMAIN: &str = "codegerg.org";


Well, the software is forgejo, the default instance chosen here codeberg.org, so (apart from the typo) I think thats okay?

Finkregh · 2025-07-14T08:51:10Z

ubi/src/forge.rs


 const GITHUB_API_BASE: &str = "https://api.github.com";
 const GITLAB_API_BASE: &str = "https://gitlab.com/api/v4";
+const CODEBERG_API_BASE: &str = "https://codeberg.org/api/v1";


That should be FORGEJO_API_BASE, following the above variable?

Actually, I want this the other way around, so it matches the domain name.

Finkregh · 2025-07-14T08:52:09Z

ubi/src/forge.rs

            ForgeType::GitLab => Url::parse(GITLAB_API_BASE).unwrap(),
+            // The maintainers of Forgejo is Codeberg, hence why the URL
+            // doesn't align with the name of the Git forge.
+            ForgeType::Forgejo => Url::parse(CODEBERG_API_BASE).unwrap(),


But the api base changes depending on which forgejo instance you want to talk to?

You can provide your own --api-base-url via the CLI or API, so this is just the default.

Which is to say that this is correct as is.

Finkregh · 2025-07-14T08:52:48Z

ubi/src/forgejo.rs

+        env::remove_var("GITLAB_TOKEN");
+        env::remove_var("CI_JOB_TOKEN");


I'd vote for FORGEJO_TOKEN, following my other comments

pepicrft · 2025-08-10T14:44:54Z

@Finkregh & @autarch thanks a lot for your review 🙏🏼 and apologies for the delay here. I addressed your comments and pushed the changes. Could you give it another look?

autarch · 2025-08-23T16:22:03Z

I realized when looking at this that the only difference between this and GitHub is the one field name in the assert data structure. And we could reuse the existing Asset struct by just adding #[serde(alias = "browser_download_url")] to the struct field.

So given that, I think I want to refactor things a bit more to reduce code duplication. I think it's probably easiest for me to just take what you have and do the rest myself. Are you okay with that?

pepicrft · 2025-08-25T16:03:14Z

So given that, I think I want to refactor things a bit more to reduce code duplication. I think it's probably easiest for me to just take what you have and do the rest myself. Are you okay with that?

Totally :). I can't think of a better person to drive the refactors needed for that.

I realized that there was almost no difference in the forge code, even with Forgejo to come, so there's no need for the `dyn` stuff.

autarch · 2025-09-14T18:04:53Z

This is in v0.8.0, which I just released. Thanks again!

Forgejo support is added in houseabsolute/ubi#107, but I don't know what to do so ignored it.

This reverts commit 28eb48e. (#6700) Forgejo support is added in houseabsolute/ubi#107, but this PR just ignores it. The regression #6699 was caused by houseabsolute/ubi@a7742e6, which wrapped errors with contexts. To work around this, we need to keep `anyhow::Error` as is, instead of converting to `eyre::Error`, until we check the status code. --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

pepicrft force-pushed the codeberg branch from bb9caa4 to ac234d1 Compare May 10, 2025 13:41

autarch mentioned this pull request May 26, 2025

Add support for forgejo (codeberg.org) as a forge #123

Closed

autarch requested changes May 26, 2025

View reviewed changes

Finkregh reviewed Jul 14, 2025

View reviewed changes

pepicrft force-pushed the codeberg branch from ac234d1 to f8714fc Compare August 10, 2025 14:43

Refactor forge code yet again

bd22178

I realized that there was almost no difference in the forge code, even with Forgejo to come, so there's no need for the `dyn` stuff.

autarch force-pushed the codeberg branch 3 times, most recently from 47a3ae5 to 244bfd1 Compare September 14, 2025 15:17

Add support for Forgejo/Codeberg

0faa9a6

autarch force-pushed the codeberg branch 2 times, most recently from e767346 to 0faa9a6 Compare September 14, 2025 16:10

autarch merged commit 94b6322 into houseabsolute:master Sep 14, 2025
31 checks passed

risu729 mentioned this pull request Oct 11, 2025

fix(deps): update rust crate ubi to 0.8 jdx/mise#6637

Merged

jdx pushed a commit to jdx/mise that referenced this pull request Oct 11, 2025

fix(deps): update rust crate ubi to 0.8 (#6637)

4bc98c1

Forgejo support is added in houseabsolute/ubi#107, but I don't know what to do so ignored it.

risu729 mentioned this pull request Oct 14, 2025

Fix Github private repo asset downloads by preferring API URL #139

Merged

risu729 mentioned this pull request Nov 29, 2025

fix(deps): update rust crate ubi to 0.8.4 jdx/mise#7154

Merged

		env::remove_var("GITLAB_TOKEN");
		env::remove_var("CI_JOB_TOKEN");

Uh oh!

Add support for Forgejo forge #107

Add support for Forgejo forge #107

Conversation

pepicrft commented Mar 8, 2025

Uh oh!

autarch commented Mar 15, 2025

Uh oh!

autarch commented Mar 16, 2025

Uh oh!

autarch commented Mar 16, 2025

Uh oh!

pepicrft commented Mar 17, 2025

Uh oh!

autarch commented Apr 12, 2025

Uh oh!

pepicrft commented Apr 25, 2025

Uh oh!

autarch commented Apr 25, 2025

Uh oh!

pepicrft commented May 10, 2025

Uh oh!

autarch left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Finkregh left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pepicrft commented Aug 10, 2025

Uh oh!

autarch commented Aug 23, 2025

Uh oh!

pepicrft commented Aug 25, 2025

Uh oh!

Uh oh!

autarch commented Sep 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants