Debian::...l::GitHub(3pm)

📦
version 0.88 · 6 versions
, in ubuntu stonking

💖 NAME 💖

okay bestie, say hi to Debian::PkgPerl::GitHub(3pm) — it's the module that helps you forward a bug or a patch to GitHub 🦋 (it lives in the Debian Perl packaging Tools family, and yes, it's a Perl module, section 3pm, we're fancy like that 💅)

✨ SYNOPSIS ✨

use Debian::PkgPerl::Bug;
use Debian::PkgPerl::Patch;
use Debian::PkgPerl::Message;
use Debian::PkgPerl::GitHub;

my %params = (
    url     => 'https://github.com/foo/bar/issues',
    tracker => 'github',
    dist    => 'Foo-Bar',
    name    => 'My Name',
    email   => 'my.name@example.com',
    mailto  => 'your.name@example.com',
);

my %bug_info = Debian::PkgPerl::Bug
    ->new( bug => 123 )
    ->retrieve_bug_info();
my $bug_msg = Debian::PkgPerl::Message->new(
    %params,
    info => \%bug_info,
);
print Debian::PkgPerl::GitHub->new(
    message => $bug_msg,
    ticket  => 456,
)->forward();

my %patch_info = Debian::PkgPerl::Patch
    ->new( patch => 'foo-bar.patch' )
    ->retrieve_patch_info();
my $patch_msg = Debian::PkgPerl::Message->new(
    %params,
    info => \%patch_info,
);
print Debian::PkgPerl::GitHub->new(
    message  => $patch_msg,
    fallback => 0,
)->forward();

🌸 DESCRIPTION 🌸

So this module exports a lil squad of helpers whose whole job is supporting the forwarding of patches to GitHub as pull requests. That's it, that's the mission. 🎀

👑 METHODS 👑

🌟 new(%params)

Making a new object, and here's what you can hand it:

  • message — the message you wanna forward to an upstream project. Literally the whole point. 💌
  • ticket — an existing issue number, if you're forwarding the bug to that issue. 🎯
  • fallback — turns on the fallback of forwarding a patch as an issue if the pull-request fails for any reason. Default is false. 🙈

Environment:

  • DPT_GITHUB_OAUTH — GitHub personal API token. No default. You gotta bring your own, bestie. 🔑
  • DPT_GITHUB_ORGNAME — the organization used to fork upstreams. Defaults to pkg-perl-tools.
  • DPT_GITHUB_BRANCH — branch name for pull requests. Defaults to "pkg-perl-$^T".
  • DPT_GITHUB_PROTOCOL — protocol used to clone a repository. Defaults to ssh. Accepted protocols: ssh, https.

🌈 fork_exists()

Checks if any member in the GitHub organization has already forked a repository. 👀

Returns:

Boolean value. (yes/no, true/false, iconic behavior)

🦋 create_fork()

Creates a repository fork by an organization.

Returns:

The new forked repository. it's giving new baby repo energy fr fr 👑

💜 clone_branch_patch_push()

Clones a repository in a temporary directory, creates a new branch, applies the patch, commits the change, pushes it and removes the temporary working copy. Full pipeline, no notes. 🔥

Returns:

Nothing. (it did all the work and dipped 💨)

⭐ create_pull_request()

Returns:

Pull request URL on success, nothing otherwise.

🎀 forward_patch_as_pull_request()

🎀 forward_patch_as_ticket()

Fallback to forwarding a patch as a bug. 🐛

Returns:

Issue URL on success, nothing otherwise.

🧚 forward_bug_as_issue()

🧚 forward()

Forward an issue as a pull request or bug.

🍓 test()

Support for off-line testing. (your lil sandbox moment ✨)

Copyright 2016 Alex Muntada.

Copyright 2018 Damyan Ivanov.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

and that's the whole page, bestie!! 🫶 this beauty comes to you from pkg-perl-tools version 0.88, dated 2026-04-01, filed under Debian::PkgPerl::GitHub(3pm) — go forth and forward those patches, mwah 💋💖

📦 where this page comes from