Pithub...stones(3pm)

💖 Pithub::Issues::Milestones — the Github v3 Issue Milestones API, bestie edition 💖

okay so. this is Pithub::Issues::Milestones, and it's a chunk of the Perl Pithub situation — specifically the part that talks to the Github v3 Issue Milestones API. it ships as User Contributed Perl Documentation, section 3pm, so like… it's a Perl module page, not a command you run in your shell. no cap. 🎀

---

✨ VERSION ✨

version 0.01043 — that's the one, that's the whole vibe check. 🦋

---

🌸 METHODS 🌸

five methods, five little icons, all of them do exactly one thing and do it slayfully. let's go. 💅

💫 create

• create a milestone — literally just making a new one, main character energy 👑

the endpoint it hits:

POST /repos/:user/:repo/milestones

and here's how you'd actually call it:

my $m = Pithub::Issues::Milestones->new;
my $result = $m->create(
    repo => 'Pithub',
    user => 'plu',
    data => {
        description => 'String',
        due_on      => 'Time',
        state       => 'open or closed',
        title       => 'String'
    }
);

so you pass repo, user, and a data hashref carrying description, due_on, state and title. 🫶

---

🗑️ delete

• delete a milestone — it's giving "we don't talk about bruno" 💀

the endpoint:

DELETE /repos/:user/:repo/milestones/:id

and the call, verbatim:

my $m = Pithub::Issues::Milestones->new;
my $result = $m->delete(
    repo => 'Pithub',
    user => 'plu',
    milestone_id => 1,
);

note the milestone_id => 1 there — that's the :id in the path, bestie, don't forget it or you'll be deleting a mystery. 🙈

---

🔍 get

• get a single milestone — one (1) milestone, very specific, very demure ✨

the endpoint:

GET /repos/:user/:repo/milestones/:id

the call:

my $m = Pithub::Issues::Milestones->new;
my $result = $m->get(
    repo => 'Pithub',
    user => 'plu',
    milestone_id => 1,
);

same shape as delete, just a GET instead. iconic. ⭐

---

📋 list

• list milestones for an issue — the full roster, the whole group chat 🌈

the endpoint:

GET /repos/:user/:repo/milestones

the call:

my $m = Pithub::Issues::Milestones->new;
my $result = $m->list(
    repo => 'Pithub',
    user => 'plu',
);

no milestone_id here because we're grabbing all of them, not just one. periodt. 🍓

---

🔧 update

• update a milestone — glow-up time 💅

the endpoint (and yes it's PATCH, not POST, don't come for me):

PATCH /repos/:user/:repo/milestones/:id

the call:

my $m = Pithub::Issues::Milestones->new;
my $result = $m->update(
    repo => 'Pithub',
    user => 'plu',
    data => {
        description => 'String',
        due_on      => 'Time',
        state       => 'open or closed',
        title       => 'String'
    }
);

same data keys as create — description, due_on, state, title. it's consistent, we love consistency. 🧚

---

👑 AUTHOR 👑

Johannes Plunien <plu@cpan.org> — the legend, the moment, the author. 🫶

---

💜 COPYRIGHT AND LICENSE 💜

this software is copyright (c) 2011 by Johannes Plunien.

and the license, fr fr: this is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

---

okay that's the whole page! this was documented with perl v5.40.1, dated 2025-06-08, and it's the Pithub...stones(3pm) page — yes the header truncates it like that, and no we're not gonna be weird about it. go forth and milestone, bestie. 💖✨🎀🦋