第6章 Installing and configuring the Ansible code bot
The Ansible code bot scans existing content collections, roles, and playbooks hosted in GitHub repositories, and proactively creates pull requests whenever best practices or quality improvement recommendations are available.
Ansible code bot scans your code repositories to recommend code quality improvements. It promotes Ansible best practices while avoiding common errors that can lead to bugs or make code harder to maintain. The bot automatically submits pull requests to the repository, which proactively alerts the repository owner to a recommended change to their content. You can configure Ansible code bot to scan your existing Git repositories (both public and private).
Your organization must have an active subscription to Red Hat Ansible Automation Platform to use the Ansible code bot. However, IBM watsonx Code Assistant is not required to use the Ansible code bot.
After the Ansible code bot is installed, it automatically scans the selected repositories that are in Jinja format. Once the scanning is complete, the code bot generates an initial PR for each repository; the initial PR also contains the scan schedule configured to run weekly. You must review the initial PR for the suggested changes and merge the PR. Once the initial PR is merged, the scan schedule is triggered, and the subsequent repository scans are performed weekly. If required, you can change the scan schedule to a daily or monthly cadence.
You can access the Ansible code bot dashboard that displays all your repositories that have the bot installed along with their scan status. From the dashboard, you can start a manual scan, view the scan history, and view the repository. From GitHub, you can configure a schedule to scan your repository at regular intervals, and add or remove a repository from being scanned. For more information, see Managing repository scans.
Ansible code bot is supported on the following GitHub versions:
- GitHub.com
GitHub Enterprise Cloud
Ansible code bot is not supported on GitHub Enterprise Server. For more information, see GitHub’s plans in the GitHub documentation.
The following examples are code recommendations that the Ansible code bot can suggest:
- Available alternatives for deprecated legacy syntax or implementation patterns
Module version changes and updates, such as:
- Adding any new required parameters
- Flagging deprecated parameters
- Removing unused parameters
- Applying YAML best practices
- Adding comment blocks
- Fixing casing issues in name fields
6.1. Installing the Ansible code bot リンクのコピーリンクがクリップボードにコピーされました!
Install the Ansible code bot to get code recommendations for your repositories, and then log in to the Ansible code bot dashboard to monitor and manage your repository scans.
Procedure
- Log in to GitHub by using the account associated with your organization.
- Go to the Ansible code bot GitHub app.
Select the Ansible repositories that you want the app to access:
- All repositories: Provides access to read the metadata of all repositories.
- Only select repositories: Provides access to read the metadata of only the repositories that you select.
- Optional: If you selected Only select repositories in the previous step, select the repositories that you want the Ansible code bot to access from the Select repositories list.
Click Install & Authorize. A message is displayed that specifies the following permissions are granted automatically to the bot during installation:
- Read access to metadata
- Read and write access to code and pull requests
- When prompted, log in to your Red Hat Single Sign-On account as an organization administrator.
Log in to the Ansible code bot dashboard:
- On the Authorize Ansible code bot page, verify your account and repository permissions.
Click Authorize Ansible.
From the Authorize Ansible code bot page, the following actions occur:
- Ansible code bot verifies that you are a part of an organization that has an active subscription to Red Hat Ansible Automation Platform.
GitHub requests read permissions to access the repositories associated with your account.
On successful authorization, you are logged in to Ansible code bot dashboard. The dashboard displays all your repositories that have the Ansible code bot installed along with their scan status.
Verification
After the Ansible code bot is installed, it automatically scans the selected repositories that are in Jinja format. When the scanning is complete, the code bot generates an initial PR for each repository; the initial PR also contains the scan schedule configured to run weekly.
Perform the following tasks:
Review the initial PR for the suggested changes, and merge the PR.
After you merge the initial PR, the configured scan schedule is triggered, and the subsequent repository scans are performed weekly.
注記If you do not merge the initial PR, the weekly scan schedule is not triggered and the Ansible code bot dashboard displays the repositories without any associated scan history.
The following illustration is an example of an initial PR being created:
- Optional: If required, you can manually scan your repositories or change the scan schedule to a daily or monthly cadence.
- Modify scanned repositories by adding repositories or removing existing repositories from being scanned.