README
¶
Backstage catalog importer
A utility to fill the catalog in the Giant Swarm developer portal.
Usage
Requires a Github personal access token (PTA) with permission to read repository content, teams, and user info for the giantswarm organization, provided as GITHUB_TOKEN environment variable.
To run the export, execute
go run main.go [--output output.yaml]
As a result, the file output.yaml in the current directory will provide the catalog content.
What's covered
The following data will be exported/imported into the catalog:
- All repositories referenced in the repositories lists in giantswarm/github as Component entities.
- All teams of the configured Github organizaiton as Group entities.
- All members of the above teams as User entities.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd contains CLI commands.
|
Package cmd contains CLI commands. |
|
pkg
|
|
|
export
Package export takes data from various sources and writes it to a YAML file.
|
Package export takes data from various sources and writes it to a YAML file. |
|
repositories
Package repositories provides types and tools to deal with Giant Swarm's repository configuration data maintained in https://github.com/giantswarm/github/tree/master/repositories
|
Package repositories provides types and tools to deal with Giant Swarm's repository configuration data maintained in https://github.com/giantswarm/github/tree/master/repositories |
Click to show internal directories.
Click to hide internal directories.