Lifecycle / state-transition / event diagram for GitHub releases

[rgoldberg]

Select Topic Area

Question

Body

What is the lifecycle / state-transition / event diagram for GitHub releases?

The documentation I've found about this is either vague, tautological, or likely incorrect if you expect it to parse precisely.

It would be preferable to get a link to GitHub official documentation that precisely describes the events / states & the transitions between them. If such documentation doesn't exist, then an explanation in SO will suffice.

I'm looking for something like my fake state transition info at the end of this question.

I've seen the following list of 7 "activities" that appear to be the events:

• created
• edited
• prereleased
• released
• published
• unpublished
• deleted

Are there any additional events?

I've also seen 2 boolean state properties that are relevant to the events:

• draft: true indicates that the release is not (/ is not to be) publicly published
• prerelease: true indicates that the release is not stable (e.g., it's an alpha, beta, rc, etc.)

It seems like, in some circumstances, certain events will fire immediately after other events.

The following is an example of the state transition information that I want. It is just a guess about part of the information, and is likely incorrect, but I'm including it to illustrate the type of info that I want:

Initial State
Description: no release exists
Transitions:
- Create:
  - if draft == true
    - Events:
      - created
    - New State: Draft State
  - else
    - if prerelease == true
      - Events:
        - created
        - published
        - prereleased
      - New State: Published Prerelease State
    - else
      - Events:
        - created
        - published
        - released
      - New State: Published Release State

Published Release State
Description: publicly available stable release
Transitions:
- Unpublish:
  - Events:
    - unpublished
  - Changed Values:
    - draft = true
  - New State: Draft State
- Delete:
  - Events:
    - deleted
  - Changed Values:
    - <all deleted>
  - New State: Initial State

…