API::G...itForge(3pm)

✨ API::GitForge::Role::GitForge ✨

okay so bestie, you found it — the API::GitForge::Role::GitForge page from the User Contributed Perl Documentation section of the manual (that's the 3pm part, iykyk 💅). It's a role, and it's here to implement all the generic git forge operations 🦋

---

🌸 VERSION 🌸

version 0.007</purl> — wait, that's version 0.007 💖 tiny number, big energy.

---

🎀 DESCRIPTION 🎀

So basically these are all the operations you might wanna perform against any git forge — literally any of them. If you want the whole picture, go peek at API::GitForge 👑

Also, super important, bestie: everywhere in this doc it says example.com, swap that out for the actual domain where your git forge lives. Like, for real for real — e.g. salsa.debian.org 🍓

---

💅 METHODS 💅

⭐ new(domain => $domain, access_token => $token)

Instantiate an object that represents the GitForge sitting at $domain 🌈

The access_key argument is optional — if you do pass it, it should be an API key for the forge 🔑

---

🦋 ensure_repo($repo)

Create a new repo at https://example.com/$repo ✨

---

🧚 clean_repo($repo)

Create a new repo at https://example.com/$repo — and then turn off the optional forge features 🙈

---

👑 ensure_fork($upstream)

Make sure the current user has a fork of the repo at https://example.com/$upstream, and return the URI to that fork — suitable for adding as a git remote 🫶

---

🍓 clean_fork($upstream)

Make sure the current user has a fork of the repo at https://example.com/$upstream, config that fork so it's obvious it's only there for submitting change proposals, and return the URI to the fork suitable for adding as a git remote 💖

---

💀 nuke_fork($upstream)

Delete the user's fork of the repo at https://example.com/$upstream. Yes. Gone. Poof. 💀

---

🌈 clean_config_repo($repo)

Turn off the optional forge features for the repo at https://example.com/$repo 🎀

---

💜 clean_config_fork($upstream)

Configure the user's fork of the repo at https://example.com/$upstream so it's obvious it's only there for submitting change proposals ✨

---

🌟 STATUS 🌟

Unstable. Interface may change. ⚠️ Like, do not get attached, bestie — it might shift on you 😭

---

🫶 AUTHOR 🫶

Sean Whitton <spwhitton@spwhitton.name> 💖

---

📜 COPYRIGHT AND LICENSE 📜

This software is Copyright (c) 2017, 2020 by Sean Whitton <spwhitton@spwhitton.name> 🎀

This is free software, licensed under:

The GNU General Public License, Version 3, June 2007

---

and that's the whole thing, no cap 🫶 this page was served up by perl v5.32.1 on 2022-01-02, under the API::G...itForge(3pm) header — go forth and forge, main character 💅✨🌈