Integrate with CI/CD tools

After you obtained the API integration key and completed project and branch creation, next is to seamlessly integrate ArmourZero's AI-powered Code Scan into your GitHub.

Integration guide

1. Go to Code menu and click "Integrate" button.

2. Here you can also able to obtain your API Key by clicking Copy API Key.

3. Follow this video to add Repository Secrets in your GitHub repository.

In your GitHub repository. Click on "Settings" in the top navigation. Navigate to "Secrets" in the left sidebar. Click on "New repository secret", add a secret named AZ_TOKEN with your ArmourZero API key.

4. Create GitHub Actions Configuration File

Create a new file in your repository under the path .github/workflows/az-security-scan.yml and paste the provided configuration.

5. Save and Trigger a Push

Save the changes to the .github/workflows/az-security-scan.yml file. Commit and push the changes to your GitHub repository.

6. Monitor Actions

Go to the "Actions" tab on your GitHub repository. You'll see the status of your workflow. Click on it to view details.

After you obtained the API integration key and completed project and branch creation, next is to seamlessly integrate ArmourZero's AI-powered Code Scan into your GitLab.

Integration guide

1. Go to Code menu and click "Integrate" button.

2. Here you can also able to obtain your API Key by clicking Copy API Key.

3. Follow this video to add CI/CD Variables in your GitLab repository.

In your GitLab repository, go to "Settings" > "CI / CD" > "Variables." Add a variable named AZ_TOKEN with your ArmourZero API key.

4. Create GitLab CI/CD Configuration File

Create a new file in your repository named .gitlab-ci.yml and copy the provided configuration.

5. Commit and Push

Save the changes to the .gitlab-ci.yml file. Commit and push the changes to your GitLab repository.

6. Monitor Pipelines

Go to your GitLab repository. Click on "CI / CD" > "Pipelines." You'll see the status of your pipeline. Click on it to view details.

After you obtained the API integration key and completed project and branch creation, next is to seamlessly integrate ArmourZero's AI-powered Code Scan into your Bitbucket.

Integration guide

1. Go to Code menu and click "Integrate" button.

2. Here you can also able to obtain your API Key by clicking Copy API Key.

3. Follow this video to Enable Pipeline in your Bitbucket repository.

Navigate to your Bitbucket repository and go to "Settings" > "Pipeline" and enable pipelines for your repository.

4. Add Repository Variables

In your Bitbucket repository, go to "Settings" > "Repository Settings" > "Pipelines" and add the required environment variables like AZ_TOKEN.

5. Create a Bitbucket Pipeline Configuration

In the root directory of your project, create a file named bitbucket-pipelines.yml. This file will define your pipeline configuration.

6. Define the Pipeline Configuration

Edit the bitbucket-pipelines.yml file to define your pipeline configuration. Use the provided sample and customise as needed.

7. Commit and Push

Commit the bitbucket-pipelines.yml file and push it to your Bitbucket repository. This will trigger the pipeline.

8. Monitor the Pipeline

In your Bitbucket repository, go to "Pipelines" to monitor the pipeline's progress, view logs, and access build artifacts.

After you obtained the API integration key and completed project and branch creation, next is to seamlessly integrate ArmourZero's AI-powered Code Scan into your CircleCI.

Integration guide

1. Go to Code menu and click "Integrate" button.

2. Here you can also able to obtain your API Key by clicking Copy API Key.

3. Create CircleCI Configuration File

Create a new file in your repository named .circleci/config.yml and paste the provided configuration.

4. Commit and Push

Save the changes to the .circleci/config.yml file. Commit and push the changes to your repository.

5. Follow this video to Add Environment Variables in your CircleCI repository. 

In your CircleCI project settings, go to "Environment Variables." Add a variable named AZ_TOKEN with your ArmourZero API key.

6: Monitor Builds

Go to your CircleCI dashboard. You'll see your project listed with the status of your builds. Click on a build to view details.

After you obtained the API integration key and completed project and branch creation, next is to seamlessly integrate ArmourZero's AI-powered Code Scan into your Azure Pipeline.

Integration guide

1. Go to Code menu and click "Integrate" button.

2. Here you can also able to obtain your API Key by clicking Copy API Key.

3. Create Azure pipeline configuration file

Save your pipeline configuration file into your repo at root folder with filename azure-pipelines.yml and paste the provided configuration

4: Follow this video to Create & configure Pipeline in your Azure Pipeline repository.  

Azure DevOps may automatically detect your project and suggest a pipeline configuration. If not, you can choose a pipeline template or configure it manually.

Choose the repository where your project is hosted (GitHub, Bitbucket, GitLab, etc.).

5. Follow this video to Add Pipeline Variables.

In the pipeline settings, go to the "Variables" section. Add two variables named AZ_TOKEN with your ArmourZero API key.

6. Monitor Builds

Navigate to the "Pipelines" section in Azure DevOps. You'll see your pipeline runs with detailed logs and statuses.

After you obtained the API integration key and completed project and branch creation, next is to seamlessly integrate ArmourZero's AI-powered Code Scan into your Jenkins.

Integration guide

1. Go to Code menu and click "Integrate" button.

2. Here you can also able to obtain your API Key by clicking Copy API Key.

3. Manage Credentials in your Jenkins repository.

Go to your Jenkins portal → Manage Jenkins → Credentials. Select the appropriate domain (usually (global)) where you want to store the credential. Make sure you have admin rights.

4. Follow this video to add Credential in your Jenkins repository.

Add a new credential with:

Kind: Secret text

Secret: your ArmourZero API key

ID: AZ_Token

5. Navigate to Job

Go to your Jenkins portal and create a new Freestyle Job or edit an existing one.

6. Follow this video to Build Environment in your Jenkins repository.

Under Build Environment, check Use secret text(s) or file(s). Bind the credential AZ_TOKEN → to variable name AZ_API_KEY.

6: Follow this video to add Build Steps in your Jenkins repository.

Scroll to the Build section and click Add build step → Execute Shell.

7: Paste build scripts.

Copy the following script into the command box.

8: Save the job and trigger a build.

After you obtained the API integration key and completed project and branch creation, next is to seamlessly integrate ArmourZero's AI-powered Code Scan into your Gitea.

Integration guide

1. Go to Code menu and click "Integrate" button.

2. Here you can also able to obtain your API Key by clicking Copy API Key.

3. Follow this video to add Repository Secrets in your Gitea repository.

Go to your Gitea repository. Click on "Settings" in the top navigation. Then select "Secrets" under the repository's Actions settings. Click "Add Secret" and add a secret named AZ_TOKEN with your ArmourZero API key.

4. Create Gitea Actions Workflow File

Create a new file in your repository under the path .gitea/workflows/az-security-scan.yml and copy the provided configuration below.

5. Save and Trigger a Push

Save the changes to the .gitea/workflows/az-security-scan.yml file. Commit and push the changes to your Gitea repository.

6. Monitor Actions

Go to the "Actions" tab in your Gitea repository. You’ll see the workflow running. Click on it to view detailed logs and job results.