@ryanatkn/fuz_gitops

0.25.0 • Public • Published

fuz_gitops

a tool for managing many repos 🪄 gitops.fuz.dev

fuz_gitops is alternative to the monorepo pattern that more loosely couples repos:

  • enables automations across repos without requiring them to be in the same monorepo
  • allows each repo to be managed from multiple fuz_gitops projects
  • runs automations locally on your machine, giving you full control and visibility (big tradeoffs in both directions compared to GitHub actions)

With fuz_gitops you can:

  • fetch metadata about collections of deployments and import it as typesafe JSON (using Gro's public package patterns)
  • publish a generated docs website for your collections of deployments
  • import its components to view and interact with deployment collection metadata
  • publish metadata about your collections of deployments to the web for other users and tools

planned additions:

  • run updating operations and other workflows from the frontend in dev mode (ultimately, an update all button)

Usage

npm i -D @ryanatkn/fuz_gitops
  • configure fuz.config.ts
  • fuz_gitops calls the GitHub API using the environment variable GITHUB_TOKEN_SECRET for authorization, which is a GitHub token (with "public access" for public repos, no options selected) in either process.env, a project-local .env, or the parent directory at ../.env (currently optional to read public repos, but it's recommended regardless, and you'll need to select options to support private repos)
  • re-export the gro gitops task by creating $lib/gitops.task.ts with the contents export * from '@ryanatkn/fuz_gitops/gitops.task.js';
  • run gro gitops to update the local data

Getting started as a dev? Start with Gro and the Fuz template.

TODO

  • figure out better automation than manually running gro gitops
  • show the rate limit info
  • think about how fuz_gitops could better leverage both GitHub Actions and Forgejo Actions without unwieldy compat

License 🐦

MIT

Readme

Keywords

none

Package Sidebar

Install

npm i @ryanatkn/fuz_gitops

Weekly Downloads

7

Version

0.25.0

License

MIT

Unpacked Size

147 kB

Total Files

45

Last publish

Collaborators

  • ryanatkn