Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cvega/gh-migrate-variables
GH CLI extension to assist in the migration of variable between GHEC enterprises
https://github.com/cvega/gh-migrate-variables
gh-extension
Last synced: about 1 month ago
JSON representation
GH CLI extension to assist in the migration of variable between GHEC enterprises
- Host: GitHub
- URL: https://github.com/cvega/gh-migrate-variables
- Owner: cvega
- License: mit
- Created: 2024-11-22T19:01:28.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-22T21:00:49.000Z (about 2 months ago)
- Last Synced: 2024-11-22T21:24:44.499Z (about 2 months ago)
- Topics: gh-extension
- Language: Go
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
- Code of conduct: .github/code_of_conduct.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# gh-migrate-variables
`gh-migrate-variables` is a [GitHub CLI](https://cli.github.com) extension to assist in the migration of variables between GitHub organizations. While [GitHub Enterprise Importer](https://github.com/github/gh-gei) provides excellent features for organization migration, there are gaps when it comes to migrating GitHub Actions variables. This extension aims to fill those gaps. Whether you're consolidating organizations, setting up new environments, or need to replicate variables across organizations, this extension can help.
## Install
```bash
gh extension install mona-actions/gh-migrate-variables
```
## Usage: Export
Export organization-level and repository-level variables to a CSV file.
```bash
Usage:
migrate-variables export [flags]
Flags:
-f, --file-prefix string Output filenames prefix
-h, --help help for export
-n, --hostname string GitHub Enterprise Server hostname URL (optional) Ex. https://github.example.com
-o, --organization string Organization to export (required)
-t, --token string GitHub token (required)
```
### Example Export Command
```bash
gh migrate-variables export \
--organization my-org \
--token ghp_xxxxxxxxxxxx \
--file-prefix my-vars
```
This will create a file named `my-vars_variables.csv` containing all organization and repository variables. The export process provides detailed feedback:
```
📊 Export Summary:
Total repositories found: 25
✅ Successfully processed: 23 repositories
❌ Failed to process: 2 repositories
📝 Total variables exported: 23
📁 Output file: my-vars_variables.csv
```
## Usage: Sync
Recreates variables from a CSV file to a target organization, maintaining visibility settings and scopes.
```bash
Usage:
migrate-variables sync [flags]
Flags:
-f, --file-mapping string CSV mapping file path to use for syncing variables (required)
-h, --help help for sync
-n, --hostname string GitHub Enterprise Server hostname URL (optional) Ex. https://github.example.com
-o, --target-organization string Target Organization to sync variables to (required)
-t, --target-token string Target Organization GitHub token. Scopes: admin:org (required)
```
### Example Sync Command
```bash
gh migrate-variables sync \
--mapping-file my-vars_variables.csv \
--target-organization target-org \
--target-token ghp_xxxxxxxxxxxx
```
The sync process provides detailed feedback:
```
📊 Sync Summary:
Total variables processed: 45
✅ Successfully created: 42
❌ Failed: 2
⚠️ Skipped: 1
```
### Variables CSV Format
The tool exports and imports variables using the following CSV format:
```csv
Name,Value,Scope,Visibility
ORG_VAR,org-value,organization,all
REPO_VAR,repo-value,repository-name,private
```
- `Scope`: Use "organization" for org-level variables, or the repository name for repo-level variables
- `Visibility`: One of "all", "private", or "selected" for org variables; always "private" for repo variables
## Required Permissions
### For Export
- Organization variables: `read:org`
- Repository variables: `repo`
### For Sync
- `admin:org` scope is required for creating organization variables
- `repo` scope is required for creating repository variables
## Proxy Support
The tool supports proxy configuration through both command-line flags and environment variables:
### Command-line flags:
```bash
Global Flags:
--http-proxy string HTTP proxy (can also use HTTP_PROXY env var)
--https-proxy string HTTPS proxy (can also use HTTPS_PROXY env var)
--no-proxy string No proxy list (can also use NO_PROXY env var)
```
```bash
# Example usage with proxy:
gh migrate-variables export \
--organization my-org \
--token ghp_xxxxxxxxxxxx \
--file-prefix my-vars \
--https-proxy https://proxy.example.com:8080
```
### Environment variables:
- `HTTP_PROXY`: Proxy for HTTP requests
- `HTTPS_PROXY`: Proxy for HTTPS requests
- `NO_PROXY`: Comma-separated list of hosts to exclude from proxy
Example with environment variables:
```bash
export HTTPS_PROXY=https://proxy.example.com:8080
export NO_PROXY=github.internal.com
```
```bash
gh migrate-variables export \
--organization my-org \
--token ghp_xxxxxxxxxxxx \
--file-prefix my-vars
```
## Limitations
- Repository-level variables can only be created if the repository exists in the target organization
- Environment-specific variables should be reviewed before syncing to ensure appropriate values
- Repository visibility settings must be considered when setting organization variable visibility
- The tool will retry failed API calls but may still encounter persistent access issues for specific repositories
## License
- [MIT](./license) (c) [Mona-Actions](https://github.com/mona-actions)
- [Contributing](./contributing.md)