github.com/instana/go-sensor@v1.62.2-0.20240520081010-4919868049e1/.tekton/ci-build/README.md (about)

     1  # Build CI Pipeline For Instana Go Tracer
     2  
     3  ## Install Tekton pipelines for Go Tracer CI Build
     4  
     5  - You will find all the required YAML configurations in this folder. This includes all the required tasks, pipelines, and GitHub triggers, etc.
     6  
     7  ### Prerequisites before applying the YAML files
     8  
     9  - You need three secrets to run the CI Build pipeline successfully:
    10  
    11    1. **GitHub bot token** - You need a GitHub bot token with write access to the repo. This is for sending commit statuses.
    12    2. **GitHub Webhook Secret** - Create a very long random secret. You need to add this to the GitHub UI when creating a webhook for PR events.
    13    3. **Cosmos URL and Secret** - This is for running azcosmos integration tests.
    14  
    15  - Once you have access to the above secrets, replace them in the `secrets.yaml` file.
    16  - You need an ingress controller for the GitHub Webhook to come through.
    17  - Replace the `ingressClassName` and ingress domain or subdomain URL in the `github-webhook-ingress.yaml` file.
    18  - Make sure you create two GitHub webhooks for both `pull_request` and `push` events in the settings tab of the repo. Please add the previously created webhook secret and `<<ingress_url/pr-hooks>>` and `<<ingress_url/push-hooks>>` as the Payload URL in the appropriate place when creating the webhook.
    19  
    20  ### Installation
    21  
    22  - Once you are ready with the above steps, please use the below command to apply the YAML files.
    23  
    24  ```sh
    25  sh deploy.sh
    26  ```
    27  
    28  - Congrats! You have successfully configured Tekton CI Build pipeline for Go Tracer. You will see a status posted in Github for the Tekton runs, whenever a new PR is created.
    29  
    30  ## Trigger CI Pipeline
    31  - Tekton pipeline can be triggered in two ways:
    32    1. Raising a PR
    33       - Tekton pipeline won't be immediately triggered when you raise a PR. You must apply the `tekton_ci` label to the PR to start the Tekton pipeline. Please note that if you raise a PR with a working copy, apply the label when it's ready for review. This label is for ensuring the pipelines won't trigger for every change to the PR. For any external PRs, one of the maintainers will add this label after a review.
    34    2. Pushing something to the `main` branch
    35       - Tekton pipeline will be triggered for every commit to the `main` branch.
    36  
    37  ## How to debug/re-run a pipeline run
    38  
    39  - You will find the Tekton dashboard URL for a specific pipeline run from the `details` section of the commit status.
    40  - You can access the Tekton dashboard if you had set up the `ibmcloud` cli and authenticated the cluster in your local machine, by using the `kubectl proxy` command. For detailed information on accessing the IBM Cloud cluster via `ibmcloud` cli, you can refer to this [documentation](https://cloud.ibm.com/docs/containers?topic=containers-access_cluster#access_public_se).
    41  - Once you have access to the dashboard, you can see the logs for each run and will be able to re-run the `PipelineRun` .
    42  - The status of the Tekton CI pipeline run for the PR will be updated once you initiate a re-run.
    43