Skip to content

README.md

Latest commit

 

History

History
120 lines (92 loc) · 3.76 KB

README.md

File metadata and controls

120 lines (92 loc) · 3.76 KB
Raw

hop-top/.github

Org-default repo for hop-top. Hosts the publish/mirror layer of the release pipeline: the workflows that run after release-please cuts a tag.

What this is, and is not

This repo is:

  • Reusable GitHub Actions workflows that publish to npm / PyPI / crates.io and push subtree splits to read-only mirror repos
  • Triggered by <component>/v<version> tag pushes
  • Org-level community files (CODE_OF_CONDUCT, SECURITY, CONTRIBUTING)
  • Profile rendered at https://github.com/hop-top

This repo is not:

  • A version manager — release-please does that
  • A changelog generator — release-please does that
  • A release-PR opener — release-please does that
  • A replacement for release-please

The split: release-please owns "from commit to tag"; dotgithub owns "from tag to published package". They compose; you need both.

I want to USE these workflows in my repo

See SKILL.md — quick-start, secrets reference, common pitfalls.

I want to MODIFY these workflows

See DEVELOPING.md — local setup, authoring rules, how to add a new ecosystem, how this repo self-releases.

The pipeline at a glance

flowchart TB
    Dev([Developer])
    Commits[Conventional commits on main]
    Dev --> Commits

    subgraph ReleasePleaseScope ["Consumer-side (release-please)"]
        direction TB
        RP[release-please.yml<br/>opens standing PR]
        PR[chore release X.Y.Z<br/>PR open on main]
        Merge[Merge PR]
        Tag[release-please creates tag<br/>vX.Y.Z]
        RP --> PR --> Merge --> Tag
    end

    Commits --> RP

    Push((git push --tags))
    Tag --> Push

    subgraph DotGithubScope ["dotgithub (this repo)"]
        direction TB
        Router[publish-on-tag.yml<br/>parses tag prefix]
        Router -->|ts/v*| PubTS[publish-ts.yml]
        Router -->|py/v*| PubPY[publish-py.yml]
        Router -->|rs/v*| PubRS[publish-rs.yml]
        Router --> Mirror[mirror-subtree.yml]
    end

    Push --> Router

    PubTS --> NPM[(npm)]
    PubPY --> PyPI[(PyPI)]
    PubRS --> Crates[(crates.io)]
    Mirror --> MirrorRepo[(read-only mirror repo)]
Loading

See docs/architecture.md for full diagrams (router dispatch, secret flow).

Layout

.github/
  workflows/
    publish-on-tag.yml       reusable: router (parses tag → dispatches)
    publish-ts.yml           reusable: npm publish
    publish-py.yml           reusable: PyPI publish (OIDC)
    publish-rs.yml           reusable: crates.io publish
    mirror-subtree.yml       reusable: subtree split + mirror push
    ci.yml                   self-CI: actionlint
    release-please.yml       self-release: opens release PRs
  release-please-config.json self-release config
  .release-please-manifest.json
docs/
  architecture.md            full pipeline diagrams + design rationale
  diagrams/                  Mermaid sources (also embedded inline in docs)
profile/
  README.md                  org-page content
SKILL.md                     consumer-facing how-to
DEVELOPING.md                collaborator-facing how-to
VERSION                      current release-please-managed version

Versioning

This repo is itself released via release-please. Plain semver tags: v0.1.0, v0.1.1, v0.2.0, ..., v1.0.0. Plus rolling major tags (v0, v1, ...) auto-maintained by roll-major-tag.yml.

Consuming repos pin to a rolling major (recommended):

uses: hop-top/.github/.github/workflows/publish-on-tag.yml@v0

Auto-updates on each non-breaking release. Pin @v0.1.0 to freeze exactly, @main to follow everything (breaking changes welcome).

See SKILL.md for the full pinning options and DEVELOPING.md for the release flow.