fbt

Author: odx-pipelines/[email protected]

AIO.md

@@ -1,5 +1,5 @@
 All in One reference for samples - In Alphabetical (A to Z) order.
--------
+-----
 
 - Access resource with Private IP from OCI Build runner - https://github.com/oracle-devrel/oci-devops-examples/tree/main/oci-build-examples/oci-devops-pa-with-private-oke
 - Build Caching - https://github.com/oracle-devrel/oci-devops-examples/tree/main/oci-build-examples/oci-build-caching
@@ -27,4 +27,5 @@ All in One reference for samples - In Alphabetical (A to Z) order.
 - Invoke deployment pipeline on a container image upload  - https://github.com/oracle-devrel/oci-devops-examples/blob/main/oci-deployment-examples/oci-devops-deploy-on-imageupload
 - OCI Policy management using terraform - https://github.com/oracle-devrel/oci-devops-examples/blob/main/oci-config-examples/oci_devops_policy_dg_terraform
 - Scanning code for vulnerabilities for Maven packages - https://github.com/oracle-devrel/oci-devops-examples/tree/main/oci-build-examples/oci-devops-vulnerability-audit-management
+- Trigger build-pipeline from OCI Code repo on file modifications . - https://github.com/oracle-devrel/oci-devops-examples/blob/main/oci-coderepo-examples/oci-devops-coderepo-filebasedtrigger
 

oci-build-examples/oci-devops-pa-with-private-oke/README.md

@@ -27,7 +27,7 @@ This sample shows how to access resources which are with private IP addresses fr
 
 ## Procedure to use this illustration.
 
-###OCI Notifications
+### OCI Notifications
 - Create an OCI notification topic - https://docs.oracle.com/en-us/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createTopic
 
 ### OCI Container Engine for Kubernetes (OKE)

oci-coderepo-examples/README.md

@@ -1,6 +1,13 @@
 All about OCI devops coderepo samples ..
 =======
 
+<details>
+  <summary>File based trigger of the buildpipeline. - click to expand</summary>
+
+* [Trigger build-pipeline from OCI code repo.](./oci-devops-coderepo-filebasedtrigger/)
+
+</details>
+
 <details>
   <summary>Integration with external code repos. - click to expand</summary>
 

oci-coderepo-examples/oci-devops-coderepo-filebasedtrigger/.gitignore

@@ -0,0 +1 @@
+.idea

oci-coderepo-examples/oci-devops-coderepo-filebasedtrigger/README.md

