actions/importer-issue-ops
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update branding

Browse Source
This commit is contained in:
Ethan Dennis
2022-11-02 21:24:43 -07:00
parent 1d18b28f35
commit 809a054f97
10 changed files with 58 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Readme.md
+19 -19
View File
@@ -1,31 +1,29 @@
# Valet Issue Ops
# GitHub Actions Importer IssueOps
The Valet IssueOps template repository provides the functionality necessary to run Valet commands through GitHub Actions and Issues, allowing you to migrate your CI/CD workflows without needing to install software on your local machine. This approach is especially useful for organizations that want to enable self-service migrations to GitHub Actions.
The GitHub Actions Importer IssueOps repository demonstrates the functionality necessary to run GitHub Actions Importer commands through Actions and Issues, allowing you to migrate your CI/CD workflows without needing to install software on your local machine. This approach is especially useful for organizations that want to enable self-service migrations to GitHub Actions.
Valet helps facilitate the migration of Azure DevOps, Circle CI, GitLab CI, Jenkins, and Travis CI pipelines to GitHub Actions. Valet is distributed as a CLI and offers three commands you can use to migrate pipelines:
GitHub Actions Importer helps plan and automate the migration of Azure DevOps, circleci, GitLab, Jenkins, and Travis CI pipelines to GitHub Actions. GitHub Actions Importer is distributed as a CLI and offers various commands you can use to migrate pipelines:
- `audit`: An audit will fetch all the pipelines defined in an existing CI server, convert each pipeline to its equivalent in GitHub Actions, and write a report that summarizes how complete of a migration Valet can provide.
- `audit`: An audit will fetch all the pipelines defined in an existing CI server, convert each pipeline to its equivalent in GitHub Actions, and write a report that summarizes how complete of a migration the GitHub Actions Importer can provide.
- `dry-run`: A dry run will fetch a single pipeline definition, convert it to its equivalent in GitHub Actions, and write a file (or files) to disk containing the converted workflow.
- `migrate`: A migration will fetch a single pipeline definition, convert it to its equivalent in GitHub Actions, and open a pull request to a repository with the converted workflow.
> Because Valet is in private preview, customers must be onboarded prior to using the Valet IssueOps workflow. Please reach out to GitHub Sales to inquire about being added to the private preview.
**Note**: You can request support by using [this](https://github.com/valet-customers/issue-ops/issues/new?assignees=&labels=support&template=support.md&title=) template to create an issue. The Valet team responds to support requests Monday through Friday between the hours of 9AM EST and 5PM PST.
> **Note**: GitHub Actions Importer is currently available as a public preview. Visit the [sign up page](https://github.com/features/actions-importer/signup) to request access to the preview.
## Getting started
Complete the following steps:
1. Create a new repository using this repository as the template by clicking [here](https://github.com/valet-customers/issue-ops/generate).
2. Create the following labels in this new repository: `jenkins`, `azure-devops`, `circle-ci`, `gitlab`, `travis-ci`, and `valet-running`.
1. Create a new repository using this repository as the template by clicking [here](https://github.com/actions/importer-issue-ops/generate).
2. Create the following labels in this new repository: `jenkins`, `azure-devops`, `circle-ci`, `gitlab`, `travis-ci`, and `actions-importer-running`.
3. Add the repository secrets described below that are relevant to the CI/CD providers being migrated:
### All CI/CD providers
The following secrets are required:
- `VALET_GHCR_USERNAME`: The username to access the `valet` container.
- `VALET_GHCR_PASSWORD`: The password to access the `valet` container (requires `read:packages` scope).
- `GHCR_USERNAME`: The username to access the GitHub Actions Importer container.
- `GHCR_PASSWORD`: The password to access the GitHub Actions Importer container (requires `read:packages` scope).
- `GH_ACCESS_TOKEN`: GitHub personal access token to create pull requests (requires `repo` and `workflow` scopes).
Optionally, the following environment variables can be set:
@@ -37,36 +35,38 @@ Optionally, the following environment variables can be set:
The following secrets are required:
- `AZURE_DEVOPS_ACCESS_TOKEN`: The personal access token to access the Azure DevOps instance. This token requires the following scopes:
- Build (Read & Execute)
- Build (Read)
- Agent Pools (Read)
- Code (Read)
- Release (Read)
- Service Connections (Read)
- Task Groups (Read)
- Variable Groups (Read)
Optionally, the following environment variables can be set:
- `AZURE_DEVOPS_INSTANCE_URL`: The base URL of your Azure DevOps instance (only required if it is **not** <https://dev.azure.com>).
### Circle CI
### CircleCI
The following secrets are required:
- `CIRCLE_CI_ACCESS_TOKEN`: The personal access token to access the Circle CI instance.
- `CIRCLE_CI_ACCESS_TOKEN`: The personal access token to access the CircleCI instance.
- `CIRCLE_CI_SOURCE_GITHUB_ACCESS_TOKEN`: The personal access token to access pipeline files stored in GitHub.
Optionally, the following environment variables can be set:
- `CIRCLE_CI_INSTANCE_URL`: The base URL of your Circle CI instance (only required if it is **not** <https://circleci.com>).
- `CIRCLE_CI_INSTANCE_URL`: The base URL of your CircleCI instance (only required if it is **not** <https://circleci.com>).
### GitLab CI
### GitLab
The following secrets are required:
- `GITLAB_ACCESS_TOKEN`: The personal access token to access the GitLab CI instance (requires `read_api` scope).
- `GITLAB_ACCESS_TOKEN`: The personal access token to access the GitLab instance (requires `read_api` scope).
Optionally, the following environment variables can be set:
- `GITLAB_INSTANCE_URL`: The base URL of your GitLab CI instance (only required if it is **not** <https://gitlab.com>).
- `GITLAB_INSTANCE_URL`: The base URL of your GitLab instance (only required if it is **not** <https://gitlab.com>).
### Jenkins
@@ -97,6 +97,6 @@ Once configured, pipelines can be migrated to GitHub Actions by opening an issue
## Privacy statement
Valet will collect anonymous telemetry when running to help us improve the tool. This can be disabled by adding the `--no-telemetry` flag to any command provided to the Valet CLI.
GitHub Actions Importer will collect anonymous telemetry when running to help us improve the tool. This can be disabled by adding the `--no-telemetry` flag to any command provided to the GitHub Actions Importer CLI.
Additionally, by using this repository you agree to GitHub's [Privacy Statement](https://docs.github.com/en/site-policy/privacy-policies/github-privacy-statement#data-retention-and-deletion-of-data) and the [additional terms for Actions](https://docs.github.com/en/site-policy/github-terms/github-terms-for-additional-products-and-features#actions).