Helpful project certification process

[psprings]

Project Pipeline process proposal

New project

A project team has registered with Helpful and needs a new repository.

sequenceDiagram
    participant Project Team
    participant Helpful
    participant Project GH Repo
    Project Team->>Helpful: registers a new project
    Helpful->>Project GH Repo: creates repo from template
    Project GH Repo-->>Helpful: url returned
    Helpful->>Project Team: maintainer access to repository provided

Loading

Project team file submission

A project team is ready to submit design files, documentation, and assets.

sequenceDiagram
    participant Project Team
    participant Helpful
    participant Project GH Repo
    participant GitHub Action
    Project Team->>Project GH Repo: push code to feature branch
    Project GH Repo->>Project GH Repo: Pull Request created
    Project GH Repo->>GitHub Action: trigger PR webhook
    GitHub Action->>Project GH Repo: return status checks
    Project GH Repo->>Project GH Repo: Pull Request merged
    Project GH Repo->>GitHub Action: trigger merge webhook
    GitHub Action->>Project GH Repo: tag version and return status checks
    Project GH Repo-->>Project Team: display status checks

Loading

Project team Alpha release

sequenceDiagram
    participant Project Team
    participant Helpful
    participant Project GH Repo
    participant GitHub Action
    participant Helpful GH Organization
    participant Event Bus
    participant Function
    participant S3
    participant IPFS Node
    Project Team->>Project GH Repo: verify and create pre-release for tag
    Project GH Repo->>Helpful GH Organization: notify of pre-release
    Helpful GH Organization->>Event Bus: notify of project pre-release
    Event Bus->>Function: notify of project pre-release
    Function->>Project GH Repo: request repository at pre-release version
    Project GH Repo-->>Function: Return files
    Function->>Function: get unique IPFS CID for files
    Function->>S3: upload repository
    S3->>Function: acknowledge
    Function->>IPFS Node: add to IPFS
    IPFS Node->>Function: return IPFS hash acknowledgement
    Function->>Function: gpg sign repo tarball with alpha key
    Function->>Project GH Repo: upload signed assets to pre-release
    Project GH Repo-->>Function: acknowledge success
    Function->>Event Bus: notify of signed pre-release with IPFS CID
    Event Bus->>Helpful: notify of completed pre-release
    Helpful->>Helpful: initial validation
    Helpful->>Project Team: feedback provided

Loading

Project team Beta release

IN PROGRESS

[Jbutler-helpful]

Points

1. this doesn't take into account project-data's Atomization as represented in OKF Schema's

2. This doesn't explicitly talk about its relationship with the Library File Structure
   a. Alpha
   b. Beta
   C. Stable

3. This doesn't explicitly talk about its relationship to the pipeline
   A. Ideation
   B. Project Selection
   B. Interim Design Review
   C. Final Design Review

Note: given the current structure of the Library where do Ideation Project live? In a repo?

[psprings]

Reference to more recent proposals and discussion here: helpfulengineering/library#49

Will comment on that with some thoughts with respect to OCI and useful tooling.