about:workflow

Contents

1. Introduction
2. Repositories
3. pkgsrc
4. pkgsrc-joyent
5. pkgsrc-wip
6. Repository Flows

Introduction

Our pkgsrc releases are made up from a number of different repositories and branches, which can be confusing for newcomers. This document aims to explain the relationships clearly and make it easy for users to know where issues and pull requests should go.

Repositories

We have three main repositories, though two of them are themselves forks of upstream repositories:

pkgsrc

This is the primary repository, located at https://github.com/joyent/pkgsrc/, and containing the majority of packages. It is a downstream fork of the official pkgsrc repository.

pkgsrc-joyent

This is a secondary repository, located at https://github.com/joyent/pkgsrc-joyent/. This repository contains a number of packages that are not (yet) suitable for committing either to pkgsrc or pkgsrc-wip, mostly because they have Joyent-specific requirements.

pkgsrc-wip

This is another secondary repository, located at https://github.com/joyent/pkgsrc-wip/, and based on the pkgsrc-wip project. This repository contains packages that are considered as not yet ready for inclusion into the main pkgsrc repository, but we find enough merit in some of them to include them in our package repositories.

Repository Flows

The following diagram shows how changes flow through the different repositories.

┌──────────────────────────────────────┬───────────────────────────────────────┐
│                                      │                                       │
│         The NetBSD Foundation        │                 Joyent                │
│         =====================        │                 ======                │
│                                      │                                       │
│       Commit directly to pkgsrc      │  Commit directly to pkgsrc-joyent and │
│                                      │    local branches of pkgsrc and wip   │
│                                      │                                       │
│  Access to pkgsrc is limited to TNF  │  Access limited to Joyent employees   │
│   members (via sponsorship process)  │                                       │
│                                      │                                       │
│  ┌────────────────────────────────┐  │                                       │
│  │ cvs.netbsd.org:/cvsroot/pkgsrc │  │                                       │
│  └───────────────┬────────────────┘  │                                       │
│                 [1]                  │                                       │
│     ┌────────────v─────────────┐     │     ┌──────────────────────────┐      │
│     │ github.com/NetBSD/pkgsrc ├────[2]───>│ github.com/joyent/pkgsrc │      │
│     └──────────────────────────┘     │     └──────────────────────────┘      │
│                                      │                                       │
├──────────────────────────────────────┤                                       │
│                                      │                                       │
│       The pkgsrc-wip project         │                                       │
│       ======================         │  ┌─────────────────────────────────┐  │
│                                      │  │ github.com/joyent/pkgsrc-joyent │  │
│    Commit directly to pkgsrc-wip     │  └─────────────────────────────────┘  │
│                                      │                                       │
│    Access open to anyone who asks    │                                       │
│                                      │                                       │
│    ┌────────────────────────────┐    │    ┌──────────────────────────────┐   │
│    │ wip.pkgsrc.org:/pkgsrc-wip ├───[3]──>│ github.com/joyent/pkgsrc-wip │   │
│    └────────────────────────────┘    │    └──────────────────────────────┘   │
│                                      │                                       │
└──────────────────────────────────────┴───────────────────────────────────────┘

1. Regular fossil-based full conversion from CVS to Git exported to GitHub
2. Forked repository regularly updated from upstream
3. Loose fork, updates from wip are merged into joyent/pkgsrc-wip manually