Manage Github Workflows and Dependabot files as a fleet.
ghconfig is a CLI library to manage Github Workflows and Dependabot files as a fleet.
Managing Workflow and Dependabot files can be in organizations very exhausting because there is no way to apply changes in a batch.
- You need to adjust your compatibility matrix from
13.xto14.xon 50 repositories? - You want to standardize your CI by managing all workflows from a single repository?
In both cases, no data is lost, only updated or added. ghconfig helps you to automate such tasks. You have two options to update your files:
- Strategic two-way merge of your local and remote files.
- Apply a RFC6902 JSON patch on a remote workflow file.
By default a Pull-Request is created for all changes on a repository.
Ghconfig looks for a folder .ghconfig in the root of your repository.
Example: We will create a workflow ci.yaml and apply one patch to an existing workflow release.yml on all repositories in the organization foo.
$ ghconfig sync --query=org:foo
$ ghconfig patch --query=org:foo
.
├── .github
│ └── workflows
│ ├── ci.yaml
│ └── release.yaml
├── .ghconfig
│ ├── workflows
│ │ ├── patches
│ │ │ └── release.yaml
│ │ ├── ci.yaml
│ └── dependabot.md
All other Community Health files like (SUPPORT.md, CONTRIBUTING.md, ISSUE templates) can be managed by a repository called
.githubin the user or organization.
This directory follows the same structure as your .github folder. All files are handled as a Go template and you have access to the full Repository object of the go-github library and to all utility functions of sprig:
Example:
$(( .Repo.GetFullName ))$(( uuidv4 ))
ghconfig syncghconfig patchghconfig sync --no-create-prghconfig sync --query=MyOrganisationghconfig sync --base-branch=masterghconfig sync --root-dir=different-ghconfig-rootghconfig sync --dry-run
-
Adding: Fields present in the local template that are missing from the remote template will be added to the remote template.
-
Updating: Fields present in the local template will be merged recursively until a primitive field is updated, or a field is added. Primitive Values, Maps and string arrays present in the remote template are merged without duplicates.
-
Deleting: Fields present in the remote template that have been removed from the local template will not be deleted from the remote template when the remote template field can be used as fallback. If you want to delete a field permanently you have to delete it first on the remote template. You could apply a JSON-patch to do it.
In all scenarios we try to merge lossless. This is the case for entire Jobs, Steps (with the same
nameoridfield) and Maps, String Arrays.
Ensure that your personal access token is exported with GITHUB_TOKEN.
You can download ghconfig from Github.
We'd love to hear your feedback about ghconfig. If you spot bugs or have features that you'd really like to see in ghconfig, please check out the contributing page.
GitHub imposes a rate limit on all API clients. Unauthenticated clients are limited to 60 requests per hour, while authenticated clients can make up to 5,000 requests per hour. The Search API has a custom rate limit. Unauthenticated clients are limited to 10 requests per minute, while authenticated clients can make up to 30 requests per minute.
This library is being initially developed for an internal application, so features will likely be implemented in the order that they are needed by that application. Feel free to create a feature request.
In general, ghconfig follows semver as closely as we can for tagging releases of the package. For self-contained libraries, the application of semantic versioning is relatively straightforward and generally understood.
This library is distributed under the MIT-style license found in the LICENSE file.
The logo is provided by icons8.de