2022-09-15 15:36:02 -07:00
# Perform an audit of CircleCI
In this lab, you will use the `audit` command to get a high-level view of all projects in a Travis CI organization.
2022-09-16 12:31:27 -07:00
The `audit` command operates by performing the following:
2022-09-16 13:25:05 -07:00
2022-09-16 12:31:27 -07:00
- Fetching all of the projects defined in a Travis CI organization.
- Converting each to their equivalent GitHub Actions workflow.
2022-11-03 12:47:40 -07:00
- Generating a report that summarizes how complete and complex of a migration is possible with GitHub Actions Importer.
2022-09-15 15:36:02 -07:00
## Prerequisites
1. Followed the steps [here ](./readme.md#configure-your-codespace ) to set up your Codespace environment.
2022-11-03 12:47:40 -07:00
2. Completed the [configure lab ](./1-configure.md ).
2022-09-15 15:36:02 -07:00
## Perform an audit
2022-11-03 12:47:40 -07:00
You will be performing an audit against the **actions-importer-labs** Travis CI organization that was created for the purposes of this lab. Your environment was configured to use this organization during the [configure lab ](./1-configure.md ). The remaining information needed to perform an `audit` is:
2022-09-15 15:36:02 -07:00
1. Where do we want to store the result?
2022-11-03 12:47:40 -07:00
- **tmp/audit**. This can be any path within the working directory that GitHub Actions Importer commands are executed from.
2022-09-15 15:36:02 -07:00
### Steps
1. Navigate to the codespace terminal.
2. Run the following command from the root directory:
```bash
2022-11-02 21:02:30 -07:00
gh actions-importer audit travis-ci --output-dir tmp/audit
2022-09-15 15:36:02 -07:00
` ``
3. The command will list all the files written to disk in green when the command succeeds.
## Inspect the output files
1. Find the ` audit_summary.md` file in the file explorer.
2. Right-click the ` audit_summary.md` file and select ` Open Preview`.
3. This file contains details that summarizes what percentage of your pipelines were converted automatically.
### Review audit summary
#### Pipelines
2022-11-03 12:47:40 -07:00
The pipeline summary section contains high level statistics regarding the conversion rate done by GitHub Actions Importer:
2022-09-15 15:36:02 -07:00
` ``md
# Audit summary
2022-11-03 12:47:40 -07:00
Summary for [Travis CI instance](https://travis-ci.com/actions-importer-labs)
2022-09-15 15:36:02 -07:00
2022-11-03 12:47:40 -07:00
- GitHub Actions Importer version: **0.1.0.13539 (5bb6c723d6db3688ea0653e14bbf3c63df445bfc)**
2022-09-16 13:25:05 -07:00
- Performed at: **9/16/22 at 20:01**
2022-09-15 15:36:02 -07:00
## Pipelines
2022-09-16 13:25:05 -07:00
Total: **5**
2022-09-15 15:36:02 -07:00
- Successful: **0 (0%)**
2022-09-16 13:25:05 -07:00
- Partially successful: **5 (100%)**
2022-09-15 15:36:02 -07:00
- Unsupported: **0 (0%)**
- Failed: **0 (0%)**
### Job types
2022-09-16 13:25:05 -07:00
Supported: **5 (100%)**
2022-09-15 15:36:02 -07:00
- php: **1**
2022-09-16 13:25:05 -07:00
- nodejs: **1**
- ruby: **2**
2022-09-15 15:36:02 -07:00
- python: **1**
### Build steps
2022-09-16 13:25:05 -07:00
Total: **25**
2022-09-15 15:36:02 -07:00
2022-09-16 13:25:05 -07:00
Known: **22 (88%)**
2022-09-15 15:36:02 -07:00
- install: **6**
2022-09-16 13:25:05 -07:00
- script: **5**
2022-09-15 15:36:02 -07:00
- before_script: **3**
- rvm: **2**
- after_deploy: **2**
- pushover: **1**
2022-09-16 13:25:05 -07:00
- irc: **1**
2022-09-15 15:36:02 -07:00
- before_deploy: **1**
- php: **1**
2022-09-16 13:25:05 -07:00
Unknown: **1 (4%)**
2022-09-15 15:36:02 -07:00
- codedeploy: **1**
2022-09-16 13:25:05 -07:00
Unsupported: **2 (8%)**
2022-09-15 15:36:02 -07:00
- sudo: **2**
2022-09-16 13:25:05 -07:00
Actions: **28**
2022-09-15 15:36:02 -07:00
2022-09-16 13:25:05 -07:00
- run: **17**
- actions/checkout@v2: **6**
2022-09-15 15:36:02 -07:00
- ruby/setup-ruby@v1: **2**
- rectalogic/notify-irc@v1: **1**
2022-09-16 13:25:05 -07:00
- shivammathur/setup-php@v2: **1**
- desiderati/github-action-pushover@v1: **1**
2022-09-15 15:36:02 -07:00
### Triggers
2022-09-16 13:25:05 -07:00
Total: **30**
2022-09-15 15:36:02 -07:00
2022-09-16 13:25:05 -07:00
Known: **30 (100%)**
2022-09-15 15:36:02 -07:00
2022-09-16 13:25:05 -07:00
- crons: **5**
- branches: **5**
- config_validation: **5**
- build_pull_requests: **5**
- build_pushes: **5**
- builds_only_with_travis_yml: **5**
2022-09-15 15:36:02 -07:00
2022-09-16 13:25:05 -07:00
Actions: **10**
2022-09-15 15:36:02 -07:00
2022-09-16 13:25:05 -07:00
- pull_request: **5**
- push: **5**
2022-09-15 15:36:02 -07:00
### Environment
Total: **1**
Known: **1 (100%)**
- DB: **1**
Actions: **1**
- DB: **1**
### Other
2022-09-16 13:25:05 -07:00
Total: **15**
2022-09-15 15:36:02 -07:00
2022-09-16 13:25:05 -07:00
Known: **10 (66%)**
2022-09-15 15:36:02 -07:00
2022-09-16 13:25:05 -07:00
- auto_cancel_pull_requests: **5**
- auto_cancel_pushes: **5**
2022-09-15 15:36:02 -07:00
2022-09-16 13:25:05 -07:00
Unknown: **5 (33%)**
2022-09-15 15:36:02 -07:00
2022-09-16 13:25:05 -07:00
- maximum_number_of_builds: **5**
2022-09-15 15:36:02 -07:00
Actions: **3**
- matrix: **2**
- DB: **1**
### Manual tasks
Total: **1**
Secrets: **1**
- ` ${{ secrets.PUSHOVER_USER_KEY }}`: **1**
### Partially successful
2022-11-03 12:47:40 -07:00
#### actions-importer-labs/travisci-php-example
2022-09-15 15:36:02 -07:00
2022-11-03 12:47:40 -07:00
- [actions-importer-labs/travisci-php-example/.github/workflows/travisci-php-example.yml](actions-importer-labs/travisci-php-example/.github/workflows/travisci-php-example.yml)
- [actions-importer-labs/travisci-php-example/config.json](actions-importer-labs/travisci-php-example/config.json)
- [actions-importer-labs/travisci-php-example/source.yml](actions-importer-labs/travisci-php-example/source.yml)
2022-09-15 15:36:02 -07:00
2022-11-03 12:47:40 -07:00
#### actions-importer-labs/travisci-nodejs-example
2022-09-15 15:36:02 -07:00
2022-11-03 12:47:40 -07:00
- [actions-importer-labs/travisci-nodejs-example/.github/workflows/travisci-nodejs-example.yml](actions-importer-labs/travisci-nodejs-example/.github/workflows/travisci-nodejs-example.yml)
- [actions-importer-labs/travisci-nodejs-example/config.json](actions-importer-labs/travisci-nodejs-example/config.json)
- [actions-importer-labs/travisci-nodejs-example/source.yml](actions-importer-labs/travisci-nodejs-example/source.yml)
2022-09-15 15:36:02 -07:00
2022-11-03 12:47:40 -07:00
#### actions-importer-labs/travisci-ruby-example
2022-09-15 15:36:02 -07:00
2022-11-03 12:47:40 -07:00
- [actions-importer-labs/travisci-ruby-example/.github/workflows/travisci-ruby-example.yml](actions-importer-labs/travisci-ruby-example/.github/workflows/travisci-ruby-example.yml)
- [actions-importer-labs/travisci-ruby-example/config.json](actions-importer-labs/travisci-ruby-example/config.json)
- [actions-importer-labs/travisci-ruby-example/source.yml](actions-importer-labs/travisci-ruby-example/source.yml)
2022-09-15 15:36:02 -07:00
2022-11-03 12:47:40 -07:00
#### actions-importer-labs/travisci-python-example
2022-09-15 15:36:02 -07:00
2022-11-03 12:47:40 -07:00
- [actions-importer-labs/travisci-python-example/.github/workflows/travisci-python-example.yml](actions-importer-labs/travisci-python-example/.github/workflows/travisci-python-example.yml)
- [actions-importer-labs/travisci-python-example/config.json](actions-importer-labs/travisci-python-example/config.json)
- [actions-importer-labs/travisci-python-example/source.yml](actions-importer-labs/travisci-python-example/source.yml)
2022-09-15 15:36:02 -07:00
2022-11-03 12:47:40 -07:00
#### actions-importer-labs/travisci-deploy-example
2022-09-15 15:36:02 -07:00
2022-11-03 12:47:40 -07:00
- [actions-importer-labs/travisci-deploy-example/.github/workflows/travisci-deploy-example.yml](actions-importer-labs/travisci-deploy-example/.github/workflows/travisci-deploy-example.yml)
- [actions-importer-labs/travisci-deploy-example/config.json](actions-importer-labs/travisci-deploy-example/config.json)
- [actions-importer-labs/travisci-deploy-example/source.yml](actions-importer-labs/travisci-deploy-example/source.yml)
2022-09-15 15:36:02 -07:00
` ``
Here are some key terms that can appear in the “Pipelines” section:
- **Successful** pipelines had 0% of the pipeline constructs and individual items converted automatically to their GitHub Actions equivalent.
- **Partially successful** pipelines had 100% of all of the pipeline constructs converted, however, there were some individual items that were not converted automatically to their GitHub Actions equivalent.
- **Failed pipelines** encountered a fatal error when being converted. This can occur for one of three reasons:
- The pipeline was misconfigured and not valid in Travis CI.
2022-11-03 12:47:40 -07:00
- GitHub Actions Importer encountered an internal error when converting it.
2022-09-15 15:36:02 -07:00
- There was an unsuccessful network response, often due to invalid credentials, that caused the pipeline to be inaccessible.
2022-11-03 12:47:40 -07:00
The "Job types" section will summarize which types of pipelines are being used and which are supported or unsupported by GitHub Actions Importer.
2022-09-15 15:36:02 -07:00
#### Build steps
2022-11-03 12:47:40 -07:00
The build steps summary section presents an overview of the individual build steps that are used across all pipelines and how many were automatically converted by GitHub Actions Importer.
2022-09-15 15:36:02 -07:00
` ``md
2022-09-16 13:25:05 -07:00
Total: **25**
2022-09-15 15:36:02 -07:00
2022-09-16 13:25:05 -07:00
Known: **22 (88%)**
2022-09-15 15:36:02 -07:00
- install: **6**
2022-09-16 13:25:05 -07:00
- script: **5**
2022-09-15 15:36:02 -07:00
- before_script: **3**
- rvm: **2**
- after_deploy: **2**
- pushover: **1**
2022-09-16 13:25:05 -07:00
- irc: **1**
2022-09-15 15:36:02 -07:00
- before_deploy: **1**
- php: **1**
2022-09-16 13:25:05 -07:00
Unknown: **1 (4%)**
2022-09-15 15:36:02 -07:00
- codedeploy: **1**
2022-09-16 13:25:05 -07:00
Unsupported: **2 (8%)**
2022-09-15 15:36:02 -07:00
- sudo: **2**
2022-09-16 13:25:05 -07:00
Actions: **28**
2022-09-15 15:36:02 -07:00
2022-09-16 13:25:05 -07:00
- run: **17**
- actions/checkout@v2: **6**
2022-09-15 15:36:02 -07:00
- ruby/setup-ruby@v1: **2**
- rectalogic/notify-irc@v1: **1**
2022-09-16 13:25:05 -07:00
- shivammathur/setup-php@v2: **1**
- desiderati/github-action-pushover@v1: **1**
2022-09-15 15:36:02 -07:00
` ``
Here are some key terms that can appear in "Build steps" section:
- A **known** build step is a step that was automatically converted to an equivalent action.
- An **unknown** build step is a step that was not automatically converted to an equivalent action.
- An **unsupported** build step is a step that is either:
- A step that is fundamentally not supported by GitHub Actions.
- A step that is configured in a way that is incompatible with GitHub Actions.
- An **action** is a list of the actions that were used in the converted workflows. This is important for the following scenarios:
- Gathering the list of actions to sync to your appliance if you use GitHub Enterprise Server.
- Defining an organization-level allowlist of actions that can be used. This list of actions is a comprehensive list of which actions their security and/or compliance teams will need to review.
There is an equivalent breakdown of build triggers, environment variables, and other uncategorized items displayed in the audit summary file.
#### Manual Tasks
2022-11-03 12:47:40 -07:00
The manual tasks summary section presents an overview of the manual tasks that you will need to perform that GitHub Actions Importer is not able to complete automatically.
2022-09-15 15:36:02 -07:00
` ``md
### Manual tasks
Total: **1**
Secrets: **1**
- ` ${{ secrets.PUSHOVER_USER_KEY }}`: **1**
` ``
Here are some key terms that can appear in “Manual tasks” section:
- A **secret** refers to a repository or organization level secret that is used by the converted pipelines. These secrets will need to be created manually in Actions in order for these pipelines to function properly.
- A **self-hosted runner** refers to a label of a runner that is referenced by a converted pipeline that is not a GitHub-hosted runner. You will need to manually define these runners in order for these pipelines to function properly.
#### Files
The final section of the audit report provides a manifest of all of the files that are written to disk during the audit. These files include:
` ``md
### Partially successful
2022-11-03 12:47:40 -07:00
#### actions-importer-labs/travisci-php-example
2022-09-15 15:36:02 -07:00
2022-11-03 12:47:40 -07:00
- [actions-importer-labs/travisci-php-example/.github/workflows/travisci-php-example.yml](actions-importer-labs/travisci-php-example/.github/workflows/travisci-php-example.yml)
- [actions-importer-labs/travisci-php-example/config.json](actions-importer-labs/travisci-php-example/config.json)
- [actions-importer-labs/travisci-php-example/source.yml](actions-importer-labs/travisci-php-example/source.yml)
2022-09-15 15:36:02 -07:00
2022-11-03 12:47:40 -07:00
#### actions-importer-labs/travisci-nodejs-example
2022-09-15 15:36:02 -07:00
2022-11-03 12:47:40 -07:00
- [actions-importer-labs/travisci-nodejs-example/.github/workflows/travisci-nodejs-example.yml](actions-importer-labs/travisci-nodejs-example/.github/workflows/travisci-nodejs-example.yml)
- [actions-importer-labs/travisci-nodejs-example/config.json](actions-importer-labs/travisci-nodejs-example/config.json)
- [actions-importer-labs/travisci-nodejs-example/source.yml](actions-importer-labs/travisci-nodejs-example/source.yml)
2022-09-15 15:36:02 -07:00
2022-11-03 12:47:40 -07:00
#### actions-importer-labs/travisci-ruby-example
2022-09-15 15:36:02 -07:00
2022-11-03 12:47:40 -07:00
- [actions-importer-labs/travisci-ruby-example/.github/workflows/travisci-ruby-example.yml](actions-importer-labs/travisci-ruby-example/.github/workflows/travisci-ruby-example.yml)
- [actions-importer-labs/travisci-ruby-example/config.json](actions-importer-labs/travisci-ruby-example/config.json)
- [actions-importer-labs/travisci-ruby-example/source.yml](actions-importer-labs/travisci-ruby-example/source.yml)
2022-09-15 15:36:02 -07:00
2022-11-03 12:47:40 -07:00
#### actions-importer-labs/travisci-python-example
2022-09-15 15:36:02 -07:00
2022-11-03 12:47:40 -07:00
- [actions-importer-labs/travisci-python-example/.github/workflows/travisci-python-example.yml](actions-importer-labs/travisci-python-example/.github/workflows/travisci-python-example.yml)
- [actions-importer-labs/travisci-python-example/config.json](actions-importer-labs/travisci-python-example/config.json)
- [actions-importer-labs/travisci-python-example/source.yml](actions-importer-labs/travisci-python-example/source.yml)
2022-09-15 15:36:02 -07:00
2022-11-03 12:47:40 -07:00
#### actions-importer-labs/travisci-deploy-example
2022-09-15 15:36:02 -07:00
2022-11-03 12:47:40 -07:00
- [actions-importer-labs/travisci-deploy-example/.github/workflows/travisci-deploy-example.yml](actions-importer-labs/travisci-deploy-example/.github/workflows/travisci-deploy-example.yml)
- [actions-importer-labs/travisci-deploy-example/config.json](actions-importer-labs/travisci-deploy-example/config.json)
- [actions-importer-labs/travisci-deploy-example/source.yml](actions-importer-labs/travisci-deploy-example/source.yml)
2022-09-15 15:36:02 -07:00
` ``
Each pipeline will have a variety of files written that include:
- The original pipeline as it was defined in GitHub.
- Any network responses used to convert a pipeline.
- The converted workflow.
- Stack traces that can used to troubleshoot a failed pipeline conversion
2022-09-20 15:01:34 -07:00
## Inspect the workflow usage csv file
1. Open the ` tmp/audit/workflow_usage.csv` file in the file explorer.
2. This file contains a comma-separated list of all actions, secrets, and runners that are used by each successfully converted pipeline:
` ``csv
Pipeline,Action,File path
2022-11-03 12:47:40 -07:00
actions-importer-labs/travisci-php-example,actions/checkout@v2,tmp/audit/actions-importer-labs/travisci-php-example/.github/workflows/travisci-php-example.yml
actions-importer-labs/travisci-php-example,shivammathur/setup-php@v2,tmp/audit/actions-importer-labs/travisci-php-example/.github/workflows/travisci-php-example.yml
actions-importer-labs/travisci-php-example,rectalogic/notify-irc@v1,tmp/audit/actions-importer-labs/travisci-php-example/.github/workflows/travisci-php-example.yml
actions-importer-labs/travisci-nodejs-example,actions/checkout@v2,tmp/audit/actions-importer-labs/travisci-nodejs-example/.github/workflows/travisci-nodejs-example.yml
actions-importer-labs/travisci-ruby-example,actions/checkout@v2,tmp/audit/actions-importer-labs/travisci-ruby-example/.github/workflows/travisci-ruby-example.yml
actions-importer-labs/travisci-ruby-example,ruby/setup-ruby@v1,tmp/audit/actions-importer-labs/travisci-ruby-example/.github/workflows/travisci-ruby-example.yml
actions-importer-labs/travisci-python-example,actions/checkout@v2,tmp/audit/actions-importer-labs/travisci-python-example/.github/workflows/travisci-python-example.yml
actions-importer-labs/travisci-deploy-example,actions/checkout@v2,tmp/audit/actions-importer-labs/travisci-deploy-example/.github/workflows/travisci-deploy-example.yml
actions-importer-labs/travisci-deploy-example,desiderati/github-action-pushover@v1,tmp/audit/actions-importer-labs/travisci-deploy-example/.github/workflows/travisci-deploy-example.yml
2022-09-20 15:01:34 -07:00
Pipeline,Secret,File path
2022-11-03 12:47:40 -07:00
actions-importer-labs/travisci-deploy-example,${{ secrets.PUSHOVER_USER_KEY }},tmp/audit/actions-importer-labs/travisci-deploy-example/.github/workflows/travisci-deploy-example.yml
2022-09-20 15:01:34 -07:00
Pipeline,Runner,File path
` ``
2022-09-20 15:26:39 -07:00
The contents of this file can be useful in answering questions similar to the following:
2022-11-03 12:47:40 -07:00
2022-09-20 15:26:39 -07:00
- What workflows will depend on which actions?
- What workflows use an action that must go through a security review?
- What workflows use specific secrets?
- What workflows use specific runners?
2022-09-20 15:01:34 -07:00
2022-09-15 15:36:02 -07:00
### Next lab
2022-09-16 13:54:58 -07:00
[Forecast potential build runner usage ](3-forecast.md )
