r/o

README.md

Pipa

Features

  • Greasemonkey script to insert the Pipa on target pages.
  • Light/dark mode.
  • Link multiple URLs to a single entry to tie them together.
    • Reorder URLs to keep whatโ€™s most relevant at top.
  • Define columns for each entry; can also be used to sort. Default sort is saved.
  • Add comments to entries; supports image attachments.
  • All changes recorded in a per-entry event log.


  • Supports gitlab.com and github.com for most activities:
    • Friendly display of URLs.
    • Fetch MR/issue status via API, displayed next to MR/issue title reference wherever it appears.


    • Fetch MR/issue labels and MR mergeability via API, displayed under URL in sidebar.


    • All fetched data is cached, and refreshed in the background on access when stale.
      • Closed or merged issues/MRs are considered stale much less frequently than open ones.
    • Show CI status in columns for easier view.








  • Columns and comments can refer to other entries, linked issues and MRs with shorthand reference syntax.




  • Due and overdue dates in columns highlighted.


  • Confidential issues and non-public projects highlighted.


  • Index view ages completed items out by quarter.


  • Update date columns from the index without leaving.

See TODO for what might come next.

Overview

The Pipa Index.

A Greasemonkey script inserts this little guy:

โ€ฆ onto pages of your choosing:

He will take you to the Pipa Index for that page:

Page isnโ€™t in the Index? The Pipa is angry!

Do not be alarmed. He will invite you to create a new entry in the Pipa Index:

The columns in the Index are defined by you.

All changes are saved in an event log.

Getting started

This section is TODO, but Iโ€™m including it now to record things that will be useful for it.

Serving suggestion for โ€œUser matchesโ€:

https://gitlab.com/*
https://dev.gitlab.org/*
https://github.com/*

Serving suggestion for โ€œUser excludesโ€ (so you donโ€™t get Pipa appearing in iframes):

https://gitlab.com/-/sandbox/mermaid*

Serving suggestion for โ€œUser domain whitelistโ€ (to be used with a pipa.index entry in /etc/hosts):

pipa.index

Legal

Pipa is art by Rigatoni Garrido! You can buy Pipa merchandise! This use of the Pipa is totally unauthorised! I will most likely have to change the included artwork if anyone ever notices this!

Contact

@kivikakk on Slack if youโ€™re tanuki, otherwise ashe@kivikakk.ee.