@@ -0,0 +1,175 @@
+## Sample of **File-based Trigger Trigger** -  Trigger an OCI DevOps Build pipeline based on a file/s update.
+
+
+In Oracle Cloud Infrastructure (OCI) DevOps, a build run can be automatically triggered when you commit your changes to a code repository.
+
+You can control the trigger action by specifying the modified files in your repository to be included or excluded during the build run. The file-based trigger action is applicable only for the **Push** event.
+
+
+### File-Based Trigger
+For triggering a build run based on file changes, the following two options are provided:
+
+**Files to include**: By default, changes to all files in the repository are included when a build run is triggered. The Files to include option allows you to specify a list of files and directories in the repository that you have changed and for which you want to trigger a build run. Files are specified using glob patterns. Trigger action is based on the changes affecting at least one of the included files.
+
+**Files to exclude**: By default, changes to all files in the repository are included when a build run is triggered. The Files to exclude option allows you to specify a list of files and directories in the repository that you want to exclude from the build run. Files are specified using glob patterns. Changes affecting only the excluded files do not trigger a build. If files are specified for both include and exclude, then the exclude filter is applied to the output of the include filter.
+
+
+#### Objectives
+
+- Create an OCI DevOps project and code repo.
+- Create an OCI DevOps build pipeline and trigger.
+- Setup file include /exclude conditions and test.
+
+* Specific instruction to clone only this example.
+
+    ```
+    $ git init oci-devops-coderepo-filebasedtrigger
+    $ cd oci-devops-coderepo-filebasedtrigger
+    $ git remote add origin https://github.com/oracle-devrel/oci-devops-examples
+    $ git config core. sparsecheckout true
+    $ echo "oci-coderepo-examples/oci-devops-coderepo-filebasedtrigger/*">>.git/info/sparse-checkout
+    $ git pull --depth=1 origin main
+
+    ```
+
+### Procedure
+
+#### OCI Notifications.
+
+- Create an OCI notification topic - https://docs.oracle.com/en-us/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createTopic
+
+
+#### OCI Identity setups.
+
+- Create a dynamic group and add below rules. -
+
+```java
+ALL {resource.type = 'devopsbuildpipeline', resource.compartment.id = 'COMPARMENT OCID'}
+ALL {resource.type = 'devopsrepository', resource.compartment.id = 'COMPARMENT OCID'}
+```
+
+- Create a policy with the below statements.
+
+```java
+Allow dynamic-group "NAME OF THE DynamicGroup" to manage repos in compartment "COMPARTMENT NAME"
+Allow dynamic-group  "NAME OF THE DynamicGroup" to use ons-topics in compartment "COMPARTMENT NAME"
+```
+#### OCI DevOps setups.
+
+- Create a DevOps project and associate it with the notification topic - https://docs.oracle.com/en-us/iaas/Content/devops/using/create_project.htm
+
+![](images/oci-devops-project.png)
+
+- Ensure to enable logging for the projects.
+
+![](images/oci-devops-logs.png)
+
+- Create an OCI Code repo - https://docs.oracle.com/en-us/iaas/Content/devops/using/create_repo.htm
+
+![](images/oci-code-repo.png)
+
+- Push the content to the code repo created. You may use [SSH based authorization](https://docs.oracle.com/en-us/iaas/Content/devops/using/clone_repo.htm#ssh_auth) or [HTTPS based authorization](https://docs.oracle.com/en-us/iaas/Content/devops/using/clone_repo.htm#https_auth).
+
+![](images/oci-devops-corerepo-file.png)
+
+
+- Create a new build pipeline - https://docs.oracle.com/en-us/iaas/Content/devops/using/create_buildpipeline.htm
+
+![](images/oci-devops-buildpipeline.png)
+
+- Within the build pipeline, add a Managed Build stage - https://docs.oracle.com/en-us/iaas/Content/devops/using/add_buildstage.htm
+
+![](images/oci-add-stage.png)
+
+- Provide a name and description.
+
+![](images/oci-buildstage-1.png)
+
+- Use select within Primary code repository and select the OCI Code repo created.
+
+![](images/oci-buildstage-2.png)
+
+- Click Add and save the stage.
+
+![](images/oci-buildstage-3.png)
+
+
+- Create a new DevOps trigger - https://docs.oracle.com/en-us/iaas/Content/devops/using/trigger_build.htm
+
+- Provide a name and optional description.
+-
+![](images/oci-devops-trigger-1.png)
+
+- Select the OCI code repository as the Source connection.
+
+![](images/oci-devops-trigger-2.png)
+
+- Select the code repository.
+
+![](images/oci-devops-trigger-3.png)
+
+- Click on Add action and select the build pipeline created.
+
+![](images/oci-devops-trigger-4.png)
+
+- Select the Event as Push. Fill the Build run conditions.
+
+
+#### OCI DevOps trigger conditions.
+
+- **Note** - Build run conditions
+
+  - For the Push event, you can trigger the build run by specifying the source branch name and the files to be included or excluded in the build run.
+  - (Optional) Enter the source repository branch on which the selected event triggers the build run.
+  - If you select one of the Pull Request events, then you can also select the target code repository branch.
+  - (Optional) Enter files to include for the trigger action. Files are specified using glob patterns.
+  - For example, src/**/*.txt includes all text files in the "src" folder.
+  - (Optional) Enter files to exclude the trigger action. Files are specified using glob patterns.
+  - For example, **.html excludes all HTML files. For more examples and details.
+  - Refer more for **Glob Patterns** - https://docs.oracle.com/en-us/iaas/Content/devops/using/glob-patterns.htm
+
+- In this sample, we will be adding the below conditions.
+  - Source branch: main / It's optional.
+  - File to include : *.json and dire1/*.json / Update ona file with extension .json will trigger the build pipeline.
+  - Files to exclude : *.yaml / For a sample, we will exclude yaml file updates
+
+![](images/oci-devops-build-conditions.png)
+
+- Click create and save the trigger.
+
+![](images/oci-devops-trigger-conditions.png)
+
+
+#### Test the conditions .
+
+- Using cloud shell or local machine, add a new value to [file. json](file. json)
+
+![](images/oci-devops-trigger-json-test.png)
+
+- This will trigger a build run and once completed, you may see the changes in the executions logs.
+
+![](images/oci-build-log-view.png)
+
+- To test the exclusion, update a value with the file. yaml and validate that there is NO execution.
+- You can set up different trigger conditions and validate.
+
+![](images/oci-trigger-edit.png)
+
+- Add new conditions, as an example here we are including all the files starting with `f` or `r` with any `extension` with the parent directory and excluding the `*.md` file. Once set up, update the files, push them to the code repo and validate the conditions.
+
+![](images/oci-trigger-new-conditions.png)
+
+
+Contributors
+===========
+
+- Author: Rahul M R.
+- Collaborators: NA
+- Last release: September 2022
+
+Back to examples.
+----
+
+- 🍿 [Back to OCI Devops Coderepo sample](./../README.md)
+- 🏝️ [Back to OCI Devops sample](./../../README.md)
+

oci-coderepo-examples/oci-devops-coderepo-filebasedtrigger/build_spec.yaml

@@ -0,0 +1,54 @@
+version: 0.1
+component: build
+timeoutInSeconds: 6000
+runAs: root
+shell: bash
+env:
+  # these are local variables to the build config
+  variables:
+
+  # the value of a vaultVariable is the secret-id (in OCI ID format) stored in the OCI Vault service
+  # you can then access the value of that secret in your build_spec.yaml commands
+  vaultVariables:
+
+  # exportedVariables are made available to use as parameters in sucessor Build Pipeline stages
+  # For this Build to run, the Build Pipeline needs to have a BUILDRUN_HASH parameter set
+  exportedVariables:
+
+
+#Its a native way to fetch artifacts from external or artifact repo or a file path to use before a stage.
+# More about buildspec formats - https://docs.oracle.com/en-us/iaas/Content/devops/using/build_specs.htm
+
+#inputArtifacts:
+
+steps:
+  - type: Command
+    name: "Sample steps"
+    timeoutInSeconds: 40
+    command: |
+      cd ${OCI_PRIMARY_SOURCE_DIR}
+      echo "Running a build run based on file trigger"
+      echo ".......The files changed are ........"
+      git show --stat --oneline HEAD
+
+    onFailure:
+      - type: Command
+        command: |
+          echo "Handling Failure"
+          echo "Failure successfully handled"
+        timeoutInSeconds: 40
+        runAs: root
+
+
+#outputArtifacts:
+#  - name: golan_app_base_image
+#    type: DOCKER_IMAGE
+#    # this location tag doesn't effect the tag used to deliver the container image
+#    # to the Container Registry
+#    location: golan_app_base:latest
+#
+#  - name: golan_kube_manifest
+#    type: BINARY
+#    # this location tag doesn't effect the tag used to deliver the container image
+#    # to the Container Registry
+#    location: ${OCI_PRIMARY_SOURCE_DIR}/deployment_manifest.yaml

oci-coderepo-examples/oci-devops-coderepo-filebasedtrigger/dir1/file.json

@@ -0,0 +1,3 @@
+{
+  "key": "value2"
+}

oci-coderepo-examples/oci-devops-coderepo-filebasedtrigger/file.json

@@ -0,0 +1,4 @@
+{
+  "key": "value",
+  "attribute": "attr",
+}

oci-coderepo-examples/oci-devops-coderepo-filebasedtrigger/file.yaml

@@ -0,0 +1,2 @@
+value: "test"
+  attribute: "attr1"