Skip to content

hop-top/.github

hop-top/.github

Org-default repo for hop-top. Contains:

  • Reusable workflows consumed by every repo in the org (release, publish, mirror)
  • Composite actions for common one-step jobs (version bumping, tagging)
  • Org-level community files (CODE_OF_CONDUCT, SECURITY, CONTRIBUTING)
  • Profile rendered at https://github.com/hop-top

Release flow

Release flow

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

Consuming a workflow

# in your repo: .github/workflows/publish.yml
on:
  push:
    tags: ['*/v*']

jobs:
  publish:
    uses: hop-top/.github/.github/workflows/publish-on-tag.yml@v1
    secrets: inherit
    with:
      ecosystems: |
        ts:  { dir: ts,  package: "@hop-top/uri", mirror: hop-top/uri-ts }
        py:  { dir: py,  package: hop-top-uri,    mirror: hop-top/uri-py }
        rs:  { dir: rs,  package: hop-top-uri,    mirror: hop-top/uri-rs }
        php: { dir: php, package: hop-top/uri,    mirror: hop-top/uri-php }
        go:  { dir: go,                           mirror: hop-top/uri }

See docs/consuming.md for full reference, docs/architecture.md for control/data flow diagrams.

Versioning

Pin to a major tag (@v1, @v2) for stable consumption. main is the working branch. Breaking changes bump the major tag.

Layout

.github/
  workflows/
    publish-on-tag.yml       reusable: publish + mirror on tag push
    release-please.yml       reusable: PR generation for stable cuts
    mirror-subtree.yml       reusable: subtree split + mirror push
  actions/
    next-prerelease/         composite: compute next prerelease version
    tag-and-push/            composite: commit version, tag, push
  scripts/
    next-version.sh          version computation helper
    tag-prerelease.sh        full cut-a-prerelease helper
docs/
  consuming.md               full input reference
profile/
  README.md                  org-page content

About

No description, website, or topics provided.

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors