Circle CI Configuration

Prerequisites:

CircleCi should have been integrated with GitHub. Refer to https://circleci.com/docs/introduction-to-yaml-configurations/ for more information.
The config.ymlconfig.yml file should have been created in circleci in main branch of in GitHub. The file should have been granted the “Read and write permissions” under Settings in GitHub.

Set the File in CircleCI

Perform the following steps to set circleci/config.yml file in CircleCI:

Log in to CircleCI with your GitHub account.
Select the Organization where you would be working. The Organizations get populated from your GitHub account.
Once the Organization is selected, set up a project for the CircleCI project.
Select the config.yml file that exists in the repository of main branch of circleci and click Set Up Project.

Perform the following steps to generate a token in CircleCI. Refer to Create a Personal API Token for more information.

Log in to CircleCI.
Go to User Settings and select Personal API Tokens.
Click Create New Token.
Give the Token Name and click Add API Token.
The API Token is generated. Copy it.

The following is an example of constructing the URL to trigger a build in CircleCI. Refer to https://circleci.com/docs/api-intro/ for more details.

Where, the Project Slug is <vcs_type>/<org_name>/<repo_name>

The values of the placeholders:

The vcs_type is “gh”.
The organization name that is created in GitHub and selected in the CircleCI while integration is “qtm4j”.
The project/repository name that is set as the project while integration is “circleci”.

If we replace the placeholders with relevant values for this example, the Project Slug is formed as gh/qtm4j/circleci

Hence, the URL would be -