Skip to content

Commit

Permalink
Update skeleton description to describe the periodic collapse. Fixes #27
Browse files Browse the repository at this point in the history
.
  • Loading branch information
jaraco committed Dec 13, 2020
1 parent c681f67 commit 2667241
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions skeleton.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,26 @@ For example, here's a session of the [path project](https://pypi.org/project/pat

Thereafter, the target project can make whatever customizations it deems relevant to the scaffolding. The project may even at some point decide that the divergence is too great to merit renewed merging with the original skeleton. This approach applies maximal guidance while creating minimal constraints.

## Periodic Collapse

In late 2020, this project [introduced](https://github.com/jaraco/skeleton/issues/27) the idea of a periodic but infrequent (O(years)) collapse of commits to limit the number of commits a new consumer will need to accept to adopt the skeleton.

The full history of commits is collapsed into a single commit and that commit becomes the new mainline head.

When one of these collapse operations happens, any project that previously pulled from the skeleton will no longer have a related history with that new main branch. For those projects, the skeleton provides a "handoff" branch that reconciles the two branches. Any project that has previously merged with the skeleton but now gets an error "fatal: refusing to merge unrelated histories" should instead use the handoff branch once to incorporate the new main branch.

```
$ git pull https://github.com/jaraco/skeleton 2020-handoff
```

This handoff needs to be pulled just once and thereafter the project can pull from the main head.

The archive and handoff branches from prior collapses are indicate here:

| refresh | archive | handoff |
|---------|-----------------|--------------|
| 2020-12 | archive/2020-12 | 2020-handoff |

# Features

The features/techniques employed by the skeleton include:
Expand Down

0 comments on commit 2667241

Please sign in to comment.