Oracle Cloud Using Oracle Developer Cloud Service

Transcription

1 Oracle Cloud Using Oracle Developer Cloud Service E June 2018

2 Oracle Cloud Using Oracle Developer Cloud Service, E Copyright 2014, 2018, Oracle and/or its affiliates. All rights reserved. Primary Author: Himanshu Marathe Contributing Authors: Camilla Haase, Eric Jendrock Contributors: Oracle Developer Cloud Service development team, Greg Stachnick, Jeff Stephenson This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agencyspecific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government. This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners. Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

3 Contents Preface Audience Documentation Accessibility Related Resources Conventions xvi xvi xvi xvii 1 Getting Started with Oracle Developer Cloud Service About Oracle Developer Cloud Service 1-1 About Oracle Developer Cloud Service in Oracle Cloud Infrastructure 1-2 About the Components of Oracle Developer Cloud Service 1-3 Before You Begin Using Oracle Developer Cloud Service 1-4 How to Begin with Oracle Developer Cloud Service Subscriptions 1-6 About Oracle Developer Cloud Service Roles and Users 1-7 Typical Workflow for Using Oracle Developer Cloud Service 1-9 Accessing Oracle Developer Cloud Service 1-10 Creating an Instance of Oracle Developer Cloud Service 1-10 Accessing Oracle Developer Cloud Service Using the Web Interface 1-11 About the Oracle Developer Cloud Service Welcome Page 1-11 Accessing Oracle Developer Cloud Service from IDEs 1-12 Setting Oracle Developer Cloud Service Preferences 1-13 Updating Profile Information 1-14 Adding an Avatar Picture 1-14 Adding an SSH Key 1-15 Setting Notifications 1-15 Working with Oracle Developer Cloud Service Projects 1-16 About Oracle Developer Cloud Service Projects 1-16 Creating a Project 1-17 Opening a Project 1-20 Using a Template Project 1-21 iii

4 2 Developing Applications with Oracle Developer Cloud Service Typical Workflow for Oracle Developer Cloud Service Project Members 2-1 About the Project Page 2-2 Using the User Menu 2-4 Using the Recent Activities Feed 2-4 Using the Repository Tab 2-5 Using the Graphs and Statistics Tab 2-6 Using the Team Tab 2-7 Using the Search Box 2-7 Using Git in Oracle Developer Cloud Service 2-8 Cloning the Oracle Developer Cloud Service Project Git Repository 2-9 Pushing an Existing Local Git Repository to an Empty Oracle Developer Cloud Service Git Repository 2-13 Browsing Source Code in Oracle Developer Cloud Service 2-17 About the Code Page 2-18 Opening a Git Repository 2-19 Using the Revision Selector Menu 2-20 Copying the URL of a Git Repository and its Files 2-20 Copying the URL of a Git Repository 2-21 Copying the URL of a File 2-21 Copying the URL of a Line of a File 2-21 Viewing Directories and Files of a Repository in the Files View 2-22 Viewing File Contents in the File View 2-22 Managing Files of a Git Repository 2-24 Adding a File to a Git Repository 2-24 Editing a File of a Git Repository 2-25 Deleting a File of a Git Repository 2-25 Viewing a File s Annotation Information in the Blame View 2-26 Viewing and Downloading a File in the Raw View 2-27 Viewing Logs of a Git Repository 2-28 Viewing the Commit History List 2-28 About the Commit History List View 2-28 Viewing the Commit History Graph 2-29 About the Commit History Graph View 2-30 Adding Comments to Files 2-31 Searching Source Code in Git Repositories 2-32 Managing Branches and Tags of a Git Repository in the Refs View 2-33 Viewing Branches of a Git Repository 2-33 About the Branches View 2-33 Managing Branches of a Git Repository 2-36 Viewing Tags of a Git Repository 2-39 iv

5 About the Tags View 2-39 Managing Tags of a Git Repository 2-40 Comparing Revisions 2-42 Comparing Differences Between Revisions 2-42 About the Compare View 2-43 Reviewing the Compare Result in the Compare Page 2-44 Editing the Readme.md File 2-46 Using the Project Maven Repository in Oracle Developer Cloud Service 2-46 About the Maven Page 2-47 Browsing the Project Maven Repository 2-48 About the Browse View 2-48 Uploading Artifacts to the Project Maven Repository 2-49 About the Upload View 2-50 Using the Maven Command Line Interface 2-51 Searching Artifacts in the Project Maven Repository 2-52 About the Artifact Search View 2-53 Reviewing the Maven Artifact Search Result 2-53 Downloading Artifacts from the Project Maven Repository 2-53 Managing Releases in Oracle Developer Cloud Service 2-54 About the Releases Page 2-54 Creating a Release 2-55 About the New Release Page 2-56 About Release States 2-57 Editing or Cloning a Release 2-58 About the Edit Release Page 2-58 Changing a Release s Status 2-59 Downloading Artifacts of a Release 2-60 Deleting a Release 2-61 Using Snippets in Oracle Developer Cloud Service 2-61 About the Snippets Page 2-61 Creating a Snippet 2-63 Viewing and Editing a Snippet 2-63 About the Snippet Details Page 2-64 Managing Files of a Snippet 2-65 Adding Comments to a Snippet 2-66 Sharing and Liking a Snippet 2-67 Downloading an Archive of the Snippet 2-67 Inserting a Snippet File 2-68 Copying a Snippet File s Contents 2-68 Creating a Snippet from Selection 2-68 Using Git with Snippets 2-69 v

6 Deleting a Snippet 2-69 Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service 2-70 About the Merge Requests Page 2-70 Creating a Merge Request 2-72 About Merge Request Notifications 2-73 Creating a Custom Merge Request Search Query 2-74 Opening a Merge Request 2-74 Add or Remove Reviewers 2-75 Adding Comments and Reviewing the Source Code 2-76 About the Merge Request Review Page 2-76 About Merge Request States 2-79 Adding Comments to a Merge Request 2-79 Linking Issues to a Merge Request 2-81 Linking Builds to a Merge Request 2-82 Approving or Rejecting a Merge Request 2-83 Reviewing the Review Status of Reviewers 2-83 Merging Branches 2-84 Closing a Merge Request 2-87 Tracking Issues in Oracle Developer Cloud Service 2-88 About the Issues Page 2-89 About Issue Types 2-90 About Issue Status 2-91 About Issue Priority and Severity 2-91 Creating an Issue 2-92 About the New Issue Page 2-93 Opening and Updating an Issue 2-94 About the Issue Details Page 2-94 Updating Time Spent on an Issue 2-98 Associating an Issue with a Sprint 2-99 Resolving an Issue 2-99 Updating Multiple Issues Updating Issues from IDEs Adding a Comment to an Issue Adding an Attachment to an Issue Searching Issues Using the Basic Search Using the Advanced Search Saving a Custom Search Managing Shared Searches Using the Agile Methodology in Oracle Developer Cloud Service About the Agile Page vi

7 About Agile Concepts Creating a Board Opening a Board Using a Scrum Board Opening the Backlog View About the Backlog View Opening the Active Sprints View About the Active Sprints View Opening the Reports View About the Reports View Working with Sprints Creating a Sprint Editing a Sprint Adding an Issue to a Sprint Removing an Issue from a Sprint Starting a Sprint Updating an Issue s Progress in an Active Sprint Moving a Sprint to Another Board Reordering Sprints Completing a Sprint Deleting a Sprint Using a Kanban Board Opening the Backlog View About the Backlog View Activating an Issue in a Kanban Board Opening the Active Issues View About the Active Issues View Updating an Active Issue s Progress State Archiving Completed Issues Opening the Reports View Using the Reports View Using Agile Reports and Charts Using the Burndown Chart Using the Sprint Report Using the Issues Report Using the Epic Report Using the Velocity Report Using the Cumulative Flow Chart Using the Control Chart Configuring the Board Editing Board Properties vii

8 Editing Board Progress States Editing Board Working Days Copying a Board Deleting a Board Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service About the Build Page Managing and Configuring Jobs About the Jobs Tab About the Job Status About the Job Stability Creating a Job Viewing Job Details About the Job Details Page Configuring a Job Configuring the Source Code Management System for Builds Configuring Build Parameters Configuring the Build Environment Configuring Build Steps Configuring Post Build Actions Configuring the General Settings of a Job Configuring Build Software Configuring Build Triggers Setting Advanced Options for the Job Viewing a Job s Build History Disabling or Enabling a Job Deleting a Job Managing and Configuring Pipelines About Pipelines About the Pipelines Tab Creating a Pipeline Viewing Instances of a Pipeline About the Pipeline Instances Page Configuring a Pipeline About the Configure Pipeline Page Designing Pipeline Diagrams Running a Pipeline Deleting a Pipeline Using the Oracle Maven Repository Using the Oracle Developer Cloud Service Build Executor Environment Variables About the Software Installed on the Build Executor viii

9 Running a Build Configuring a Job to Run a Build Automatically on Git Repository Updates Configuring a Job to Run a Maven Build Configuring a Job to Run an Ant Build Configuring the POM File to Upload or Download Dependencies from the Project Maven Repository Discarding Old Builds and Artifacts Downloading Build Artifacts About the Artifacts Page Subscribing to a Job s Build Notifications Viewing a Build s Details About the Build Details Page Configuring a Build s Details Viewing a Build s Log About the Build Log Page Viewing SCM Changes About the SCM Changes Page Viewing a Build s Test Results About the Test Results Page Viewing the Test Details Page About the Test Details Page Viewing Test Suite Details About the Test Suite Details Page Viewing Test Results History About the Test Results History Page Viewing a Build s SCM Polling Log About the SCM Poll Logs Page Viewing a Job s User Action History About the Audit Page Viewing a Job s SonarQube Analysis Summary About the SonarQube Analysis Summary Page Viewing a Project s Recent Build History About the Recent Build History Page Monitoring Jobs and Builds from IDEs Using the WebLogic Maven Plugin Deploying an Application in Oracle Developer Cloud Service About the Deploy Page Creating a Deployment Configuration About the Deployment Configuration Page Editing a Deployment Configuration Deploying an Application to Oracle Java Cloud Service - SaaS Extension ix

10 Deploying an Application to Oracle Java Cloud Service - SaaS Extension of Another Data Center or Identity Domain Deploying an Application to Oracle Java Cloud Service Deploying to Oracle Java Cloud Service Using the Oracle WebLogic RESTFul Management Interface Deploying to Oracle Java Cloud Service Using the SSH Tunnel Deploying an Application to Oracle Application Container Cloud Service Viewing Deployment Logs Accessing the Deployed Application Browsing External Docker Registries in Oracle Developer Cloud Service About the Docker Registry Page Browsing a Docker Registry Repository About the Docker Registry Repository Page Deleting a Docker Registry Repository Image Tag Downloading the Image Manifest of a Docker Registry Repository Copying Pull and Push Commands for a Docker Registry Repository Using Wiki Pages in Oracle Developer Cloud Service About the Wiki Page Creating a Wiki Page Viewing a Wiki Page About the View Wiki Page Editing a Wiki Page About the Edit Wiki Page Adding Comments to a Wiki Page Formatting Comments using the Wiki Markup Language Creating a Child Wiki Page Managing Attachments of a Wiki Page Adding an Attachment to a Wiki Page Removing an Attachment from a Wiki Page Managing Edit and Delete Access Rights of a Wiki Page Viewing the History of a Wiki Page Comparing Two Versions of a Wiki Page Restoring an Old Version of a Wiki Page Deleting a Version of the Wiki Page Deleting a Wiki Page Restoring a Wiki Page Administering a Project in Oracle Developer Cloud Service Typical Workflow for Oracle Developer Cloud Service Project Owners 3-1 About the Administration Page 3-2 Managing an Oracle Developer Cloud Service Project 3-3 x

11 About the Properties Page 3-4 Editing Project Properties 3-4 Deleting a Project 3-5 Changing the Wiki Markup Language of a Project 3-5 Managing Project Users in Oracle Developer Cloud Service 3-6 About Oracle Developer Cloud Service Project Roles 3-6 About the Actions You Can Perform as Project Owner or Project Member 3-7 Actions You Can Perform on the Project page 3-7 Actions You Can Perform on the Code page and Git Repositories 3-8 Actions You Can Perform on the Maven page 3-9 Actions You Can Perform on the Releases page 3-10 Actions You Can Perform on the Snippets page 3-10 Actions You Can Perform on the Merge Requests page 3-11 Actions You Can Perform on the Issues page 3-12 Actions You Can Perform on the Agile page 3-13 Actions You Can Perform on the Build page 3-13 Actions You Can Perform on the Deploy page 3-14 Actions You Can Perform on the Docker Registry page 3-14 Actions You Can Perform on the Wiki page 3-15 Adding Users to a Project 3-15 Changing a User s Role in a Project 3-16 Exporting List of Project Members 3-17 Removing a User from a Project 3-17 Managing Project Announcements in Oracle Developer Cloud Service 3-18 About the Announcements Page 3-18 Creating an Announcement 3-19 About the Create Announcement Page 3-19 Viewing or Editing an Announcement 3-20 Deactivating or Activating an Announcement 3-20 Copying an Announcement 3-20 Deleting an Announcement 3-21 Viewing Usage Metrics of Oracle Developer Cloud Service Components 3-21 Configuring Oracle Developer Cloud Service Issue Components 3-22 Managing and Configuring Issue Products 3-22 About the Issue Tracking Products Tab 3-22 Viewing or Editing an Issue Product Details 3-23 Creating an Issue Product 3-23 About the Create Issue Product Page 3-24 Deleting an Issue Product 3-24 Managing and Configuring Issue Tags 3-25 About the Issue Tracking Tags Tab 3-25 xi

12 Creating an Issue Tag 3-26 Renaming an Issue Tag 3-26 Removing an Issue Tag 3-26 Managing and Configuring Issue Custom Fields 3-26 About the Issue Tracking Custom Fields Tab 3-27 Creating a Custom Field 3-27 About the Issue Tracking Create Custom Field Page 3-28 Viewing and Editing a Custom Field s Details 3-28 Deleting an Issue Custom Field 3-29 Managing Repositories in Oracle Developer Cloud Service 3-29 About the Repositories Page 3-30 Creating a Hosted Git Repository 3-30 Adding an External Git Repository 3-31 Importing a Git Repository 3-32 Editing a Git Repository 3-32 Setting the Default Branch of a Git Repository 3-33 Indexing a Git Repository 3-33 Deleting a Git Repository 3-33 Adding a Link to an External Docker Registry 3-34 Configuring Auto-Cleanup of the Project Maven Repository Snapshots 3-35 Managing Branches of Git Repositories in Oracle Developer Cloud Service 3-36 About the Branches Page 3-36 Assigning Default Reviewers to a Repository Branch 3-36 Setting Branch Restrictions 3-37 Assigning Repository Branches to a Project Member 3-38 Configuring Webhooks in Oracle Developer Cloud Service 3-39 About Webhooks 3-39 About the Webhooks Page 3-40 Creating a Generic Webhook 3-40 Creating a GitHub Compatible Webhook 3-41 Creating a HipChat Webhook 3-42 Creating a Hudson/Jenkins Build Trigger Webhook 3-43 Creating a Hudson/Jenkins Git Plugin Webhook 3-46 Creating a Jenkins Merge Request Webhook 3-47 Creating a Jenkins Notification Plugin Webhook 3-49 Creating an Oracle Social Network Webhook 3-51 Creating a PagerDuty Webhook 3-52 Creating a Slack Webhook 3-54 Editing a Webhook 3-55 Data Structure of a Generic Webhook 3-55 Managing ATOM/RSS Feeds in Oracle Developer Cloud Service 3-68 xii

13 About the RSS/ATOM Feeds Page 3-68 Creating an ATOM/RSS Feeds Handler 3-69 Editing, Testing, and Viewing Logs of an ATOM/RSS Feeds Handler 3-69 Deactivating or Deleting an ATOM/RSS Feeds Handler 3-70 Exporting and Importing Project Data in Oracle Developer Cloud Service 3-71 About the Data Export/Import Page 3-71 Connecting to Oracle Cloud Infrastructure Object Storage Classic 3-71 Exporting Project Data from Oracle Developer Cloud Service 3-72 Importing Project Data to Oracle Developer Cloud Service 3-73 Viewing Export and Import History of the Project 3-74 Importing External Hudson Jobs to Oracle Developer Cloud Service 3-74 Administering the Build System in Oracle Developer Cloud Service 3-76 About the Build Page 3-76 Managing Oracle Maven Repository Connections 3-76 Managing SonarQube Server Connections 3-78 Configuring Link Rules in Oracle Developer Cloud Service 3-79 About the Links Page 3-79 Creating a Link Rule 3-80 Editing a Link Rule 3-82 Activating or Deactivating a Link Rule 3-82 Deleting a Link Rule 3-82 Verifying Organization s Storage Configuration Administering the Organization in Oracle Developer Cloud Service Typical Workflow for Oracle Developer Cloud Service Organization Administrators 4-1 About the Organization Administration Page 4-2 Updating Organization Properties 4-3 Managing Projects and Viewing Usage Metrics of an Organization 4-3 About the Projects Page 4-4 Viewing Usage Metrics of all Projects 4-4 Managing Projects of the Organization 4-5 Viewing and Managing Virtual Machines 4-7 About Virtual Machines in Oracle Developer Cloud Service 4-7 About Build VMs and Build VM Templates 4-7 About the Virtual Machines Page 4-8 Configuring the Oracle Cloud Infrastructure Compute Classic Connection 4-9 Compute_Operations Role: Terms of Use 4-10 Adding a Build VM 4-11 Changing a Build VM s Template 4-11 Deleting a VM 4-12 xiii

14 Managing Virtual Machine Templates 4-12 About the VM Templates Page 4-12 Creating a Build VM Template 4-13 Configuring a VM Template s Software 4-13 Deleting a VM Template 4-15 Configuring the Oracle Cloud Infrastructure Object Storage Classic Connection Using IDEs with Oracle Developer Cloud Service Using Eclipse IDE with Oracle Developer Cloud Service 5-1 Installing the Oracle Cloud Tools Plugin 5-2 Logging In to Oracle Developer Cloud Service 5-3 Using the Oracle Cloud View 5-4 Importing an Oracle Developer Cloud Service Project to the Eclipse IDE 5-5 Exporting an Eclipse IDE Project to Oracle Developer Cloud Service 5-6 Using Git in Eclipse IDE 5-6 Updating Oracle Developer Cloud Service Issues in the Eclipse IDE 5-7 Creating an Oracle Developer Cloud Service Issue 5-7 Creating a Custom Issue Search Query 5-8 Associating an Issue with a Commit 5-8 Monitoring Project Builds in the Eclipse IDE 5-9 Using NetBeans IDE with Oracle Developer Cloud Service 5-9 Installing the Oracle Developer Cloud Service Plugin 5-9 Logging In to Oracle Developer Cloud Service 5-10 Using the Oracle Developer Cloud Service Team Server 5-11 Creating an Oracle Developer Cloud Service Project in NetBeans IDE 5-11 Opening an Oracle Developer Cloud Service Project in NetBeans IDE 5-12 Using Git in NetBeans IDE 5-13 Updating Oracle Developer Cloud Service Issues in NetBeans IDE 5-14 Create an Oracle Developer Cloud Service Issue in NetBeans IDE 5-14 Create an Oracle Developer Cloud Service Issue Query in NetBeans IDE 5-15 Associating an Issue with a Commit 5-15 Monitoring Project Builds in NetBeans IDE 5-16 Using Oracle JDeveloper with Oracle Developer Cloud Service 5-17 Logging In to Oracle Developer Cloud Service 5-17 Using the Oracle Developer Cloud Service Team Server 5-18 Creating an Oracle Developer Cloud Service Project in JDeveloper 5-19 Opening an Oracle Developer Cloud Service Project in JDeveloper 5-20 Using Git in Oracle JDeveloper 5-21 Updating Oracle Developer Cloud Service Issues in JDeveloper 5-21 Create an Oracle Developer Cloud Service Issue 5-21 xiv

15 Create an Oracle Developer Cloud Service Issue Query in JDeveloper 5-22 Associating an Issue with a Commit 5-23 Monitoring Project Builds in JDeveloper 5-23 Building Oracle ADF Applications with Oracle Developer Cloud Service Frequently Asked Questions for Oracle Developer Cloud Service General Questions 6-1 Questions about User Account Preferences 6-4 Questions about the Welcome page and Projects 6-6 Questions about the Project page 6-8 Questions about the Code Page and Git 6-10 Questions about the Maven Page and the Project Maven Repository 6-17 Questions about the Releases Page and Configuring Releases of a project 6-18 Questions about the Snippets Page and Snippet Files 6-18 Questions about the Merge Request Page and Code Reviews 6-19 Questions about the Issues Page and Tasks 6-23 Questions about the Agile Page and Sprints 6-24 Questions about the Builds Page and the Build System 6-26 Questions about the Deploy Page and Project Deployment 6-28 Questions About the Docker Registry Page and Docker Images 6-29 Questions about the Wiki Page and Wiki Pages 6-30 Questions about the Administration Page and Project Ownership 6-31 Questions about the Organization Administration Page Troubleshooting Oracle Developer Cloud Service A Using the Git Command Line Interface Customizing the Git Environment A-1 Using Git Commands A-2 Generating an SSH Key A-4 Migrating to Git A-4 xv

16 Preface Preface Using Oracle Developer Cloud Service describes how to use Oracle Developer Cloud Service to commit source code files to the Git repositories, track issues, review the source code and merge repository branches, share information through wikis, build applications, and deploy them. Topics: Audience Audience Documentation Accessibility Related Resources Conventions Using Oracle Developer Cloud Service is intended for: Customers developing applications that deploy to Oracle Cloud or to an onpremise environment Developers using NetBeans IDE, Eclipse IDE or Oracle Enterprise Pack for Eclipse (OEPE), or Oracle JDeveloper to access and use Oracle Developer Cloud Service Project Administrators or Project Managers that support the development team Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at ctx=acc&id=docacc. Access to Oracle Support Related Resources Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit lookup?ctx=acc&id=info or visit if you are hearing impaired. For more information, see these Oracle resources: Oracle Cloud xvi

17 Preface Conventions About Oracle Cloud in Getting Started with Oracle Cloud About Oracle Java Cloud Service - SaaS Extension in Using Oracle Java Cloud Service - SaaS Extension About Oracle Java Cloud Service in Administering Oracle Java Cloud Service About Oracle Application Container Cloud Service in Using Oracle Application Container Cloud Service The following text conventions are used in this document: Convention boldface italic monospace Meaning Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary. Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values. Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter. xvii

18 1 Getting Started with Oracle Developer Cloud Service This section describes how to get started with Oracle Developer Cloud Service. Topics: About Oracle Developer Cloud Service About the Components of Oracle Developer Cloud Service Before You Begin Using Oracle Developer Cloud Service How to Begin with Oracle Developer Cloud Service Subscriptions About Oracle Developer Cloud Service Roles and Users Typical Workflow for Using Oracle Developer Cloud Service Accessing Oracle Developer Cloud Service Setting Oracle Developer Cloud Service Preferences Working with Oracle Developer Cloud Service Projects See Oracle Cloud Terminology in Getting Started with Oracle Cloud for definitions of terms found in this and other documents in the Oracle Cloud library. About Oracle Developer Cloud Service Oracle Developer Cloud Service is a cloud-based software development Platform as a Service (PaaS) and a hosted environment for your application development infrastructure. It provides an open source standards-based solution to develop, collaborate, and deploy applications within Oracle Cloud. To set up a typical software development environment, other than setting up a database server and a web server, you would also need the following software: Version controlled repository: for source code management Build server: to run and manage regular software builds Wiki server: for internal documentation Bug server: to track bugs and new features Setting up these software components requires configuration knowledge of each component to integrate them. Each component requires regular maintenance and upgrades. After each software upgrade, its integration with other software must be tested, and this usually takes a long time. You would also require compatible hardware to run these components. Oracle Developer Cloud Service is a collection of similar software and services hosted on Oracle Cloud. Oracle Developer Cloud Service helps you to manage the application development life cycle effectively through integration with Git, Maven, issues, and wikis. Using Oracle Developer Cloud Service, you can commit your application source 1-1

19 Chapter 1 About Oracle Developer Cloud Service code to the Git repository on the Oracle Cloud, track assigned issues and defects online, share information using wiki pages, peer review the source code, and monitor project builds. After successful testing, you can deploy the project to Oracle Java Cloud Service - SaaS Extension, publicly available Oracle Java Cloud Service instances, Oracle Application Container Cloud Service instances, or to an on-premise production environment. Watch a short video to learn more about Oracle Developer Cloud Service. Video The key features of Oracle Developer Cloud Service include: Project creation, configuration, and user management Version control and source code management with Git Storage of application dependencies and libraries with Maven Continuous build integration Wiki for document collaboration Issue tracking system to track tasks, defects, and features Agile methodology to track sprints and update issues Repository branch merge after code review Deployment to Oracle Java Cloud Service - SaaS Extension, Oracle Java Cloud Service, and Oracle Application Container Cloud Service As soon as your Oracle Developer Cloud Service account is activated, you can access all features of Oracle Developer Cloud Service immediately without setting up a local environment. Oracle Developer Cloud Service is available as a web interface accessible from a web browser and from Integrated Development Environments (IDEs) such as Oracle Enterprise Pack for Eclipse (OEPE), Oracle JDeveloper, and NetBeans IDE. About Oracle Developer Cloud Service in Oracle Cloud Infrastructure You can create Oracle Developer Cloud Service instances in Oracle Cloud Infrastructure and in Oracle Cloud Infrastructure Classic. These instances have no functional differences. Oracle Developer Cloud Service builds run on Oracle Cloud Infrastructure Compute Classic virtual machines (VMs). Project artifacts are stored in an Oracle Cloud Infrastructure Object Storage Classic container. 1-2

20 Chapter 1 About the Components of Oracle Developer Cloud Service Before you can use Oracle Developer Cloud Service on Oracle Cloud Infrastructure or Oracle Cloud Infrastructure Classic, you must configure a connection to Oracle Cloud Infrastructure Compute Classic and Object Storage Classic. See Configuring the Oracle Cloud Infrastructure Compute Classic Connection and Configuring the Oracle Cloud Infrastructure Object Storage Classic Connection. See Prerequisites for Oracle Platform Services for information about setting up required resources in Oracle Cloud Infrastructure. About the Components of Oracle Developer Cloud Service Oracle Developer Cloud Service is comprised of various components including Git, Maven, issue tracker, wiki, build system, snippets, and code review. All components are available in a project, which is a collection of features and services provided by Oracle Developer Cloud Service. See About Oracle Developer Cloud Service Projects. Git Git is a distributed version control and source code management system. The source code in Oracle Developer Cloud Service is managed with Git. See Using Git in Oracle Developer Cloud Service and Browsing Source Code in Oracle Developer Cloud Service. You can use any Git client to update files on the Git repository, including the Git integration available in IDEs. See Using IDEs with Oracle Developer Cloud Service and Using the Git Command Line Interface. To learn more about Git, see the Git documentation at git-scm.com/doc, and the Git book at Build System You can define and automate builds of your applications with the Oracle Developer Cloud Service build system. Oracle Developer Cloud Service uses Oracle Cloud Infrastructure Compute Classic VMs to run builds of Oracle Developer Cloud Service projects. Maven Maven is a project management and build automation tool that you can use to build applications. You can also use the project s Maven repository to store application artifacts and libraries. See About the Upload View and About the Browse View. To know more Maven, see and your IDE's Maven integration documentation. Code Review You can invite your project team members to review the source code of a Git repository branch and add comments. Based on the comments and feedback, you can then choose to merge the review branch with the target branch. See Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service. 1-3

21 Chapter 1 Before You Begin Using Oracle Developer Cloud Service Issue Tracker You can create and track issues such as tasks, defects, and features and assign them to your team members. You can also use the Agile methodology to update issues. See Tracking Issues in Oracle Developer Cloud Service and Using the Agile Methodology in Oracle Developer Cloud Service. Wiki You can create wiki pages for document authoring and collaboration with your team members. See Using Wiki Pages in Oracle Developer Cloud Service. Deploy You can deploy your application artifacts to Oracle Java Cloud Service - SaaS Extension, publicly available Oracle Java Cloud Service instances, and Oracle Application Container Cloud Service instances. See Deploying an Application in Oracle Developer Cloud Service. Before You Begin Using Oracle Developer Cloud Service Before using Oracle Developer Cloud Service, ensure you are familiar with the technologies it uses such as Git, Continuous Integration, Maven, Agile, and Oracle Cloud. Git Make yourself familiar with the following: Git basics Distributed Version Control Systems Git workflow Initializing and cloning a Git repository Adding and removing files from the Git repository Checking out and committing files to the Git repository Fetching, pulling, and pushing data to remote repositories Managing branches Git commands If you want to migrate your version control repository to Git, see Migrating to Git. Continuous Integration Make yourself familiar with the following: Continuous integration basics Jobs and builds Using testing tools with build systems 1-4

22 Chapter 1 Before You Begin Using Oracle Developer Cloud Service Using Git and other source control systems with build systems Using build automation tools such as Maven and Ant with build systems Maven Make yourself familiar with the following: Maven basics Project Object Model (POM) and configuring pom.xml Creating a Maven project in your IDE Working with Maven archetypes Working with Maven repositories Agile Make yourself familiar with the following: Agile methodology Agile boards Scrum and Kanban Sprints Story points Oracle Cloud Create and configure your account on Oracle Cloud. See Request a Trial Subscription or Buy a Nonmetered Subscription to an Oracle Cloud Service in Getting Started with Oracle Cloud. Oracle Cloud Infrastructure Compute Classic Using Oracle Cloud Infrastructure Compute Classic, you provision virtual machines (VMs) on Oracle Cloud with all the necessary storage and networking resources. In Oracle Developer Cloud Service, you use these VMs to run builds of projects. See About Compute Classic in Using Oracle Cloud Infrastructure Compute Classic. Oracle Cloud Infrastructure Object Storage Classic Using Oracle Cloud Infrastructure Object Storage Classic, you create containers on Oracle Cloud to store data. In Oracle Developer Cloud Service, you use these containers to archive build artifacts, Maven artifacts, and export and import project data. See About Oracle Cloud Infrastructure Object Storage Classic in Using Oracle Cloud Infrastructure Object Storage Classic. Oracle Java Cloud Service - SaaS Extension Create Oracle Java Cloud Service - SaaS Extension instances quickly and then deploy your applications to the service instance. You can then secure and manage your applications without worrying about the underlying infrastructure. See About Oracle Java Cloud Service - SaaS Extension in Using Oracle Java Cloud Service - SaaS Extension. 1-5

23 Chapter 1 How to Begin with Oracle Developer Cloud Service Subscriptions Oracle Java Cloud Service Create and configure an Oracle WebLogic Server domain and set up your Java EE application environment without worrying about setting up any infrastructure or platform details yourself. See About Oracle Java Cloud Service in Administering Oracle Java Cloud Service. Oracle Application Container Cloud Service Oracle Application Container Cloud Service enables you to deploy Java SE, Node.js, PHP, Python, Ruby, Go, and.net applications to the Oracle Cloud. You can also deploy Java EE 7 (or later) web applications. See About Oracle Application Container Cloud Service in Using Oracle Application Container Cloud Service and About Your Application and Oracle Application Container Cloud Service in Developing for Oracle Application Container Cloud Service. How to Begin with Oracle Developer Cloud Service Subscriptions Here's a summary of the key steps to get started with Oracle Developer Cloud Service. 1. Request a free Oracle Cloud subscription or purchase a subscription. See Request and Manage Free Oracle Cloud Promotions and Buy a Nonmetered Subscription to an Oracle Cloud Service in Getting Started with Oracle Cloud. For more information about the services that have Oracle Developer Cloud Service included as a free entitlement, see developer-service/pricing. 2. Create accounts for your users in the identity domain and assign them appropriate roles. See Managing Users, User Accounts, and Roles in Managing and Monitoring Oracle Cloud for more information about identity domain roles in Oracle Cloud. 3. Create an Oracle Developer Cloud Service instance. See Creating an Instance of Oracle Developer Cloud Service. 4. Configure a connection to Oracle Cloud Infrastructure Object Storage Classic. See Configuring the Oracle Cloud Infrastructure Object Storage Classic Connection. The build and Maven artifacts of Oracle Developer Cloud Service projects are stored in containers of Oracle Cloud Infrastructure Object Storage Classic. Tutorial 5. Configure a connection to Oracle Cloud Infrastructure Compute Classic. See Configuring the Oracle Cloud Infrastructure Compute Classic Connection. The builds of Oracle Developer Cloud Service run on virtual machines (VMs) of Oracle Cloud Infrastructure Compute Classic service. Tutorial 6. Create VM templates. See Creating a Build VM Template. VM templates define the software installed on VMs. Tutorial 1-6

24 Chapter 1 About Oracle Developer Cloud Service Roles and Users 7. Add VMs. See Adding a Build VM. The builds of Oracle Developer Cloud Service run on VMs. Tutorial 8. Create projects in Oracle Developer Cloud Service. See Creating a Project. Tutorial 9. Add users to the project. See Managing Project Users in Oracle Developer Cloud Service. Tutorial 10. Set up Git repositories, track issues, build applications, and deploy them. See Managing Repositories in Oracle Developer Cloud Service, Tracking Issues in Oracle Developer Cloud Service, Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service, and Deploying an Application in Oracle Developer Cloud Service. 11. If you have subscribed for a free Oracle Cloud promotion, you have a grace period of 7 days to convert your free promotion to a paid service after the free promotion period expires. See Upgrade Your Free Oracle Cloud Promotion in Managing and Monitoring Oracle Cloud. When you subscribe to Oracle Developer Cloud Service, as the subscriber, you are assigned the DEVELOPER_ADMINISTRATOR (Developer Service Administrator) identity domain role. See About Oracle Developer Cloud Service Roles and Users to know more about identity domain roles. After subscribing to service, see Typical Workflow for Oracle Developer Cloud Service Organization Administrators to know what you can do as the Developer Service Administrator. About Oracle Developer Cloud Service Roles and Users The Oracle Developer Cloud Service roles can be divided into two categories: Oracle Developer Cloud Service Identity Domain roles and Oracle Developer Cloud Service Project roles. Each user must be assigned an identity domain role to access Oracle Developer Cloud Service. Further, the user would need a project role to access, use, or update an Oracle Developer Cloud Service project. An Oracle Cloud Identity Domain controls the authentication and authorization of the users who can sign in to an Oracle Cloud service and what features they can access. To allow a user to access an Oracle Developer Cloud Service project, the user must be first granted an identity domain role. See Learn About Cloud Account Roles and Add Users and Assign Roles in Getting Started with Oracle Cloud. The following table lists the Identity Domain roles. Role TenantAdminGroup (Identity Domain Administrator) Enables a user to add and manage users and their roles in the identity domain. By default, the role is assigned to the service subscriber. The service subscriber can assign this role to other users. 1-7

25 Chapter 1 About Oracle Developer Cloud Service Roles and Users Role DEVCS_APP_ENTITLEMENT_ADMINISTRATOR (Administrator Role for Developer Cloud Service Provisioning) DEVELOPER_ADMINISTRATOR (Developer Service Administrator) DEVELOPER_USER (Developer Service User) Enables a user to create an Oracle Developer Cloud Service instance. Enables a user to update the Organization details of Oracle Developer Cloud Service. The user with this role is also called as the Organization Administrator. By default, the role is assigned to the service subscriber. The service subscriber can assign this role to other users. Enables a user to create and access Oracle Developer Cloud Service projects. This role must be assigned to all users of Oracle Developer Cloud Service irrespective of their project roles. Note that this role does not allow the user to update the Organization details. Additional Roles To access other Oracle Cloud services from Oracle Developer Cloud Service, you may need to assign the following roles to some users. Role More Information JaaS_Administrator (Java Administrators) APaaS_Administrator (APaaS Administrator) Compute.Compute_Operations (Service Administrator) Storage.Storage_Administra tor (Service Administrator) Enables a user to connect to Oracle Java Cloud Service and Oracle Java Cloud Service - SaaS Extension while creating deployment configurations. Enables a user to connect to Oracle Application Container Cloud Service while creating deployment configurations. Enables a user to create and manage Oracle Developer Cloud Service VMs on Oracle Cloud Infrastructure Compute Classic. Enables a user to create and manage containers, and export to and import project data from Oracle Cloud Infrastructure Object Storage Classic. Deploying an Application in Oracle Developer Cloud Service Deploying an Application in Oracle Developer Cloud Service Viewing and Managing Virtual Machines Configuring the Oracle Cloud Infrastructure Object Storage Classic Connection Exporting and Importing Project Data in Oracle Developer Cloud Service After assigning the identity domain roles, users must be added to projects and assigned the proper project role. See About Oracle Developer Cloud Service Project Roles. 1-8

26 Chapter 1 Typical Workflow for Using Oracle Developer Cloud Service Typical Workflow for Using Oracle Developer Cloud Service To start using Oracle Developer Cloud Service, refer to the typical workflow. Task More Information Request a free Oracle Cloud Promotional subscription or purchase a service Verify the service is ready Access Oracle Developer Cloud Service Administer the organization Administer projects Develop applications using Oracle Developer Cloud Service Monitor service Converting your free Oracle Cloud promotion Provide your information and sign up for a free Oracle Cloud subscription. Oracle Cloud offers a promotion period that includes predefined free Cloud credits. You can use these free credits to try out the Cloud services for a period of 30 days. After subscribing to an Oracle Cloud Service, view the status and metrics of each service instance in My Services. Access the Oracle Developer Cloud Service web interface. Add and display your organization name, set the default Wiki markup language of all new projects in your organization, and view the usage metrics of all projects. Manage the project, add or remove users, configure issue components, manage webhooks, and manage Git repositories. Push your code files to the Git repositories, track issues, review the code, run job builds, and deploy to Oracle Cloud. Check on the day-to-day operation of your service, monitor performance, and review important notifications. After the promotion period expires, you have a grace period of 7 days to convert your free promotion to a paid service. Request and Manage Free Oracle Cloud Promotions and Buy a Nonmetered Subscription to an Oracle Cloud Service in Getting Started with Oracle Cloud Verify That Your Trial Subscription Is Running in Getting Started with Oracle Cloud Accessing Oracle Developer Cloud Service Administering the Organization in Oracle Developer Cloud Service Administering a Project in Oracle Developer Cloud Service Developing Applications with Oracle Developer Cloud Service Monitoring Service Status, Account Balance, and Utilization in a Domain in Managing and Monitoring Oracle Cloud Upgrade Your Free Oracle Cloud Promotion in Managing and Monitoring Oracle Cloud Depending on your role, you might also want to see Typical Workflow for Oracle Developer Cloud Service Organization Administrators, Typical Workflow for Oracle Developer Cloud Service Project Owners, or Typical Workflow for Oracle Developer Cloud Service Project Members. 1-9

27 Chapter 1 Accessing Oracle Developer Cloud Service Accessing Oracle Developer Cloud Service You can access Oracle Developer Cloud Service from the Oracle Cloud web user interface and from Oracle Enterprise Pack for Eclipse (OEPE), NetBeans IDE, and JDeveloper. Topics Accessing Oracle Developer Cloud Service Using the Web Interface About the Oracle Developer Cloud Service Welcome Page Accessing Oracle Developer Cloud Service from IDEs Creating an Instance of Oracle Developer Cloud Service To access Oracle Developer Cloud Service, you must create a service instance. This is a one-time step. You must be assigned the DEVCS_APP_ENTITLEMENT_ADMINISTRATOR (Administrator Role for Developer Cloud Service Provisioning) identity domain role to create an instance. To create an Oracle Developer Cloud Service instance: 1. Sign in to Oracle Cloud and open the Oracle Cloud Dashboard page. For more information about the signup process, see Sign Up for the Free Oracle Cloud Promotion in Getting Started with Oracle Cloud. 2. On the Oracle Cloud Dashboard, in the Developer tile, click the Developer link. If the Developer tile is not visible, click Customize Dashboard. Under Platform, find the Developer service, click Show, and then close the Customize Dashboard window. If the Developer service is not available in the Customize Dashboard window, switch to the traditional identity domain. On the Dashboard page, in the top-right corner, select the traditional identity domain from the Identity Domain drop-down list. On the updated Oracle Cloud Dashboard page, locate the Developer tile. If the Developer tile is not visible, open the Customize Dashboard window, find the Developer service, click Show, and then close the Customize Dashboard window. 3. On the Service page, in the upper-right corner, click Open Service Console. 4. In the Instances tab, click Create Instance. 5. On the Create New Instance page, enter a unique name in the Instance field. The name helps you to identify the service instance in the tenant domain. 6. (Optional) In, enter a description. 7. Click Next. 8. On the Service Details page, click Next. 9. On the Confirmation page, click Create. 10. After the service instance is created, click Action and select Access Service Instance. The Oracle Developer Cloud Service Welcome page opens. 1-10

28 Chapter 1 Accessing Oracle Developer Cloud Service Accessing Oracle Developer Cloud Service Using the Web Interface To access Oracle Developer Cloud Service, you would require the identity domain name, username, and the password of your account. To sign in to Oracle Developer Cloud Service: 1. Sign in to Oracle Cloud and open the Oracle Cloud dashboard page. For more information about the signup process, see Sign Up for the Free Oracle Cloud Promotion in Getting Started with Oracle Cloud. 2. On the Oracle Cloud Dashboard, in the Developer tile, click Action and select Open Service Console. If the Developer tile is not visible, click Customize Dashboard. Under Platform, find the Developer service, click Show, and then close the Customize Dashboard window. If the Developer service is not available in the Customize Dashboard window, then on the Dashboard page, select the traditional identity domain from the Identity Domain drop-down list in the top-right corner of the page and locate the Developer tile. 3. Enter the identity domain in Identity Domain and click Go. Select the Remember my choice check box to remember your identity domain next time you log in. You will find the details in the subscription Welcome to Oracle Cloud. If you were invited to Oracle Cloud, you will find the details in the New Account Information. 4. Enter username and password and click Sign In. If you are signing in to Oracle Developer Cloud Service for the first time, you will get an with the subject Verify your Oracle Developer Cloud Service. Open the and click the URL link in the body to verify your . This is required for receiving notifications that you subscribe to in Oracle Developer Cloud Service. After your address is verified, you will receive another with the subject Welcome to Oracle Developer Cloud Service. The contains the Oracle Developer Cloud Service account URL that you can use to open the Oracle Developer Cloud Service web interface. After you log in to Oracle Developer Cloud Service, Oracle Cloud displays the Welcome page. See About the Oracle Developer Cloud Service Welcome Page. About the Oracle Developer Cloud Service Welcome Page The Welcome page, also called as the Projects List or the Home page, is the first page that you see when you log into Oracle Developer Cloud Service. It displays projects that you are a member of, your favorite projects, projects that you own, and all shared projects of the organization. For frequently asked questions, see Questions about the Welcome page and Projects. The following table describes the elements of the Welcome page. 1-11

29 Chapter 1 Accessing Oracle Developer Cloud Service Member/Favorites/ Owner/All Click the toggle buttons to filter the projects displayed in the project list. Member: View projects you are a member of Favorites: View your favorite projects Owner: View projects you own All: View all shared projects, favorite projects, and projects you own or are a member of + New Project Click to create a project. See Creating a Project. Filter Projects Search for a project. Enter a regular expression in the search box and click the icon. Project list News Feed Video To cancel or reset the search, click the icon. List of projects matching the filter toggle buttons and the search query (if specified). Click the project name link to go to the Project page. Click the to mark a project as your favorite project. Browse through the Oracle Developer Cloud Service news feed that highlights the new features, latest updates, and announcements from the Oracle Developer Cloud Service team. Click the Play icon to run the introductory video. icon Accessing Oracle Developer Cloud Service from IDEs Besides the Oracle Cloud web interface, Oracle Developer Cloud Service also provides connections via these IDEs: OEPE, NetBeans IDE, and JDeveloper. The following table describes the interfaces to Oracle Developer Cloud Service: 1-12

30 Chapter 1 Setting Oracle Developer Cloud Service Preferences Type of Access More Information Oracle Developer Cloud Service interface in OEPE Oracle Developer Cloud Service interface in NetBeans IDE Oracle Developer Cloud Service interface in Oracle JDeveloper Enables a user to clone a Git repository, commit source code, manage issues, and monitor builds. Enables a user to create a project, clone a Git repository, commit source code, manage issues, and monitor builds. Enables a user to commit source code to a Git repository. Using Eclipse IDE with Oracle Developer Cloud Service Using NetBeans IDE with Oracle Developer Cloud Service Using Oracle JDeveloper with Oracle Developer Cloud Service You can use REST APIs from OEPE to access the build job creation functions. See the remote access API documentation at You can also use the Git command line interface to access Git repositories. See Using the Git Command Line Interface. Setting Oracle Developer Cloud Service Preferences Before you start using or creating Oracle Developer Cloud Service projects, verify and set your Oracle Developer Cloud Service account preferences. From the Preferences page, you can update your profile, add SSH keys to access Git repositories, and enable or disable notifications for issue updates, system updates, and new feature announcements. For frequently asked questions, see Questions about User Account Preferences. You can open the Preferences page from the Preferences menu option in the user menu. Topics Updating Profile Information Adding an Avatar Picture Adding an SSH Key Setting Notifications 1-13

31 Chapter 1 Setting Oracle Developer Cloud Service Preferences Updating Profile Information You should verify your profile information before you start using Oracle Developer Cloud Service. All notifications (such as merge request notifications and issue notifications) are sent to the address specified in your profile. By default, your Oracle Cloud account name and address are set in the name and fields and the same will be displayed across Oracle Developer Cloud Service user interface pages. If you want to change your display name and the address for receiving notifications, you can change them from the Profile tab. To update your profile information: 1. In the branding bar of the Oracle Developer Cloud Service web interface, click the user name. 2. Click Preferences. 3. Click the Profile tab. You can view and edit your address, first name, and last name. To add an avatar picture, see Adding an Avatar Picture. 4. Click Done to return to the last opened page. If you have updated your address, click the Re-send button. In the that you will receive, click the confirmation link to confirm the address. The new address will be displayed in the Oracle Developer Cloud Service user interface pages. If you do not confirm your address in the received , you will not receive any notifications, however you can continue to use Oracle Developer Cloud Service. Your Oracle Cloud address will continue to be your login username and will be displayed as the user name in the top-right corner user menu. Adding an Avatar Picture To display your avatar picture or profile picture, create an account on Gravatar and upload the picture there. To add an avatar picture to your account: 1. Open in your browser. To know more about Gravatar, see 2. Click Create Your Own Gravatar. 3. Follow the on-screen instructions, enter the required details, and sign up. Create your account with the same address that you used to subscribe to Oracle Developer Cloud Service. You will find the address displayed in the Profile tab of the Preferences page. 4. After activating your account, sign in to Gravatar. 5. Upload the avatar picture to your Gravatar account. For any help or query, see The picture uploaded on Gravatar is automatically displayed as your avatar picture in Oracle Developer Cloud Service. 1-14

32 Chapter 1 Setting Oracle Developer Cloud Service Preferences Adding an SSH Key Every Oracle Developer Cloud Service project comes with a Git repository that can also be accessed using the SSH protocol. To connect to the Git using SSH, generate an SSH key, and associate it with your account. You can add the SSH key in the Authentication tab of the Preferences page. The Authentication tab displays all SSH keys associated with your account. To add an SSH key to your account: 1. Generate an SSH key from the computer that you will use to access the project Git repository. See Generating an SSH Key. 2. Open the SSH public key file in a text editor, select the contents, and copy the SSH key. 3. In the branding bar of the Oracle Developer Cloud Service web interface, click the user name. 4. Click Preferences. 5. Click the Authentication tab. 6. Click Add Key. 7. In the New SSH Key dialog, enter a unique key name and paste the key contents that you copied in Step Click Create. 9. Click Done to return to the last opened page. Setting Notifications You can choose to receive notifications about issue and merge request updates, new features or assignments, and system maintenance updates. Your address must be verified to receive notifications. To set your notification preferences: 1. In the branding bar of the Oracle Developer Cloud Service web interface, click the user name. 2. Click Preferences. 3. Click the Notifications tab. 4. Select or deselect the desired Notify Me Of check boxes. Check Box Issue updates, attachments and comments Enable or disable notifications of issue updates. When the check box is selected, you will get notifications for the following events: An issue is created and assigned to you An issue assigned to you is updated An issue is updated and you are cc'd A comment is added to an issue assigned to you 1-15

33 Chapter 1 Working with Oracle Developer Cloud Service Projects Check Box Merge Request updates and comments New features, tips, and events Service and system maintenance updates Build activities SCM/Push Activities Include my Own Updates Enable or disable notifications of merge request updates. When the check box is selected, you will get notifications for the following events: A merge request is created and you are added as a reviewer A merge request is updated and you are cc'd A comment is added to an open merge request where you are a reviewer Another reviewer approves or rejects a merge request where you are a reviewer The merge request where you are a reviewer is merged or closed Enable or disable notifications of new features, tips, and events sent by the Oracle Developer Cloud Service team. Enable or disable service and system maintenance updates from the Oracle Developer Cloud Service team. Enable or disable build notifications for all jobs you are subscribed to in all projects of the organization. After selecting the check box, open the Build page and subscribe to notifications of the desired jobs. See Subscribing to a Job s Build Notifications. Enable or disable notifications for any activity on the Git repositories of your projects. Enable or disable notifications for your own changes. If the check box is not selected, you will not receive notifications for issues, merge requests, and SCM updates that you initiated or created even though the Issues updates, attachments and comments, the Merge Request updates and comments, or the SCM/Push Activities check box are selected. 5. Click Done to return to the last opened page. Working with Oracle Developer Cloud Service Projects An Oracle Developer Cloud Service project is a collection of features and services provided by Oracle Developer Cloud Service. For frequently asked questions, see Questions about the Welcome page and Projects. Topics About Oracle Developer Cloud Service Projects Creating a Project Opening a Project Using a Template Project About Oracle Developer Cloud Service Projects An Oracle Developer Cloud Service project is a collection of Git repositories, branch merge requests, wikis, issues, deployment configurations, and builds. 1-16

34 Chapter 1 Working with Oracle Developer Cloud Service Projects An Oracle Developer Cloud Service project can host multiple Git repositories. Each Git repository can have multiple branches and hundreds of code files. You can create a merge request for each branch of the Git repository and ask reviewers to review the code. You can create and configure multiple build jobs to generate different project artifacts and then deploy the artifacts to Oracle Java Cloud Service - SaaS Extension, publicly available Oracle Java Cloud Service instances, or Oracle Application Container Cloud Service instances. Watch a short video to learn about an Oracle Developer Cloud Service project. Video The following table describes the pages of an Oracle Developer Cloud Service project. Page Project Code Maven Releases Snippets Merge Requests Issues Agile Build Deploy Docker Registry Wiki Administration Shows the navigation bar, Git and Maven repository URLs, news feed, and the recent activities feed of the project. Shows the Git source code repositories and enables you to view files and commits, manage branches and tags, and compare the source code of files. Shows the project Maven repository and enables you to view, upload, and search artifacts. Shows the various Release configurations created for the project. Shows the snippets created by you or shared by project members. Enables you to create and manage branch merge requests, and review the code. Shows all issues of the project and enables you to create and manage tasks, defects, and new features. Enables you to manage project issues using the Agile methodology. Enables you to create and manage project builds and jobs. Enables you to create deployment configurations and deploy project artifacts to Oracle Java Cloud Service - SaaS Extension, publicly available Oracle Java Cloud Service instances, or Oracle Application Container Cloud Service instances. Shows the linked Docker registries of the project that project members can browse. Enables you to create and manage wiki pages. Enables you to configure the project properties. The Administration page is visible to project owners only. Click the Tutorial link to learn about the pages of Oracle Developer Cloud Service. Tutorial Creating a Project You can create a project from the Welcome page after logging in to Oracle Developer Cloud Service. Before you create a project, you may also want to: 1-17

35 Chapter 1 Working with Oracle Developer Cloud Service Projects Know about the technologies used by Oracle Developer Cloud Service. See Before You Begin Using Oracle Developer Cloud Service. Set up your account preferences. See Setting Oracle Developer Cloud Service Preferences. To create an Oracle Developer Cloud Service project in the web user interface: 1. From the Welcome page, click + New Project. 2. In the Project Details page of the New Project wizard, complete the elements using the descriptions in the following table. Name Security Enter the project name. The project name must be unique in the organization, must be two or more characters long, and must begin with a letter or a number and continue with letters, numbers,.(period), _(underscore), - (hyphen), or space. Enter the project description. Select the project's privacy level. Private projects are accessible to invited members only. Shared projects are accessible to all members of the organization. Any member of the organization can view the source code, create or update issues, edit wiki pages, and interact with project builds. However, only project members and owners can push changes to the Git repository and perform deployment operations on the deployment configurations. Preferred Language Specify the preferred language for your notifications. 3. Click Next. To configure notifications, see Setting Notifications. 4. In the Template page of the New Project wizard, complete the elements using the descriptions in the following table. Empty Project Initial Repository Import Project project Select to create the project with no Git repository. You can add or import a Git repository later. Select to create the project with an initial repository. You will choose initialization options in the next page of the wizard. Select to create the project with data imported from an exported project. You will choose the import options in the next page of the wizard. Select the template project. When you choose a template project, its Git source repositories, wiki pages, Maven artifacts, and build jobs are cloned to the new project. See Using a Template Project. 5. Click Next. 6. In the Project Properties page, complete the elements using the descriptions in the following table. 1-18

36 Chapter 1 Working with Oracle Developer Cloud Service Projects Wiki Markup Initial Repository Imported Data Select the project s wiki markup language. You can use the specified markup language to format the content of the wiki pages and comments in the Issues and the Merge Request pages. Specify how to initialize the Git repository. Select Empty Repository to create an empty repository. Select Initialize repository with README file to initialize the repository with a readme.md file created in the master branch. You can edit the contents of the readme.md file after the project is created. Select Import existing repository to import an existing Git repository. See Importing a Git Repository. This field is available if you selected Initial Repository in the previous page of the wizard. If you selected the Import Project option in the previous page, enter details of the Oracle Cloud Infrastructure Object Storage Classic container where the source project was exported. Storage Service URL: Enter the service URL of Oracle Cloud Infrastructure Object Storage Classic. Storage Service Name: Enter the name of the storage service. Identity Domain: Enter the identity domain name of the storage service. Account Username: Enter the username of the user who has access to Oracle Cloud Infrastructure Object Storage Classic. Account Password: Enter the password of the user. Click Connect to connect to the storage service. See Connecting to Oracle Cloud Infrastructure Object Storage Classic for more information. After successful connection, enter the container details. Storage Container: Select the storage container where the data was exported. Storage Object: Select the archive file to be imported. Note: Depending on the chosen template, you may see some additional input fields in the Project Properties page. 7. Click Finish. Watch a short video or click the Tutorial link to learn about creating an Oracle Developer Cloud Service project. Tutorial Video 1-19

37 Chapter 1 Working with Oracle Developer Cloud Service Projects Tip: If you are a NetBeans IDE or a JDeveloper user, you can create an Oracle Developer Cloud Service project in the IDE itself and push the application source code files to the project Git repository. See Creating an Oracle Developer Cloud Service Project in NetBeans IDE and Creating an Oracle Developer Cloud Service Project in JDeveloper. Opening a Project After you create a project in Oracle Developer Cloud Service, you are assigned to the Owner role and are automatically navigated to the Project page. The new project is automatically provisioned with Git and Maven repositories, and all components are activated. After creating the project, you can perform various actions such as add more Git repositories, push application source code files to the repository, and add users. See the following topics for more information. About the Project Page Typical Workflow for Oracle Developer Cloud Service Project Owners About Oracle Developer Cloud Service Project Roles Editing the Readme.md File FAQ: As a project Owner or a project Member, what can I do after I create or open a project? You can open a project from the Welcome page. If you are invited to join a project, see Accessing Oracle Developer Cloud Service Using the Web Interface and About the Oracle Developer Cloud Service Welcome Page for more information about accessing Oracle Developer Cloud Service and the Welcome page. To open a project: 1. Open the Service URL of Oracle Developer Cloud Service and sign in. 2. In the Welcome page, choose the filter toggle button (if necessary), and click the project name link to open it. The Project page of the project opens. See the As a project Owner or a project Member, what can I do after I create or open a project? FAQ to learn more about what you can do after opening a project. To open another project from an open project, click the project name and select the desired project from the Switch Project menu. 1-20

38 Chapter 1 Working with Oracle Developer Cloud Service Projects Using a Template Project If you chose a template project while creating a project, some artifacts from the template project are copied or added to the new project. The following artifacts are cloned from the template project: Git repositories All Git repositories of the template project are cloned to your project. The Git repositories contain a copy of the template project s source code. You can clone the template project repositories to your local machine, modify it, add or remove branches, and then push it back to the same repository or another repository of your choice. In the navigation bar, click Code to view the cloned Git repositories and their content. If you do not want to use a template project repository, you can delete it. See Deleting a Git Repository. Build jobs All existing build jobs of the template project are copied to your project. In the navigation bar, click Builds to see all copied jobs. You may modify these jobs or create their copies. See Configuring a Job. Deployment configurations 1-21

39 Chapter 1 Working with Oracle Developer Cloud Service Projects All existing deployment configurations of the template project are copied to your project. In the navigation bar, click Deploy to see all copied deployment configurations. Wiki pages All existing wiki pages of the template project are copied to your project. In the navigation bar, click Wiki to see all copied wiki pages. Announcements All active project announcements of the template project are cloned to your project. In the navigation bar, click Project to see all copied announcements. The announcements are read-only and cannot be edited, but they can be activated or deactivated. Note: After you create a project using a template, any updates made to the template project will not be reflected in the created project. 1-22

40 2 Developing Applications with Oracle Developer Cloud Service This section provides documentation about application development tasks for Oracle Developer Cloud Service. Topics: Typical Workflow for Oracle Developer Cloud Service Project Members About the Project Page Using the Search Box Using Git in Oracle Developer Cloud Service Browsing Source Code in Oracle Developer Cloud Service Using the Project Maven Repository in Oracle Developer Cloud Service Managing Releases in Oracle Developer Cloud Service Using Snippets in Oracle Developer Cloud Service Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service Tracking Issues in Oracle Developer Cloud Service Using the Agile Methodology in Oracle Developer Cloud Service Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Deploying an Application in Oracle Developer Cloud Service Browsing External Docker Registries in Oracle Developer Cloud Service Using Wiki Pages in Oracle Developer Cloud Service Typical Workflow for Oracle Developer Cloud Service Project Members If you are a project member, refer to the following typical application development workflow, as described in the following table. Task More Information Access Oracle Developer Cloud Service Open Projects Access the Oracle Developer Cloud Service web interface. After logging in, open an Oracle Developer Cloud Service project. All features of Oracle Developer Cloud Service are available from the project. Accessing Oracle Developer Cloud Service Working with Oracle Developer Cloud Service Projects 2-1

41 About the Project Page Task More Information Browse source code Use Snippets Review code and manage repository branch merge requests Track issues Update issues using Agile Manage project jobs and builds Deploying project artifacts Create and manage wikis Use Oracle Developer Cloud Service with OEPE, NetBeans IDE, and JDeveloper View the contents of the project repositories. Use and view snippets crated by you or shared by project members. Create and manage Git branch merge requests. Create issues for tasks, defects, and enhancements. Use the Agile methodology to track and update issues Create and manage project jobs. Tip: Before managing builds, configure the Git repository and check in your source code. Deploy project artifacts to Oracle Java Cloud Service - SaaS Extension, publicly available Oracle Java Cloud Service servers, and Oracle Application Container Cloud Service. Use the wiki to document collaboration. Use OEPE, NetBeans IDE, and JDeveloper to develop code and commit source files to Git repositories. Browsing Source Code in Oracle Developer Cloud Service and Using the Project Maven Repository in Oracle Developer Cloud Service Using Snippets in Oracle Developer Cloud Service Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service Tracking Issues in Oracle Developer Cloud Service Using the Agile Methodology in Oracle Developer Cloud Service Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Deploying an Application in Oracle Developer Cloud Service Using Wiki Pages in Oracle Developer Cloud Service Using Eclipse IDE with Oracle Developer Cloud Service, Using NetBeans IDE with Oracle Developer Cloud Service, and Using Oracle JDeveloper with Oracle Developer Cloud Service About the Project Page From the Oracle Developer Cloud Service Welcome page, click the project name to open the Project page. The Project page displays the recent activity feed of the project along with the URLs of the Maven and Git repositories, list of project team members, and the team s activity graph and statistics. About Projects See About Oracle Developer Cloud Service Projects. What You Can Do from the Projects Page See Actions You Can Perform on the Project page. For frequently asked questions, see Questions about the Project page. 2-2

42 About the Project Page What You See on the Projects Page The following table describes the key information and elements shown on the Project page. Common s The following elements are common across all pages of Oracle Developer Cloud Service. Left Navigation bar Use the navigation bar to navigate to different Oracle Developer Cloud Service pages. In the header, click the icon to show or hide the navigation bar. In the navigation bar, click to collapse the navigation bar to icon only. Click to expand the navigation bar to view icon and the label. Click to navigate back to the Welcome page. user name Project name User name of the logged in user. Click to open the user menu and select the desired options. See Using the User Menu. Open the help topic of the open page. Name of the open project. Click the project name or the icon to open the Switch Project menu. Project Page s Announcements Recent Activities News Feed Project announcements. Announcements are shown above the Recent Activities feed. Information about latest activities are listed on the left side of the page. See Using the Recent Activities Feed. Oracle Developer Cloud Service news and announcements. Click the news link to know more about it. Git, Maven, and Docker repositories of the project. See Using the Repository Tab. View your and your team s activity graph and statistics for issues and merge requests. See Using the Graphs and Statistics Tab. View team members. See Using the Team Tab. The Project page remembers the last opened tab (Repository, Graphs, or Team) in the current browser session and opens it automatically next time you open the Project page. If you log out or close the browser and then log in and open the Project page, the Repository tab will open, by default. 2-3

43 About the Project Page Using the User Menu Use the user menu to navigate to the Organization Administration pages, set your account preferences, open help topics, and sign out of Oracle Developer Cloud Service. The following options are available in the user menu. Option Organization Preferences Help About Sign Out Administer the organization. The option is visible to users with the Developer Service Administrator (DEVELOPER_ADMINISTRATOR) identity domain role. See Administering the Organization in Oracle Developer Cloud Service. Set your account preferences. See Setting Oracle Developer Cloud Service Preferences. Open the help submenu. Know more about the service. Sign out of the service. In the Sign Out page, click OK to confirm. Using the Recent Activities Feed The Recent Activities feed displays information about the recent automated actions and actions performed by project users. The activity categories include: Category Administration Announcements Atom/RSS Feeds Builds Commits Deployments Issues Maven Repository Merge Requests Project Information Release Repositories Project administration related activities, such as Git repository management, Webhook management, and project import or export. Project announcements Feeds from subscribed Atom/RSS feeds Build related activities, such as build failure or success Git repository commits Deployment activities, such as deployments to Oracle Java Cloud Service, Oracle Java Cloud Service - SaaS Extension, and Oracle Application Container Cloud Service. Issue related activities, such as issue edits, comments, and resolution status updates Maven related updates, such as artifact upload Merge request activities, such as approval or rejection of a merge request, adding or removing a reviewer, or merging or closing of a merge request Project related activities Release related activities, such as creation or update of a release Git repository activities 2-4

44 About the Project Page Category Wiki Wiki related activities, such as creation of a wiki page, or adding a comment or attachment. Click to open the category menu and click an activity category to enable or disable its notifications. At the top of the category menu, click All to enable all categories. Click None to disable all categories. Click Invert to invert the enable-disable state of all categories. Click anywhere on the page to hide the menu and refresh the activity feed. Using the Repository Tab In the Repository tab, you can view the Git, Maven, and Docker repositories of the project. This table describes the elements of the Repository tab. + New Repository Click to create a project Git repository. The button is visible to project Owners only. Filter Git Repositories All / Favorites Favorites First See the table in Creating a Hosted Git Repository to know what to enter in the fields of the dialog. To search for a Git repository, enter its name. As you type the name, the repositories list is refreshed to show the Git repositories of the project matching the search text. Click the All toggle button to view all Git repositories. Click the Favorites toggle button to view your favorite Git repositories. To sort Git repositories, click the list next to the All /Favorites toggle button and select the desired option. By default, the repositories are sorted as Favorites First. 2-5

45 About the Project Page Git Repository For each Git repository, the following information is displayed. Git repository name: Click the Git repository name link to view the contents of the default branch in the Code page. : Click the icon to mark the repository as a favorite repository and add it to the Favorites tab for quick access. HTTP/SSH: To copy the HTTP or the SSH URL of the Git repository, select the desired option in the HTTP/SSH list and then click to copy the URL to the clipboard. You may also click the URL to select it and then use the keyboard shortcut or the mouse context menu to copy the URL. The SSH option is not available for external Git repositories. Tip: If you are a project Owner, click + New Repository to create a project Git repository. See Creating a Hosted Git Repository. Maven Docker Click the Maven link to view the contents of the project Maven repository. There is only one project Maven repository and you cannot add more Maven repositories or remove the existing repository. To select and copy the HTTP or the DAV URL of the repository, click the HTTP/DAV list and then click to copy the URL to the clipboard. You may also click the URL to select it, and then use the keyboard shortcut or the mouse context menu to copy the URL. Use the HTTP URL to connect to the Maven repository using the HTTP protocol. Use DAV URL to upload artifacts to connect to the repository using the Webdav protocol. Lists all linked external Docker registries. Click the Docker link to open the Docker Registry page. For each Docker repository, the following information is displayed. Docker repository name: Click the Docker repository name link to view its contents in the Docker Registry page. HTTP: To copy the HTTP URL of the Docker registry, click to copy the URL to the clipboard. You may also click the URL to select it and then use the keyboard shortcut or the mouse context menu to copy the URL. Using the Graphs and Statistics Tab Use the Graphs and Statistics tab to view your and your team s activity graph and statistics for issues and merge requests. This table describes the elements of the Graphs and Statistics tab. 2-6

46 Using the Search Box Filter Graphs My Stats Commits Merge Requests To search for a graph, enter its name. As you type the name, the graph list is refreshed to show the graphs matching the search text. For example, enter issues to view issue graphs only. View statistics of issues and merge requests assigned to you. The statistics includes open tasks, defects and features; total number of open issues; open merge requests created by you; and open merge requests assigned to you. Click the link to run the query and open it in the respective page. View commit statistics of your team members in a pie-chart format for the specified period.. View statistics of open and closed merge requests in a pie-chart format. Using the Team Tab Use the Team tab to view project members and their assigned project roles. This table describes the elements of the Team tab. + New Member Click to add a user to the project. See Adding Users to a Project. The button is visible to project Owners only. Export project members. See Exporting List of Project Members. Filter Members All / Owners / Members Member name Search for an added project member. Click the All toggle button to view all project members. Click the Owners toggle button to view project owners only. Click the Members toggle button to view project members only. For each member, the following information is displayed: Name Owner label, if the user is a project Owner address Tip: If you are a project Owner, you can add and remove users from the project, and change their role. See Managing Project Users in Oracle Developer Cloud Service. Using the Search Box At the top of each page, a Search box is available that you can use to search artifacts of that page. The Search box is available in all pages of Oracle Developer Cloud Service, but it is disabled for some. The following table lists all pages of Oracle Developer Cloud Service where the Search box is enabled. 2-7

47 Using Git in Oracle Developer Cloud Service Page Enabled Project Yes Use the Search Box to search for an activity in the Latest Activity stream. Code Yes Use the Search box to search for a string in the selected Git repository or branch, or all Git repositories. Maven Yes Use the Search box to search for a string in the file or directory name of artifacts. Snippets Yes Use the Search box to search for a term in the snippet name, snippet author name, snippet description, and file contents of a snippet. Merge Requests Yes Use the Search box to search for a string in the merge request summary. Issues Yes Use the Search box to search for a string in the issue title or summary. Agile No NA Build Yes Use the Search box to search for a string in the job name. Deploy Yes Use the Search box to search for a string in the deployment configurations. Docker Registry No NA Wiki Yes Use the Search box to search for a string in the wiki title or content. Administration No NA Using Git in Oracle Developer Cloud Service Oracle Developer Cloud Service uses Git source control management to save and manage your application source code files. Tip: If you are new to Git, read the Git documentation at and the Git book at to learn more about Git and Git basics such as local and remote repositories, commits, SHA-1 checksum hashes, branches, tags, and push and pull branches. If you have recently created an Oracle Developer Cloud Service project or have joined one, you must first set up the Git repositories of your project. If there is no Git repository in the project, create or import a Git repository. You must be assigned the project Owner role to create or import a Git repository. When you create a repository, you can choose to create an empty repository or initialize it with a readme file, or import files and revisions from an external Git repository. To create or import a repository, click the + New Repository button in the Code page, or the Repositories section of the Project page. For information about the 2-8

48 Using Git in Oracle Developer Cloud Service fields of the New Repository dialog, see step 4 in Creating a Hosted Git Repository. Instead of importing an external remote Git repository to the project, you can also add a link to the remote repository by adding the URL of the remote repository in your project. You can do so from the Administration page and require the project Owner role. For more information about adding the URL of an external remote repository, see Adding an External Git Repository. If the project Git repository (also called as the project remote Git repository or the hosted Git repository) is empty, you can perform any of the following actions to upload your files to the repository. Clone the remote Git repository to your computer. See Cloning the Oracle Developer Cloud Service Project Git Repository. Use this option if you want to add your application source files to the repository. If your application is not ready, you may initialize the repository with a readme file or any file(s) of your choice. Push an existing local Git repository. See Pushing an Existing Local Git Repository to an Empty Oracle Developer Cloud Service Git Repository. Use this option if you have been using a local Git repository on your computer and wish to push it to the remote Git repository. Import an existing Git repository. See Importing a Git Repository Use this option if you have been using an external Git repository and wish to import its contents to the project s Git repository. If the remote Git repository is populated with the readme file or the application source code files, clone the repository to access and update its files. See Cloning the Oracle Developer Cloud Service Project Git Repository. Topics Cloning the Oracle Developer Cloud Service Project Git Repository Pushing an Existing Local Git Repository to an Empty Oracle Developer Cloud Service Git Repository Cloning the Oracle Developer Cloud Service Project Git Repository To add files or access the files of a remote Git repository, you must first clone it to your local computer. You can either use the Git command line interface or the Git integration available in IDEs to clone the remote Git repository. Using the Git Command Line Interface If you are comfortable using a command line interface, download and install the Git command line tool. After downloading the command line tool, set up and customize your Git environment. For more information, see Using the Git Command Line Interface. To clone the remote Git repository: 1. Open the Git command line interface. 2. Navigate to the directory where you want to clone the remote Git repository. 3. Enter the git clone <repository-url> command. 2-9

49 Using Git in Oracle Developer Cloud Service See Copying the URL of a Git Repository to get the Git repository s URL. HTTPS example: git clone developer1111-usoracle22222/s/developer1111-usoracle22222_myproject/scm/ developer1111-usoracle22222_myproject.git SSH example: git clone ssh://usoracle22222.john.doe %40oracle.com@developer.us.oraclecloud.com/developer1111- usoracle22222_myproject/developer1111-usoracle22222_myproject.git Note: If you are using SSH, create an SSH key and add it to Oracle Developer Cloud Service. See Generating an SSH Key. 4. Enter the password, if required. The remote Git repository is cloned to your local directory. Open the directory and verify that a.git subdirectory has been created. Do not add or modify files of the.git subdirectory. You can now add or edit the application source code files, create and manage branches, commit them to the cloned Git repository, and then push the updates to the remote Git repository. See Using Git Commands. If your application is not ready, you may initialize the Git repository with a readme file. Follow the on-screen Git commands to add a readme file to the repository, commit it, and then push the master branch to the remote repository. After cloning the repository, use the git add command to add new files. Use the git commit command to commit all added and updated files to the local Git repository. Using Git with Eclipse IDE Eclipse IDE and OEPE use EGit, an Eclipse Team provider for Git, to access and manage Git repositories. You can also use the Oracle Cloud view of IDE to clone and manage Git repositories. Using the Oracle Cloud view, you can drag and drop the OEPE project into the specific Git repository and then follow the wizard to commit and push the updates. You can also use the Oracle Cloud view to configure or update the build jobs and push dependencies to the maven repository, track issues, and monitor builds of the project. See Using the Oracle Cloud View and Using Eclipse IDE with Oracle Developer Cloud Service. To clone a remote Git repository using EGit: 1. In the IDE, open the Git Repositories view. Select Window, then Show View, and then select Git Repositories. If Git Repositories is not visible, click Other. In the Show View window, expand Git and select Git Repositories. 2. In the Git Repositories view, click Clone a Git Repository. 3. In the Source Git Repository page of the Clone Git Repository wizard, select Clone URI, and click Next. 2-10

50 Using Git in Oracle Developer Cloud Service See Copying the URL of a Git Repository to get the Git repository s URL. If you are using the SSH URL to access the repository, create an SSH key and add it to Oracle Developer Cloud Service.See Generating an SSH Key. Also, in the Remote Repository page, instead of entering the password, select the Private Key File. 4. In the Clone Git Repository dialog, enter the remote Git repository URL in URI, select the protocol in Protocol, enter the user name in User, and password in Password. Click Next. 5. In the Branch Selection page, select the branches to clone, and click Next. If the remote repository is empty, the Branch Selection page will be empty too. Click Next to continue. 6. In the Local Destination page, specify the local Git repository directory in Directory, and click Finish. The cloned repository appears in the Git Repositories view. If the cloned Git repository contains files, you can import them to an IDE project. To import the files from the cloned Git repository: 1. Right-click the cloned Git repository and select Import Projects. 2. In the Select a wizard to use for importing projects page of Import Projects from Git Repository dialog, select the desired project import option and click Next. 3. In the Import Projects page of the Import Projects from Git Repository dialog, note the project name and directory, and click Finish. The IDE project opens in the Project Explorer. For more information about how to add an IDE project to the cloned Git repository, manage branches, commit and push commands, read the EGit documentation at Using Git with NetBeans IDE NetBeans IDE uses a Git plugin to perform Git tasks in the IDE. You can also use the NetBeans IDE Oracle Developer Cloud Service Team Server plug-in to clone and manage Git repositories. Using the Team Server plug-in, you can drag and drop the NetBeans IDE project into the specific Git repository and then follow the wizard to commit and push the updates. You can also use the Team Server to track issues, and monitor builds of the project. See Using the Oracle Developer Cloud Service Team Server and Create an Oracle Developer Cloud Service Issue in NetBeans IDE. To clone a remote Git repository in NetBeans IDE: 1. In NetBeans IDE, click the Team menu, select Git, and then select Clone. 2. In the Remote Repository page of the Clone Repository wizard, enter the remote Git repository URL in Repository URL, user name in User, password in Password, and the destination directory of the cloned Git repository in Clone into. Click Next. See Copying the URL of a Git Repository to get the Git repository s URL. If you are using the SSH URL to access the repository, create an SSH key and add it to Oracle Developer Cloud Service. See Generating an SSH Key. Also, in 2-11

51 Using Git in Oracle Developer Cloud Service the Remote Repository page, instead of entering the password, select the Private Key File. 3. Select the branches of the remote repository you want to clone, and click Next. 4. If you did not specify the destination directory of the cloned repository in Step 1, specify the directory, and click Finish. For more information about how to add an NetBeans IDE project to the cloned Git repository, manage branches, commit and push commands, read the NetBeans IDE and Git documentation at Using Git with JDeveloper JDeveloper uses a Git extension to perform Git tasks in the IDE. You can download the Git extension from the Help menu. Open the Help menu and select Check for Updates. See the JDeveloper documentation for more information. You can also use the JDeveloper Oracle Developer Cloud Service Team Server plugin to clone and manage Git repositories. Using the Team Server plug-in, you can add the JDeveloper application into the specific Git repository and then follow the wizard to commit and push the updates. You can also use the Team Server to track issues, and monitor builds of the project. See Using the Oracle Developer Cloud Service Team Server and Using Oracle JDeveloper with Oracle Developer Cloud Service. To clone a remote Git repository in JDeveloper: 1. Open JDeveloper. 2. From the Team menu, select Git, then Clone. 3. In the Welcome page of the Clone from Git wizard, click Next. No action is required in the Welcome page. 4. In the Remote Repository page, enter the URL of the project s Git repository in Repository URL, user name in User Name, password in Password, and click Next. See Copying the URL of a Git Repository to get the Git repository s URL. If you are using the SSH URL to access the repository, create an SSH key and add it to Oracle Developer Cloud Service. See Generating an SSH Key. Also, in the Remote Repository page, instead of entering the password, select the Private Key File. 5. In the Destination page, specify the path of the cloned Git repository in Destination, name of the repository in Clone Name, and the branch to checkout in Checkout Branch. Click Next. 6. In the Git Clone Summary page, verify the remote repository URL, user name, remote branches to checkout, local repository path, clone name, the checkout branch, and click Finish. 7. In the New Files Dialog, if prompted, select the desired option and click OK. For more information about how to add a JDeveloper application to the cloned Git repository, manage branches, commit and push commands, read the JDeveloper Git documentation in Oracle Fusion Middleware Developing Applications with Oracle JDeveloper at

52 Using Git in Oracle Developer Cloud Service Pushing an Existing Local Git Repository to an Empty Oracle Developer Cloud Service Git Repository If your application source code is already available in a local Git repository, you can push it to the empty remote Git repository of your project. If your application source code files exist in a remote Git repository of another project or an external remote Git repository, you can import the repository to the remote Git repository of your project. The remote repository of the project must be empty. See Importing a Git Repository for more information. You can either use the Git command line interface or the Git integration available in IDEs to push the local Git repository to the remote Git repository. Using the Git Command Line Interface If you are comfortable using a command line interface, download and install the Git command line tool. After downloading the command line tool, set up and customize your Git environment. For more information, see Using the Git Command Line Interface. Before you push the local Git repository, verify that you have committed all files to the local Git repository and the remote Git repository is empty. To push a local Git repository to the remote repository: 1. Open the Git command line interface. 2. Navigate to the directory that contains your Git repository. 3. Use the git remote add <remote_repo_name> <remote_repo_url> command to add the remote Git repository of your Oracle Developer Cloud Service project to the local Git repository. See Copying the URL of a Git Repository to get the Git repository s URL. See Copying the URL of a Git Repository to get the Git repository s URL. HTTPS Example: git remote add origin %40oracle.com@developer.us.oraclecloud.com/developer1111-usoracle22222/s/ developer1111-usoracle22222_myproject/scm/developer1111- usoracle22222_myproject.git SSH example: git remote add origin ssh://usoracle22222.john.doe %40oracle.com@developer.us.oraclecloud.com/developer1111- usoracle22222_myproject/developer1111-usoracle22222_myproject.git The above example adds a remote named origin for the repository at developer.us.oraclecloud.com/developer1111-usoracle22222_myproject/ developer1111-usoracle22222_myproject.git. 2-13

53 Using Git in Oracle Developer Cloud Service Note: If you are using the SSH URL to access the repository, create an SSH key and add it to Oracle Developer Cloud Service. See Generating an SSH Key 4. Use the git push command to push the files of the desired branch to the remote Git repository. Example: git push -u origin master 5. In the Oracle Developer Cloud Service web user interface, click Code in the navigation bar and view the files in the remote Git repository. For more information about Git commands, see Tip: If you want to create a local Git repository, you can use the git init command in an empty directory. Initialization creates an empty Git repository in the specified directory with a master branch. A.git subdirectory containing metadata of the Git repository is also created. After creating the local Git repository, you can add files to the directory and commit them. Using Git with Eclipse IDE Eclipse IDE and OEPE use EGit, an Eclipse Team provider for Git, to access and manage Git repositories. Before you push the local Git repository, verify that you have committed all files to the local Git repository and the remote Git repository is empty. To push a local Git repository to the remote Git repository: 1. In the IDE, open the Git Repositories view. From the Window menu, select Show View, and select Git Repositories. If Git Repositories is not listed, click Other. In the Show View dialog, expand Git, select Git Repositories, and click OK. 2. In the Git Repositories view, click Add an existing local Git repository. Tip: If you want to create a local Git repository, click Create a new local Git repository. After creating the repository, add the IDE project it and commit the files. For more information, see Creating Repositories and Committing Changes topics in the EGit documentation at wiki.eclipse.org/egit/user_guide. 3. In the Add Git Repositories dialog, click Browse, select the Git repository directory, and click OK. In Search Results, select the check box of the Git repository, and click Finish. 2-14

54 Using Git in Oracle Developer Cloud Service 4. In the Git Repositories view, right-click the repository root, select Remote, and then select Push from the submenu. 5. In the Push to Another Repository dialog, complete the elements using the descriptions in the following table. Location: URI Authentication: Password Enter the URL of the remote Git repository. See Copying the URL of a Git Repository to get the Git repository s URL. Based on the URL, the Host, Repository path, Protocol, Port, and User fields are automatically populated. If you are using the SSH URL to access the repository, create an SSH key and add it to Oracle Developer Cloud Service. See Generating an SSH Key Enter the password. Click Next. 6. In the Push Ref Specifications page, specify the Source ref and Destination ref, and click the Add Spec to add the spec to Specifications for push list. 7. Click Finish. 8. In the Push Results dialog, click OK. 9. In the Oracle Developer Cloud Service web user interface, click Code in the navigation bar and view the files in the remote Git repository. For more information about EGit and its commands, read the following sections of the EGit documentation at Configuration in Getting Started to set up and customize EGit Starting from existing Git Repositories Working with remote Repositories Push Upstream and Pushing to other Repositories Using Git with NetBeans IDE NetBeans IDE uses a Git plugin to perform Git tasks in the IDE. Before you push the local Git repository, verify that you have committed all files to the local Git repository and the remote Git repository is empty. To push a local Git repository to the remote repository: 1. Open the Git Repository browser in NetBeans IDE. From the Team menu, select Git, and then select Repository Browser. 2-15

55 Using Git in Oracle Developer Cloud Service Tip: If you want to create a local Git repository, click Initialize Repository. After creating the repository, add the NetBeans IDE project to it and commit the files. See Initializing a Git Repository and Committing Sources to a Repository topics in the NetBeans IDE and Git documentation at 2. In the Git Repository Browser window, right-click, and select Open Repository. 3. In the Open dialog, browse, select the local Git repository directory, and click Open. 4. In the Git Repository Browser window, right-click the repository root, select Remote, and then select Push. 5. In the Remote Repository page of the Push to Remote Repository dialog, select the Specify Git Repository Location option, enter the remote Git repository URL in Repository URL, and the password in Password. Click Next. If you are using the SSH URL to access the repository, create an SSH key and add it to Oracle Developer Cloud Service. See Generating an SSH Key 6. In the Select Local Branches page, select the check box of the branch you want to push, and click Next. 7. In the Update Local References page, verify that the remote branch check box is selected, and click Finish. To continue tracking the repository updates, click Yes. 8. In the Oracle Developer Cloud Service web user interface, click Code in the navigation bar and view the files in the remote Git repository. For more information about Git commands in NetBeans IDE, read the Working with Remote Repositories section of the NetBeans IDE and Git documentation at netbeans.org/kb/docs/ide/git.html: Using Git with JDeveloper JDeveloper uses a Git extension to perform Git tasks from the IDE. You can download the Git extension from the Help menu. Open the Help menu and select Check for Updates. See the JDeveloper documentation for more information. To push the local Git repository application to the remote repository: 1. In JDeveloper, open the application that is initialized in the local Git repository. Tip: If you want to create a local Git repository, create or open the application, and from the Team menu, select Git, then Initialize. After creating the application, add project files to it and commit them. See How to Set Up and Configure a Git Repository and How to Work with New and Changed Files in Git in Oracle Fusion Middleware Developing Applications with Oracle JDeveloper at middleware. 2-16

56 Browsing Source Code in Oracle Developer Cloud Service 2. From the Team menu, select Git, and then Push. 3. In the Welcome page of the Push to Git wizard, click Next. No action is required in the Welcome page. 4. In the Remote Repository page, enter the URL of the project s Git repository in Repository URL (see Copying the URL of a Git Repository to get the Git repository s URL), user name in User Name, password in Password, and click Next. If you are using the SSH URL to access the repository, create an SSH key and add it to Oracle Developer Cloud Service. See Generating an SSH Key. Also, in the Remote Repository page, instead of entering the password, select the Private Key File. 5. In the Local Branch page, select the check box of the branch that you want to push, and click Next. 6. In the Git Push Summary page, verify the remote repository URL, user name, remote branch, local repository path, and click Finish. 7. In the Oracle Developer Cloud Service web user interface, click Code in the navigation bar and view the files in the remote Git repository. For more information about Git commands in JDeveloper, read the following sections of Oracle Fusion Middleware Developing Applications with Oracle JDeveloper at Setting Up and Configuring a Source Repository Moving Files from Remote Repositories in Git Browsing Source Code in Oracle Developer Cloud Service The Code page provides a top-down representation of the source code. You can access all associated Git repositories and view source code of the files along with visualization of code changes. Topics About the Code Page Opening a Git Repository Using the Revision Selector Menu Copying the URL of a Git Repository Viewing Directories and Files of a Repository in the Files View Viewing File Contents in the File View Managing Files of a Git Repository Viewing a File s Annotation Information in the Blame View Viewing and Downloading a File in the Raw View Viewing Logs of a Git Repository Adding Comments to Files Searching Source Code in Git Repositories Managing Branches and Tags of a Git Repository in the Refs View 2-17

57 Browsing Source Code in Oracle Developer Cloud Service Comparing Revisions About the Code Page Editing the Readme.md File The Code page, by default, opens in the Files view that lists all project Git repositories and its files. You can also view commits, branches, tags, and compare revisions of project Git repositories. About Git Repositories Oracle Developer Cloud Service uses Git source control management. Read the Git documentation at to learn more about Git and learn about Git basics such as commits, SHA-1 checksum hashes, branches, and tags. Also see Browsing Source Code in Oracle Developer Cloud Service. If you are new to Git, see Using Git in Oracle Developer Cloud Service to set up Git repositories on your computer. What You See on the Code Page No Git Repositories If no Git repositories exist in the project, click + New Repository to create a Git repository. See Creating a Hosted Git Repository. Empty Git Repository If an empty Git repository exists and you want to initialize the repository with a readme file, follow the on-screen instructions to commit and push a README.md file to the Git repository. Use the Git command line tool to run the on-screen commands. See Using the Git Command Line Interface. Populated Git Repository For a populated Git repository, the Code page opens in the Files view, by default. The following table describes the key information and elements shown on the Files view of the Code page. Repositories Revisions Files Logs Click the first drop-down list to view all Git repositories of the project and switch to another Git repository. A revision represents a snapshot of the Git repository at a given time. A revision could be a branch, a tag, or a commit. Click the drop-down list to open a menu and view all branches, tags, and commits (SHA-1 checksum hash) of the selected repository. See Using the Revision Selector Menu. Click the icon to copy the revision name to the clipboard. For example, while viewing files of a particular commit, click the icon to copy the SHA-1 checksum hash of the commit to the clipboard. (Default) Displays files of the selected repository and revision in a hierarchical structure. See Viewing File Contents in the File View. Displays the log history made to the selected repository and revision. See Viewing Logs of a Git Repository. 2-18

58 Browsing Source Code in Oracle Developer Cloud Service Refs Compare / HTTP / SSH Directories and Files Displays all branches and tags of the selected repository. See Managing Branches and Tags of a Git Repository in the Refs View Compares and displays differences between revisions (branches, tags, and commits). See About the Compare View. Click the toggle button to view the Git repository description. Click HTTP or SSH toggle button to view the HTTP or SSH URL of the Git repository. Click the repository URL in the text box to select it and click the the clipboard. icon or press Ctrl+C to copy the URL to The /HTTP/SSH toggle button is visible in the Files and Commits views only. In the Files view, the toggle button is visible at the root directory. If you are a project Owner, you can edit the repository description. Click the toggle button and then click the text box to update the description. Click to save. Directories and files of the selected Git repository and revision. For each file or directory, the following information is displayed. Directory or file name. Click the name link to open it. Last commit s comment as a link. Click the link to open the Compare page and compare the last commit with its parent. Author of the last commit Date-time stamp of the last commit + File Click to add a new file to Git repository in the current directory. See Adding a File to a Git Repository. Tip: You can update the README.md file from the Files view. The contents of the README.md file are edited using the Markdown Wiki markup language. See Editing the Readme.md File. If you are an Owner of the project, you can add additional Git repositories to the project or import an existing Git repository to an empty Git repository. See Managing Repositories in Oracle Developer Cloud Service. What You Can Do from the Code Page See Actions You Can Perform on the Code page and Git Repositories. For frequently asked questions, see Questions about the Code Page and Git. Opening a Git Repository You can open a Git repository and view its contents in the Code page. To open a Git repository: 1. In the navigation bar, click Code. 2-19

59 Browsing Source Code in Oracle Developer Cloud Service 2. In the Repositories list, select the Git repository whose contents you want to view. You can also click the Git repository name link in the recent activities feed or the Git repository section of the Project page to view its contents. Using the Revision Selector Menu The Revision Selector menu displays all branches, tags, and commits of the selected Git repository. To switch to a commit that was merged using a Merge Request, click the Merge tab and select the SHA-1 checksum hash of commit. To search for a commit, in the search box at the top of the menu, enter the first three characters of the SHA-1 checksum hash of the commit. Commit that matches the search term appears next to the icon at the bottom of the menu. To switch to a branch, click the Branches tab and select the branch name from the list. To search for a branch, in the search box at the top of the menu, enter the branch name. All branches matching the search term are listed. For an exact match, add a space at the end of the search term. To switch to a tag, click the Tags tab and select the tag name from the list. To search for a tag, in the search box at the top of the menu, enter the tag name. All tags matching the search term are listed. For an exact match, add a space at the end of the search term. The Recent tab shows the recently accessed branches, tags, and SHA-1 checksum hash of commits. You can also use the search box at the top of the menu to search for a branch or a tag. The Parents tab shows the parent revision of the selected revision. Click the icon to copy the revision name to the clipboard. For example, while viewing files of a particular commit, click the icon to copy the SHA-1 checksum hash of the commit to the clipboard. To search for any commit, in the search box at the top of the menu, enter the first three characters of the SHA-1 checksum hash of the commit. Commit that matches the search term appears next to the Copying the URL of a Git Repository and its Files icon at the bottom of the menu. From the Code page, you can copy the URL of a Git repository, the URL of a file in the Git repository, and the URL of a line in a file of the Git repository and share it. Topics Copying the URL of a Git Repository Copying the URL of a File Copying the URL of a Line of a File Before you share the URL, remember that only the users who are a member of the project can open the URL. If the project is a shared project, organization members can also open the URL. 2-20

60 Browsing Source Code in Oracle Developer Cloud Service Copying the URL of a Git Repository You can copy a Git repository s HTTP or SSH URL from the Code page and the Project page. Copying the URL of a Git Repository from the Code page To copy the Git repository URL from the Code page: 1. Open the Git repository in the Code page whose URL you want to copy. See Opening a Git Repository. 2. Click the HTTP or the SSH toggle button. 3. Click at the end of the URL to copy the URL to the clipboard. You can also select the repository URL displayed in the text box and press Ctrl + C or use the context menu to copy the URL to the clipboard. Copying the URL of a Git Repository from the Project page To copy the Git repository URL from the Project page: 1. In the navigation bar, click Project. Copying the URL of a File 2. If required, click the icon on the right side of the Project page. 3. For the Git repository whose URL you want to copy, select HTTP or SSH. 4. Click to copy the URL to clipboard. You may also select the URL and press Ctrl + C or use the context menu to copy the URL to the clipboard. You can copy a file s direct URL from the Code page that you can share or bookmark. To copy the URL of a file: 1. Open the Git repository in the Code page that contains the file whose URL you want to copy. See Opening a Git Repository. 2. Browse and open the file in the File view. 3. In the address bar of the browser, select the URL, and then press Ctrl + C or use the context menu to copy the URL to the clipboard. Copying the URL of a Line of a File You can copy the direct URL of line in a file you can share or bookmark. To copy the URL of a line in a file: 1. Open the Git repository in the Code page that contains the file whose URL you want to copy. See Opening a Git Repository. 2. Browse and open the file in the File view. 2-21

61 Browsing Source Code in Oracle Developer Cloud Service 3. Click the line number in the number column on the left side of the line. The entire line is selected. 4. In the address bar of the browser, select the URL, and then press Ctrl + C or use the context menu to copy the URL to the clipboard. 2myfile.txthttp://developer.us2.oraclecloud.com/my-org/#projects/demo/scm/ demo.git/blob/myfile.txt?revision=master&sl=2myfile.txtdemo.gitmaster2 Note: To copy the URL of a group of lines of a file, open the file in the File view, click the line numbers with the Shift key pressed. The clicked lines are highlighted. In the address bar of the browser, copy the URL. Example: With the Shift key pressed, clicking line numbers 2 through 5 of myfile.txt selects those lines. The URL in the browser s address bar updates to developer.us2.oraclecloud.com/my-org/#projects/demo/scm/demo.git/blob/ myfile.txt?revision=master&sl=2 5. When you open the URL, the myfile.txt file of the demo.git repository master branch opens with line numbers 2 through 5 selected. Viewing Directories and Files of a Repository in the Files View The Files view displays files of the selected Git repository and the revision. Along with the contents of the repository, the page displays the file path, author of the file, the date-time stamp, and the message of the last commit that modified the file. You can also add, edit, and delete files of the Git repository. To view files and directories of a Git repository: 1. In the navigation bar, click Code. 2. On the right side of the page, click Files, if necessary. 3. Click the Repositories list and select the Git repository. 4. Click the list that is next to the Repositories list and select the revision. See Using the Revision Selector Menu. The files and directories of the selected Git repository and revision are displayed. To view the contents of a file, click the filename to open it. The selected file opens in a read-only code editor. Viewing File Contents in the File View The File view displays the contents of the open file. About the File View The File view displays the contents of the open file and enables you to switch to the blame view, and view it in the raw format. You can also edit the file contents in a code editor, rename it, and delete it. 2-22

62 Browsing Source Code in Oracle Developer Cloud Service Open the File View To open the File view: 1. Open the Files view in the Code page. See Viewing Directories and Files of a Repository in the Files View. 2. Browse and click a file name to open it. What You See In the Code File View The following table highlights the elements of the File view of the Code page. Repositories Revisions File Blame Logs Refs Compare File path File Type Icon Commit details Click the first drop-down list to view all Git repositories of the project and switch to another Git repository. A revision represents a snapshot of the Git repository at a given time. A revision could be a branch, a tag, or a commit. Click the drop-down list to open a menu and view all branches, tags, and commits (SHA-1 checksum hash) of the selected repository. See Using the Revision Selector Menu. Click the icon to copy the revision name to the clipboard. For example, while viewing files of a particular commit, click the icon to copy the SHA-1 checksum hash of the commit to the clipboard. (Default) (Default) Displays the file contents. Displays the annotation information for each code line (or group of code lines). See Viewing a File s Annotation Information in the Blame View. Displays the history of the file. See Viewing Logs of a Git Repository. Displays all branches and tags of the selected repository. See Managing Branches and Tags of a Git Repository in the Refs View Compares and displays differences between revisions (branches, tags, and commits). See About the Compare View. The file path of the open file. Click to copy the file path to the clipboard. An icon indicating the type of file. Details of the last commit. The details include author name, date-time stamp, and the commit description. To compare the last commit of the file with its parent, click the commit description link. All files that were updated or added in that particular commit are displayed in the Compare view Click to edit the contents of the open file. See Editing a File of a Git Repository. Click to open the Edit menu. Edit: Edit the contents of the file. The action is same as clicking the icon. Delete: Delete the file. See Deleting a File of a Git Repository. Raw: Displays the file s download URL and its unformatted contents in the web browser. See Viewing and Downloading a File in the Raw View. 2-23

63 Browsing Source Code in Oracle Developer Cloud Service File Contents Contents of text files and images are displayed. Contents of binary files are not displayed. If the text content exceeds the width of the editor, use the arrow keys to scroll left, right, up, and down. You can also use the scroll buttons to scroll horizontally. Hover mouse on the left and right edge of the editor to view the and the buttons and then click them to scroll one character at a time. Managing Files of a Git Repository From the Code page, you can add new files and folders, edit contents of files, rename them, and delete files of a Git repository from the Code page. Topics Adding a File to a Git Repository Editing a File of a Git Repository Deleting a File of a Git Repository Adding a File to a Git Repository On the Code page, you can add a text based file to a Git repository. To add a file to a Git repository: 1. Open the Files view. 2. Select the Git repository and revision. 3. Browse to the directory name where you want to add the file. 4. Click + File in the bottom-right corner below the file list. 5. In File Name, enter the name of the file along with its extension. 6. In the code editor, enter file contents. 7. Click Commit to save the file. 8. In the Commit Changes dialog, enter the commit summary in the first text box. By default, it is Create <file name>. The summary must start with a capital letter and must not be greater than 72 characters. 9. In the Details text box, enter commit details. By default, the text box is empty. 10. Click Commit. 2-24

64 Browsing Source Code in Oracle Developer Cloud Service Tip: To save the file in a new directory or a directory structure, in File Name, enter the file path. You can enter a relative path or an absolute path. To specify an absolute path, add a / in the beginning. Example: Enter test/text_file.txt to save the text_file.txt file in a new test directory on the current path. Enter /test/text_file.txt to save the text_file.txt file in a new test directory on the root. Editing a File of a Git Repository From the Code page, you can edit any text file. To edit a file of a Git repository: 1. Open the Files view. 2. Select the Git repository and revision. 3. Browse and open the file. 4. Click. 5. Edit the file contents in the code editor. To rename the file or path, change its name in the file name text box. You can enter a relative path or an absolute path. 6. Click Commit to save the file. 7. In the Commit Changes dialog, enter the commit summary in the first text box. By default, it is Update <file name>. The summary must start with a capital letter and must not be greater than 72 characters. 8. In the Details text box, enter commit details. By default, the text box is empty. 9. Click Commit. Deleting a File of a Git Repository From the Code page, you can delete any file including binary files. To delete a file of a Git repository: 1. Open the Files view. 2. Select the Git repository and revision. 3. Browse and open the file. 4. Click next to, and select Delete. 5. In the Delete file dialog, enter the commit summary in the first text box. By default, it is Delete <file name>. 2-25

65 Browsing Source Code in Oracle Developer Cloud Service The summary must start with a capital letter and must not be greater than 72 characters. 6. In the Details text box, enter commit details. By default, the text box is empty. 7. Click Delete. Note: After all files of a directory are deleted, the directory is automatically removed from the Git repository. Viewing a File s Annotation Information in the Blame View The Blame view displays annotations of the open file. About the Blame View The Blame view displays the annotation information such as commit, author, date-time stamp of the commit, and the commit message for each code line (or group of code lines). Open the Blame View 1. Open the file in the Files view. 2. Click Blame. What You See In the Code Blame View The following table highlights the elements of the Blame view of the Code page. Repositories Revisions File Blame Logs Refs Compare Click the first drop-down list to view all Git repositories of the project and switch to another Git repository. A revision represents a snapshot of the Git repository at a given time. A revision could be a branch, a tag, or a commit. Click the drop-down list to open a menu and view all branches, tags, and commits (SHA-1 checksum hash) of the selected repository. See Using the Revision Selector Menu. Click the icon to copy the revision name to the clipboard. For example, while viewing files of a particular commit, click the icon to copy the SHA-1 checksum hash of the commit to the clipboard. Displays the file contents. Displays the annotation information for each code line (or group of code lines). Displays the history of the file. See Viewing Logs of a Git Repository. Displays all branches and tags of the selected repository. See Managing Branches and Tags of a Git Repository in the Refs View Compares and displays differences between revisions (branches, tags, and commits). See About the Compare View. 2-26

66 Browsing Source Code in Oracle Developer Cloud Service File path Commit details File Annotation The file path of the open file. Click to copy the file path to the clipboard. Details of the file s last commit. The details include author name, datetime stamp, and the commit description. To compare the last commit of the file with its parent commit, click the commit description link. All files that were updated or added in that particular commit are displayed in the Compare view The following annotation information for each code line (or group of code lines) is displayed in a read-only code editor The first seven characters of the commit s SHA-1 checksum hash. Click the SHA-1 hash link to view full diff view of the changes made to the file in the Compare view. Click the >> icon next to the SHA-1 hash link to view the state of the opened file in that particular revision in the Blame view. The name of the author of the commit The date-time stamp of the commit The commit description If the text content exceeds the width of the editor, use the arrow keys to scroll left, right, up, and down. You can also use the scroll buttons to scroll horizontally. Hover mouse on the left and right edge of the editor to view the buttons and then click them to scroll one character at a time. Viewing and Downloading a File in the Raw View Use the Raw view to view the file s unformatted contents in the web browser and copy the file s download URL from the browser s address bar. To open a file in the Raw view: 1. Open the file in the Files view. 2. Click next to, and select Raw. The contents of the opened file are displayed in a new tab or a window of the web browser. If the file is a text file or an image (such as.png,.jpg,.bmp, and.gif), it is displayed in the browser. Copy the file s URL from the browser s address bar for sharing and downloading. You might be asked to provide Oracle Developer Cloud Service credentials while downloading the file after the browser session is closed. Note: The contents of a binary file such as.zip and.rar are not displayed, but you can use the file s URL to download it. When you choose the Raw option, depending on your browser settings, the browser might start downloading the file immediately or open the Save As or the Download dialog box. 2-27

67 Browsing Source Code in Oracle Developer Cloud Service Viewing Logs of a Git Repository You can view the logs of a Git repository revision in the Logs view of the Code page. You can view the commits history in the Commits view and the commits, branching, and merging history in the Graph view. Topics Viewing the Commit History List About the Commit History List View Viewing the Commit History Graph About the Commit History Graph View Viewing the Commit History List You can view the commit history of a Git repository or a file in the Commit History List view. To view the Commit History List view: 1. Open the Code page. 2. Select the Git repository and revision. 3. Click Logs. 4. If necessary, click the toggle button. About the Commit History List View The Commit History List view shows all commits made to the selected repository and revision, or the open file, in a list format. You can view details of the commit and compare it with other revisions. What You See In the Code Logs Commit History List View The following table highlights the elements of the Commit History List view of the Code page. Repositories Revisions File Click the first drop-down list to view all Git repositories of the project and switch to another Git repository. A revision represents a snapshot of the Git repository at a given time. A revision could be a branch, a tag, or a commit. Click the drop-down list to open a menu and view all branches, tags, and commits (SHA-1 checksum hash) of the selected repository. See Using the Revision Selector Menu. Click the icon to copy the revision name to the clipboard. For example, while viewing files of a particular commit, click the icon to copy the SHA-1 checksum hash of the commit to the clipboard. Displays the file contents. 2-28

68 Browsing Source Code in Oracle Developer Cloud Service Blame Logs Refs Compare File path (Optional) Displays the annotation information for each code line (or group of code lines). Displays the history of the selected Git repository and revision, or the open file. Displays all branches and tags of the selected repository. See Managing Branches and Tags of a Git Repository in the Refs View Compares and displays differences between revisions (branches, tags, and commits). See About the Compare View. (Optional) The file path of the open file. Click to copy the file path to the clipboard. Click to view the commit history in a list view. Click to view the commit history in a graph view. Revisions list Commit list Revisions whose commit history is displayed. By default, the selected revision is added to the list. To add another revision, enter or select the revision in the text box. To view history of all branches of the Git repository, remove all branch names from the text box. The commit history of selected file, or Git repository and revisions. For each commit, the following information is displayed: Date or time header Labels, names of the branches, merge requests, and tags that were updated by the commit. Commit message Any text matching an active link rule appears as a link. For example, if you entered an issue ID in the commit message (such as Updates for Task 1), the issue ID (Task 1) appears as a link pointing to the issue in the Issues page. Commit author s profile image, author name, and the date-time stamp of the commit. Click the author name to send an to it. A button with the first seven characters of the commit s SHA-1 checksum hash as the label. Click the button to open the Compare view that displays the compare result of all files that were committed in that particular commit. To copy the SHA-1 checksum hash name to the clipboard, click. A Code button that displays all files of the current path in the Files view at the time of the commit. A Show Details link that opens a list of all files that were updated. Click the file name to compare the file changes with its parent commit in the Compare view. See About the Compare View. Viewing the Commit History Graph You can view the commit history graph a Git repository or a file in the Commit History Graph view. To view the Commit History Graph view: 2-29

69 Browsing Source Code in Oracle Developer Cloud Service 1. Open the Code page. 2. Select the Git repository and revision. 3. Click Logs. 4. Click the toggle button. About the Commit History Graph View The Commit History Graph view displays a graph of the commits, and the branching and merging history of the selected Git repository or branch, or the open file. You can also view details of the commits. What You See In the Code Logs Commit History Graph View The following table highlights the elements of the Commit History Graph view of the Code page. Repositories Revisions File Blame Logs Refs Compare File path Click the first drop-down list to view all Git repositories of the project and switch to another Git repository. A revision represents a snapshot of the Git repository at a given time. A revision could be a branch, a tag, or a commit. Click the drop-down list to open a menu and view all branches, tags, and commits (SHA-1 checksum hash) of the selected repository. See Using the Revision Selector Menu. Click the icon to copy the revision name to the clipboard. For example, while viewing files of a particular commit, click the icon to copy the SHA-1 checksum hash of the commit to the clipboard. Displays the file contents. (Optional) Displays the annotation information for each code line (or group of code lines). Displays the history of the selected Git repository and revision, or the open file. Displays all branches and tags of the selected repository. See Managing Branches and Tags of a Git Repository in the Refs View Compares and displays differences between revisions (branches, tags, and commits). See About the Compare View. (Optional) The file path of the open file. Click to copy the file path to the clipboard. Click to view the commit history in a list view. Click to view the commit history in a graph view. Revisions list Revisions whose commit history graph is displayed. By default, the selected revision is added to the list. To add another revision, enter or select the revision in the text box. 2-30

70 Browsing Source Code in Oracle Developer Cloud Service Commit graph The commit history graph of selected file, or Git repository and revisions. In the graph: Each dot represents a commit. Click the dot to open a popup to see the details of the commit and a list of files that were updated. A splitting line represents a branch. Joining lines represent a merge. Latest commits appear at the top of the graph. For each commit, the following information is displayed:: Labels, names of the branches, merge requests, and tags that were updated by the commit. Click the name link to open it. The seven character SHA-1 checksum hash of the commit. Click the SHA-1 checksum hash link to open the commit in the Commits view. IDs of merge requests affected by the commit. Click the ID link to open the merge request. Comment of the commit along with the date-time stamp and author of the commit. Any text matching an active link rule appears as a link. For example, if you entered an issue ID in the commit message (such as Updates for Task 1), the issue ID (Task 1) appears as a link pointing to the issue in the Issues page. Adding Comments to Files You can add comments to files in the Compare view. To add a comment to a file: 1. Open the Compare view. 2. Compare the revisions that affected the file. 3. In the Changed Files tab. 4. Mouse over the line number of the file and click the icon. You can add comments to the current version of the file. If you have selected the Unified view, click the line number in the second column. If you have selected the Side by Side view, click the line number of the file on the right. 5. In the Leave a comment box, enter the comment, and click Comment. 6. In the commits history list, click the button that has the commit s SHA-1 checksum hash as the button label. The file opens in the Compare view. The comment is added as an inline comment to the file and is visible to all project members. To reply to a comment, click the icon on the right side of the comment, enter the comment in the Leave a reply box, and click Comment. If you don t know the commit that changed the file, open the Logs view, and click to view all commits that changed the file. To open the file in the Compare view, click the commit s SHA-1 checksum hash button. 2-31

71 Browsing Source Code in Oracle Developer Cloud Service Searching Source Code in Git Repositories You can search for a term in the files of Git repositories of the project. You can search a term in the source code, file paths, and file revisions. You can further refine your search by specifying a revision in the Git repository. The search field is language aware and supports auto-suggest. You can enter search terms of common programming languages such as HTML, JavaScript, CSS, and Java, and the search box will automatically suggest terms. You can search for symbols (class and function names) and file names. The search box supports CamelCase too. Search a term in a Git repository and revision 1. Open the Git repository in the Code page. See Opening a Git Repository. 2. Select the revision. See Using the Revision Selector Menu. 3. In the Search Code box available in the top-right corner of the page, enter the search term or select it from the suggestion list. 4. Click the icon. Search a term in all Revisions of a Git repository 1. Open the Git repository in the Code page. See Opening a Git Repository. 2. Select the revision. See Using the Revision Selector Menu. 3. In the Search Code box available in the top-right corner of the page, enter the search term or select it from the suggestion list. 4. Click the icon. 5. In the list, click the icon. The list shows the All Revisions option. Search a term in all Git repositories 1. Open the Git repository in the Code page. See Opening a Git Repository. 2. Select the revision. See Using the Revision Selector Menu. 3. In the Search Code box available in the top-right corner of the page, enter the search term or select it from the suggestion list. 4. Click the icon. 2-32

72 Browsing Source Code in Oracle Developer Cloud Service 5. Click the Repositories list and select the All Repositories option, or click the icon. The search result page displays all files, file paths, and file revisions that contain or match the search term. All tab displays the result of all search tabs. Content tab displays the search term in the file contents along with its line number. In the search result, click the source file name to open it in the File view, or click the content line with the search term to open the source file in the File view highlighting the search term content line and its line number. Paths tab displays the search term in file paths. Click the path link to open the path in the File view. Revisions tab displays the file revisions that contain the search term. Click the revision link to open the revision in the Compare view. Symbols tab displays the file revisions that contain the search symbol (class and function names). Click the file name link to open the symbol. To reset the search, click in the Search Code box. Managing Branches and Tags of a Git Repository in the Refs View You can create and manage branches and tags of a Git repository in the Refs view of the Code page. Topics Viewing Branches of a Git Repository About the Branches View Managing Branches of a Git Repository Viewing Tags of a Git Repository About the Tags View Managing Tags of a Git Repository Viewing Branches of a Git Repository You can view the branches of a Git repository in the Branches view. To open the Branches view: 1. Open the Code page. 2. Select the Git repository and revision. 3. Click Refs. About the Branches View 4. If necessary, click the toggle button. The Branches view lists all branches of the selected Git repository. 2-33

73 Browsing Source Code in Oracle Developer Cloud Service Branching enables you to work on different features and updates at any given time without affecting the original source code. Before you start working on a new feature or update major portions of the source code, you should create a branch and commit your changes to the new branch. This way your changes do not affect the original source code and are safe to test and review. To know more about the Git branch workflow, read the Git Branching - Branching Workflows topic in the Git book at To merge a branch with another, you should create a merge request. See Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service. What You See In the Code Refs Branches View The following table highlights what you can do from the Branches view. Repositories Files Logs Compare Click the list to view and the change the current Git repository. Click the list to view and change the base revision. Displays the files of the selected Git repository and revision. Displays the history of the selected Git repository and revision. Compares and displays differences between revisions (branches, tags, and commits). See About the Compare View. Click to switch to the Branches view. Filter By Name/Recently Updated /Oldest Updated list Show Stale Click + New Branch Click to add a branch. to switch to the Tags view. Enter the search text and click the search icon to search for a branch. Click the list box and select the desired option to sort the branch list by By Name, Recently Updated (default), and Oldest Updated. Select the check box to see stale branches in the branch list. The check box is not selected by default. See Creating a Branch in the Git Repository. 2-34

74 Browsing Source Code in Oracle Developer Cloud Service Branch List Lists all branches of the selected repository. For each branch, the following information is shown: Branch name Click the name link to view the contents of the branch in the Files view. Branch labels (if any) Examples: DEFAULT label appears if the branch is the default branch of the repository RESTRICTED label appears if any restrictions are set on the branch STALE label appears if commits have not been made to the branch for some time Details of the last commit on the branch: SHA-1 checksum hash link and the commit message Click the SHA-1 checksum hash link to view all files that were committed Merge request name link, if any merge request has merged to the selected branch Number of commits ahead and behind the base revision, if any. Click it to open the Compare view where you can compare the branch s commits with the base revision. Date-time stamp Author name For each branch, the following buttons are available on the right: cc : Subscribe to notifications for commits made to the repository s branch. : Delete the branch. See Deleting a Git Repository Branch. You cannot delete a restricted or the default branch. : Click to open a menu with the following options: Subscribe: Subscribe to notifications for commits made to the repository s branch. The action is same as the cc button. Compare: Compare the branch with the master branch. See Comparing a Git Repository Branch. Branch: Create another branch from the head (tip) of the current branch. See Creating a Branch From an Existing Branch. Rename: Rename the branch. See Renaming a Git Repository Branch. You cannot rename a restricted branch. Delete: Delete the branch. The action is same as the button. Download: Select zip or tgz from the submenu to download a zip file or the tgz file of the branch. See Downloading the Archive of a Git Repository Branch. 2-35

75 Browsing Source Code in Oracle Developer Cloud Service Managing Branches of a Git Repository By default, all Git repositories contain one default master branch. However, you can add more branches to the repository from the Branches view. You can also subscribe to notifications for commits made to the repository s branch, compare, rename, and delete them. Creating a Branch in the Git Repository You can create a branch in the project Git repository from the Branches view of the Code page. To create a branch: 1. In the navigation bar, click Code. 2. Click Refs. 3. If necessary, click to switch to the Branches view. 4. Click the Repositories list and select the repository where you want to create the branch. 5. Click + New Branch. 6. In the New Branch dialog, enter the branch name in Name and select the base revision name from the Base drop-down list. 7. Click Create. The branch with the specified name is created and the contents of the base branch are copied to it. An error is reported if the base revision does not exist. Note: You cannot create a branch in an empty repository. You must first clone the repository to your local computer, add and commit files to the default master branch, and then push the branch to the project Git repository. After the default local branch is pushed to the project Git repository, you can create more branches in the repository. Creating a Branch From an Existing Branch You can create a branch from the head (tip) of another branch from the Branches view of the Code page. To create a branch from an existing branch: 1. In the navigation bar, click Code. 2. Click Refs. 3. If necessary, click to switch to the Branches view. 4. Click the Repositories list and select the repository that contains the base branch. 2-36

76 Browsing Source Code in Oracle Developer Cloud Service 5. In the Branch list, click on the right of the base branch name and select Branch. 6. In the New Branch dialog, enter the name of the new branch. 7. Click Create. A branch with the specified name is created and the contents from the head of the base branch are copied to it. Renaming a Git Repository Branch You can rename a Git repository branch from the Branches view of the Code page. To rename a Git repository branch: 1. In the navigation bar, click Code. 2. Click Refs. 3. If necessary, click to switch to the Branches view. 4. Click the Repositories list and select the repository that contains the branch you want to rename. 5. In the Branch list, click on the right of the branch name and select Rename. 6. In the Rename Branch dialog, enter the new branch name in New Name. 7. Select the I want to rename the branch check box to confirm. 8. Click Rename. When you rename a branch, Git creates a branch with the new name and transfers all content from the old branch to the new branch. After the transfer is complete, the old branch is removed. Note: When you rename a branch, you must update all related merge requests, build jobs, and deployment configurations to use the new branch name. You cannot rename a restricted branch. Comparing a Git Repository Branch You can compare a Git repository branch with the master branch from the Branches view of the Code page. To compare a branch: 1. In the navigation bar, click Code. 2. Click Refs. 3. If necessary, click to switch to the Branches view. 2-37

77 Browsing Source Code in Oracle Developer Cloud Service 4. Click the Repositories list and select the repository that contains the branch you want to compare. 5. In the Branch list, click on the right of the branch name that you want to compare with the master branch and select Compare. If required, you can change the base branch in the compare result page. You can also compare a branch with other revisions in the Compare view of the Code page. See About the Compare View. Downloading the Archive of a Git Repository Branch You can create and download the archive of a Git repository branch from the Branches view of the Code page. To create and download the archive of a branch: 1. In the navigation bar, click Code. 2. Click Refs. 3. If necessary, click to switch to the Branches view. 4. Click the Repositories list and select the repository that contains the branch you want to archive. 5. In the Branch list, click on the right of the branch name, select Download, and then select zip or tgz. A zip file or a tgz file is downloaded on your local computer. Deleting a Git Repository Branch You can delete a Git repository branch from the Branches view of the Code page. To delete a Git repository branch: 1. In the navigation bar, click Code. 2. Click Refs. 3. If necessary, click to switch to the Branches view. 4. Click the Repositories list and select the repository that contains the branch you want to delete. 5. In the Branch list, click on the right of the branch name. You cannot delete a restricted branch. 6. In the Delete Branch dialog, select the I want to delete the branch check box to confirm. 7. Click Delete. Note: When you delete a branch, you must update, close, or remove all related merge requests, build jobs, and deployment configurations. 2-38

78 Browsing Source Code in Oracle Developer Cloud Service Viewing Tags of a Git Repository You can view the tags of a Git repository in the Tags view. To open the Tags view: 1. Open the Code page. 2. Select the Git repository and revision. 3. Click Refs. About the Tags View 4. Click the toggle button. The Tags view lists all tags of the selected repository. Tagging enables you to mark a specific point in time in the history of the repository. For example, you can create a tag to mark the repository state of a stable release of the application. What You See In the Code Refs Tags View The following table highlights what you can do from the Tags view. Repositories Files Logs Compare Click the list to view and the change the current Git repository. Click the list to view and change the base revision. Displays the files of the selected Git repository and revision. Displays the history of the selected Git repository and revision. Compares and displays differences between revisions (branches, tags, and commits). See About the Compare View. Click to switch to the Branches view. Filter By Name/Recently Updated /Oldest Updated list Click + New Tag Click to create a tag. to switch to the Tags view. Enter the search text and click the search icon to search for a branch. Click the list box and select the desired option to sort the tag list by By Name, Recently Updated (default), and Oldest Updated. See Adding a Tag in the Git Repository. 2-39

79 Browsing Source Code in Oracle Developer Cloud Service Tag List Lists all tags of the selected repository. For each tag, the following information is shown: list displays its name, the SHA-1 code of the last commit to the repository when the tag was created, the comment of the last commit, date-time stamp of the last commit, and the author name of the last commit. Tag name Click the name link to view the state of the repository at the time the tag was created. Details of the last commit on the branch: SHA-1 checksum hash link and the commit message Click the SHA-1 checksum hash link to view all files that were committed Date-time stamp Author name For each tag, the following buttons are available on the right: : Delete the tag. See Deleting a Git Repository Tag. : Click to open a menu with the following options: Compare: Compare the tag with the master branch. See Comparing a Git Repository Tag. Branch: Create a branch from the current tag. See Creating a Branch From an Existing Branch. Rename: Rename the tag. See Renaming a Git Repository Tag. Managing Tags of a Git Repository Delete: Delete the tag. The action is same as the button. Download: Select zip or tgz from the submenu to download a zip file or the tgz file of the repository when the tag was created. See Downloading the Archive of a Git Repository Tag. The Tags view lists all tags of the selected repository. You can create more tags, compare, rename, and delete them. Adding a Tag in the Git Repository You can create a tag in the project Git repository from the Tags view of the Code page. To create a tag: 1. In the navigation bar, click Code. 2. Click Refs. 3. Click to switch to the Tags view. 4. Click the Repositories list and select the Git repository where you want to create the tag. 5. Click + New Tag. 2-40

80 Browsing Source Code in Oracle Developer Cloud Service 6. In the New Tag dialog, enter the tag name in Name and the base revision name in Base. 7. Click Create. The tag with the specified name is created. An error is reported if the base revision does not exist. Renaming a Git Repository Tag You can rename a tag of the project Git repository from the Tags view of the Code page. To rename a Git repository tag: 1. In the navigation bar, click Code. 2. Click Refs. 3. Click to switch to the Tags view. 4. Click the Repositories list and select the Git repository that contains the tag. 5. In the Tag list, click on the right of the tag name and then select Rename. 6. In the Rename Tag dialog, enter the new tag name in New Name. 7. Select the I want to rename the tag check box to confirm. 8. Click Rename. Comparing a Git Repository Tag You can compare a Git repository tag with the master branch from the Tags view of the Code page. To compare a tag: 1. In the navigation bar, click Code. 2. Click Refs. 3. Click to switch to the Tags view. 4. Click the Repositories list and select the repository that contains the tag you want to compare. 5. In the Tag list, click on the right of the tag name that you want to compare with the master branch and then select Compare. If required, you can change the base branch in the compare result page. You can also compare a tag with other revisions in the Compare view of the Code page. See About the Compare View. Downloading the Archive of a Git Repository Tag You can create and download the archive file of a Git repository tag from the Tags view of the Code page. To create and download the archive file of a tag: 1. In the navigation bar, click Code. 2-41

81 Browsing Source Code in Oracle Developer Cloud Service 2. Click Refs. Deleting a Git Repository Tag 3. Click to switch to the Tags view. 4. Click the Repositories list and select the repository that contains the tag you want to archive. 5. In the Tags list, click on the right of the tag name, select Download, and then select zip or tgz. A zip file or a tgz file is downloaded and saved on your local computer. You can delete a tag of the project Git repository from the Tags view of the Code page. To delete a Git repository tag: 1. In the navigation bar, click Code. 2. Click Refs. 3. Click to switch to the Tags view. 4. Click the Repositories list and select the Git repository that contains the tag. 5. In the Tag list, click on the right of the tag name. 6. In the Delete Tag dialog, select the I want to delete the tag check box to confirm. 7. Click Delete. Comparing Revisions You can compare any two revisions and view the differences such as file updates, additions, and removal of files. Topics Comparing Differences Between Revisions About the Compare View Reviewing the Compare Result in the Compare Page Comparing Differences Between Revisions You can use the Compare view to compare two revisions of a Git repository. To compare two revisions: 1. Open the Code page. 2. Click Compare. 3. In first list on the left, select the base revision. In the second list, select the target revision. By default, the Code page selects the last commit to the repository as the base revision and the selected revision as the target revision. 2-42

82 Browsing Source Code in Oracle Developer Cloud Service About the Compare View You can use the Compare view to compare changes made to a Git repository between any two revisions. You can compare the following: Branch versus branch Tag versus tag Commit versus commit Branch versus tag Commit versus branch Tag versus commit What You See on the Code Compare Page The following table describes the key information and elements shown in the Compare view. Repositories Base Revision Compare Revision More Click the list to view and change the current Git repository. The base revision indicates the starting point of the comparison. Click the list to change the base revision. The revision could be a branch, tag, or a commit SHA-1 checksum hash. If you clicked the SHA-1 checksum hash button (or the file name link in the Show Details list) of the Commits view or the Files view, by default, the commit (or the file) is compared with its parent commit. To change the parent commit (base revision), click Any of the Parents/Any toggle box and select the branch, tag, or another commit s SHA-1 checksum hash. The compare revision indicates the end point of the comparison. Click the list to change the compare revision. The revision could be a branch, tag, or a commit SHA-1 checksum hash. To compare the compare revision with a parent of the base revision, click the base revision list, click the Parents tab, and click the SHA-1 checksum hash of the parent commit. Click to switch the base revision and the compare revision. Click to select the option as From Merge Base or Revisions. Select From Merge Base (...) to show the differences between the base revision and the compare revision since the last common commit of both revisions. Select Revisions (..) to show the differences between the heads (or tips) of the base revision and the compare revision. If the commit message is a long message, click More to view the complete commit message. 2-43

83 Browsing Source Code in Oracle Developer Cloud Service + Merge Request/ Merge Request <id> Changed Files tab Commits tab If a merge request exists with the Compare Revision as the review branch, click the button to open the merge request page. See About the Merge Request Review Page. If a merge request does not exist, click + Merge Request to create a merge request with Base Revision as the target branch and the Compare Revision as the review branch. See Creating a Merge Request. Displays the tree view list of changed files. Displays the commit differences if From Merge Base (...) is selected in. Reviewing the Compare Result in the Compare Page The Compare page shows differences between the base revision (on the left) and the compare revision (on the right). If a file has changed, the differences are shown as colored overlays indicating additions and subtractions from a file. The compare result is displayed in the Changed Files tab and the Commits tab. The Changed Files tab lists files that have changed between the base revision and the compare revision. In, if you selected From Merge Base, the Commits tab lists all commits that have happened between the base revision and the compare revision since their common commit. The following table describes the key information and elements shown on the Changed Files tab and the Commits tab. 2-44

84 Browsing Source Code in Oracle Developer Cloud Service Changed Files tab Click to open the tree view list of changed files. Click the file name to navigate to it. The selected file name appears in bold. If multiple files have changed, click to open the next file and click to open the previous file. In the open file, click to see the next change and click to see the previous change. Click to open the following compare options: Synchronized Scrolling: Enable or disable the synchronized horizontal scrolling for the Side by Side view. It is enabled by default Side by Side: Shows a side-by-side comparison of the file. Unified: Shows a unified view of the changes made to the file. Summary: Shows a summary of changes of all changed files. Full File: Shows the full contents of all files that have changed, one by one. Ignore Whitespace: Ignore white space updates, such as spaces and tabs, while comparing. Collapse All: Hide updates of all files. Show: Select more options for comparing files. All options are selected by default. * Comments: Show or hide comments of the compared file. * Edits: Show or hide edits of the compared files. * Additions: Show or hide new lines added to the compared files. * Deletions: Show or hide lines removed from the compared files. * Renames: Show or hide files that were renamed in the compared revision. For each file in the tab, the following information is displayed: Number of code lines that have changed File name Click the file name link to view its contents in the Files view. Code difference as colored overlays Click the Hide link to hide the file content. Comments added by project members. To add a comment or reply to a comment, see Adding Comments to Files. 2-45

85 Using the Project Maven Repository in Oracle Developer Cloud Service Commits tab For each commit, the following information is displayed: Commit message, author name, and the date-time stamp of the commit. A button with the first seven characters of the commit s SHA-1 checksum hash as the label. Click the button to see the compare result of all files that were committed in that particular commit. To copy the SHA-1 checksum hash name to the clipboard, click. A Code button that displays all files of the current path in the Files view at the time of the commit. A Show Details link that opens a list of all files that were updated. Click the file name to compare the file changes with its parent commit in the Compare view. See About the Compare View. Editing the Readme.md File You can edit the README.md file from the Code page and then commit it to the Git repository from the Code page itself. You edit and update contents of the README.md file using the Markdown wiki markup language. To edit the README.md file: 1. In the navigation bar, click Code. 2. Click the README.md file name link. 3. Click the icon. 4. In the Edit tab, add or update the contents of the README.md file. Click the Markdown Reference link to open the cheat sheet of the markup language. 5. Click the Preview tab to preview the wiki. 6. Enter the commit message in the text box below the wiki edit area. By default, the commit message is Update README.md. 7. Click Commit Changes. The README.md file is updated and committed to the Git repository. Using the Project Maven Repository in Oracle Developer Cloud Service When a project is created, Oracle Developer Cloud Service creates a hosted Maven repository, also called as the project Maven repository. You can access the Maven repository from the Maven page. You can populate the Maven repository of a project and use that repository among other projects of the organization. You can use the Maven repository for local builds as well as Oracle Developer Cloud Service builds. 2-46

86 Using the Project Maven Repository in Oracle Developer Cloud Service Topics About the Maven Page Browsing the Project Maven Repository About the Browse View Uploading Artifacts to the Project Maven Repository About the Upload View About the Maven Page Searching Artifacts in the Project Maven Repository About the Artifact Search View Reviewing the Maven Artifact Search Result Downloading Artifacts from the Project Maven Repository Using the Maven page, you can view, upload, download, and search for artifacts on the project Maven repository. About Maven Repository You use the hosted project Maven repository to store artifacts that you need for your project. To know more about Maven, see What You Can Do from the Maven Page See Actions You Can Perform on the Maven page to know more about you can do on the Maven page. For frequently asked questions, see Questions about the Maven Page and the Project Maven Repository. What You See on the Maven Page When you open the Maven page, you open the Browse view (default) of the Maven page. The following table lists the different views of the Maven page. Browse (default) Upload Artifact Search Browse artifacts uploaded to the project Maven repository. See About the Browse View. Upload files to the project Maven repository. See About the Upload View. Search artifacts in the project Maven repository. See About the Artifact Search View. 2-47

87 Using the Project Maven Repository in Oracle Developer Cloud Service Note: If you see the No Storage Configured error message, contact the Organization Administrator (a user with the Developer Service Administrator identity domain role) to enable the storage configuration of the organization. If you are the Organization Administrator, configure the storage configuration of the organization. See Configuring the Oracle Cloud Infrastructure Object Storage Classic Connection. Browsing the Project Maven Repository You can open and browse the project Maven repository from the Maven page. The Browse view is the default view of the Maven page when you open it. About the Browse View To open the project Maven repository: 1. In the navigation bar, click Maven. 2. If necessary, on the right side of the page, click Browse. You can also click Maven name link in the Repositories section on the Project page. The Browse view lists all artifacts of the Maven repository or the selected directory on the left. Select an artifact to view its details on the right. What You See on the Maven Browse View The following table lists all elements of the Maven repository page. Breadcrumb navigation Artifacts list Select All Invert Selection Delete The path of the open directory. Click the directory name link to view the contents of the parent directory. Lists all directories and artifacts in the project Maven repository. The version directories (such as 1.0 SNAPSHOT) in an artifacts directory are sorted based on the information available in the mavenmetadata.xml file. The artifacts directory is available in the group id directory. Selects check boxes of all listed artifacts. Inverts the selection status of the check boxes of the listed artifacts. Deletes selected artifacts. Click to open the menu and select the Show size and last updated date check box. When selected, the artifacts list shows the size and the last updated date of each artifact. 2-48

88 Using the Project Maven Repository in Oracle Developer Cloud Service Artifact Details Select an artifact on the left to view its details on the right. The artifact details include the artifact name, repository path, size, and the last updated date. For the root directory of the Maven repository, the Distribution Management information is also shown. You can click in distribution management information area to select and then copy the information to your project s POM file for deploying the related artifacts to the project's Maven repository. For the selected versioned artifact directory or file, the following information is shown: Info section Name of the artifact file Download icon to download the artifact Coordinate Information (group id, artifact id, and version) Last updated date Repository path Size SHA-1 Checksum and MD5 Checksum Dependency Declaration section Maven tab: Displays the XML snippet with POM coordinates for the Maven build tool. Click the icon to copy the XML snippet to the clipboard. In some browsers, you might need to press Ctrl+C to copy the code to the clipboard after clicking the icon. Gradle tab: Displays the build script with dependency information for the Gradle build tool. Click the icon to copy the script to the clipboard. In some browsers, you might need to press Ctrl+C to copy the code to the clipboard after clicking the Uploading Artifacts to the Project Maven Repository icon. Using the Upload view, you can upload artifacts manually to the project s Maven repository from the Maven page without installing Maven on your computer. To upload artifacts to the project Maven repository: 1. In the navigation bar, click Maven. 2. On the right side of the page, click Upload. 3. In the Upload Artifacts section, drag and drop the artifact files; or click the select artifact files link, browse, and select the files. 4. In the table below the Upload Artifacts section, if necessary, update the Classifier field of the selected artifact. If you are uploading only one artifact, you may leave the classifier field empty. If you are uploading more than one artifact, provide the classifier value for all artifacts. 2-49

89 Using the Project Maven Repository in Oracle Developer Cloud Service The classifier helps to distinguish artifacts that were built from the same POM file but differ in their content. The classifier string is appended to the artifact name just after the version number. For example, if you are uploading artifacts with same names but different extensions (such as filex-1.0.jar and filex-1.0.pdf), you may provide classifiers (such as main and documentation) for these files. While uploading the files will be renamed to filex-1.0-main.jar and filex-1.0-documentation.pdf. 5. After adding the artifacts, specify their Maven coordinates manually or from a POM file. The coordinates are used during uploading artifacts to the hosted maven repository. 6. Click Start Upload. About the Upload View You can track the transfer status and its progress in the drop area of the Upload Artifacts section. To cancel the upload process, click Cancel Upload. The upload process is also cancelled if the page is refreshed or closed. The upload process validates the artifacts and scans them with the virus scanner, before deploying them. While the artifacts are being uploaded, you can navigate to other pages of Oracle Developer Cloud Service and continue your work. After the upload process is complete, the upload activity is logged in the Recent Activity Feed of the Project page. To upload dependencies to the project Maven repository while running a build, see Configuring the POM File to Upload or Download Dependencies from the Project Maven Repository. If you are comfortable using the Maven command line, you can use Maven commands to upload artifacts. See Using the Maven Command Line Interface. Using the Upload view, you can upload artifacts manually to the project s Maven repository from the Maven page without installing Maven on your computer. What You See on the Maven Upload View The following table lists all elements of the Maven repository page Upload view. Manually GroupId Version ArtifactId Specify the Group ID of the artifact. You can select the ID from the list or start typing and then select the ID from the list of suggestions. The auto-suggest list is based on the Maven indexes. If no index data is available, the auto-suggest list will not appear. Specify the version of the artifact. You can select the version from the list or start typing and then select it from the list of suggestions. The auto-suggest list is based on the Maven indexes. If no index data is available, the auto-suggest list will not appear. If necessary, update the artifact ID. By default, the field is populated with the file name of the artifact. The auto-suggest list is based on the Maven indexes. If no index data is available, the auto-suggest list will not appear. 2-50

90 Using the Project Maven Repository in Oracle Developer Cloud Service Packaging Generate POM Target Path where selected artifacts will be Uploaded From a POM file Using the Maven Command Line Interface Specify the packaging type of the artifact. By default, the check box is selected. The upload process deploys the artifact and generates the default POM file, maven-metadata.xml, and associated sha1/md5 checksum files. If maven-metadata.xml already exists, it is updated. If you deselect the check box, the upload process deploys the artifact to the target deployment path based on Maven attributes. The POM and maven-metadata.xml files are not generated. The path where the artifacts will be deployed. To specify Maven coordinates from a POM file, select the From a POM File option and drag and drop the POM file in the drop area. You can specify only one POM file. You can use the Maven command line interface with the WebDAV protocol to upload artifacts to the hosted Maven repository. The Maven repository URL is available on the Project page of your project. Use the dav: URL to upload files and the URL to view them in the browser. To upload artifacts to the Maven repository from the command line: 1. Download and install Maven on your local machine. You can download Maven from 2. Open MVN_HOME/conf/settings.xml in a text editor and make the following changes. a. Specify the proxy server, if necessary. Example: <proxies> <proxy> <active>true</active> <protocol>http</protocol> <host>proxy_url</host> <port>80</port> <nonproxyhosts> *.somewhere.com</nonproxyhosts> </proxy> </proxies> b. Specify a unique ID and your Oracle Developer Cloud Service user name and password for the hosted Maven repository. Example: <servers> <server> <id>remoterepository</id> <username>username</username> <password>password_in_plaintext</password> </server> </servers> 2-51

91 Using the Project Maven Repository in Oracle Developer Cloud Service c. Specify a unique ID, name, and URL of the hosted Maven repository. You will find the Maven repository URL in the Project page. Example: <profiles> <profile> <id>default</id> <repositories> <repository> <id>remoterepository</id> <name>my Remote Repository</name> <url>dav: /maven/</ url> <layout>default</layout> </repository> </repositories> </profile> </profiles> 3. Open the command line and upload files to the hosted Maven repository. a. Ensure that MVN_HOME/bin is available in the PATH variable. b. Navigate to the directory that contains the files that you want to upload. c. Create the pom.xml file, if it has not been created already. For more information about pom.xml, see introduction/introduction-to-the-pom.html. d. Run the mvn deploy command to upload files. Example: mvn deploy:deploy-file -DpomFile=c:\myproject\pom.xml -Dfile=c: \myproject\myfile.jar -DrepositoryId=remoteRepository -X - Durl=dav: /maven/ Note: The credentials in settings.xml are not required to access the project Maven repository when running a build. The Build job has full access to the project Maven repository for uploads and downloads. Searching Artifacts in the Project Maven Repository You can search for artifacts in the project Maven repository by Maven coordinates from the Artifact Search view of the Maven page. To search artifacts in the project Maven repository: 1. In the navigation bar, click Maven. 2. On the right side of the page, click Artifact Search. 3. Complete the elements using the descriptions of fields in the What You See on the Maven Artifact Search View section. 4. Click Search. 2-52

92 Using the Project Maven Repository in Oracle Developer Cloud Service About the Artifact Search View The Artifact Search view enables you to search artifacts in the project s Maven repository from the Maven page by combination of various fields. What You See on the Maven Artifact Search View The following table describes the key information and elements shown on the Artifact Search view. GroupId ArtifactId Version Classifier Show Advanced Options Specify the Group ID of the artifact. Specify the artifact ID. Specify the version of the artifact. Specify the classifier value. Click to view more search options. Size: Specify the minimum and the maximum size criteria of the artifact. You can specify the size in KB, MB, and GB using the drop-down list. Updated: Specify the before and since date criteria of the artifact. Reviewing the Maven Artifact Search Result The search result is grouped by Maven coordinates in the Artifacts (default) tab and by files in the Files tab. You can perform following actions on the search result: Select All check box: Select the check box to select all artifacts or files of the current tab. When selected, a message displays the number of artifact(s) selected for deletion Delete: Click to delete selected artifacts or files. The page then lists files marked for deletion and also shows the total size of the artifacts marked for deletion. Click Yes Delete All to confirm. Click button to return to the search result page. Page Size: Specify the number of results that they want to see in the tab. : Click and select the Show size and last updated date check box to add a Size (Last Updated) column to the search result that displays the size of the Main artifacts' (and not that of classifiers). In the result, you can click the ArtifactId name/link of the artifact to see the details of the artifact in the browse page. If the artifact search result list exceeds the configured page size count, you can use the page navigation arrows at the bottom to navigate between pages. Downloading Artifacts from the Project Maven Repository You can download artifacts manually from the Browse view of the Maven page. To download an artifact manually from the project Maven repository: 2-53

93 Managing Releases in Oracle Developer Cloud Service 1. In the navigation bar, click Maven. 2. If necessary, on the right side of the page, click Browse. 3. Browse and select the artifact that you want to download. 4. With the artifact selected, in Artifact Details on the right, click. The browser downloads the artifact and saves it to your computer. To download dependencies from the project Maven repository while running a build, see Configuring the POM File to Upload or Download Dependencies from the Project Maven Repository. Managing Releases in Oracle Developer Cloud Service A Release is a collection of tags or branches of Git repositories, binary artifacts, and Maven artifacts. Topics About the Releases Page Creating a Release About the New Release Page About Release States Editing or Cloning a Release About the Edit Release Page Changing a Release s Status Downloading Artifacts of a Release Deleting a Release About the Releases Page The Releases page enables you to create a Release, edit a Release, view details, clone a Release, or delete a Release. About Releases A Release in Oracle Developer Cloud Service is a collection of specific tags or branches of Git repositories, specific binary artifacts of project Maven repository, and specific binaries that are available for users to download. When a project non-member opens a shared project, the user can choose to download sources snapshot of specified branch or tag of the project Git repository, binary artifacts of the project Maven repository, specified binaries, and archived build artifacts. This way you can manage and choose releases of your software that are available to download. Project owners and members can always create or edit a release. Non-members can not edit or create a release. Remember that if the project is not shared, it will be not be available to non-members. 2-54

94 Managing Releases in Oracle Developer Cloud Service What You See on the Releases Page No Releases If no release exist in the project, click + New Release to create release. See About the New Release Page. Populated with Releases The following table highlights the elements of the Release page. New Release Release List Release Title and tag Binaries Builds Maven Artifacts Repositories Notes Create a Release. See About the New Release Page. Lists all releases along with their descriptions and tags. Click a Release to view its details on the right. For the selected release, the name, description, date-time stamp when the release was created or modified, and tag is displayed. Click the Edit Clone Delete icon on the right to choose any of the following actions: Lists all binary files of the Release. The file names and their sizes are displayed. In the File table, click the file name link to download the file individually. Lists all specified jobs, builds of jobs, build status, and a link to a zip file to download the artifacts of the specified build. Lists all artifact files of the Release. The artifacts, groups, and versions are displayed. In the artifact table, click the Artifact name link to open the artifact in the Browse view of the Maven page. Lists all repositories of the Release. The repository name, tag, and the zip, tar.gz download links are displayed. In the repositories table, click the Git repository name link to open the repository in the Code page, of the Maven page. Click the zip or tar.gz link to download zip or tar.gz archive file of the listed Tag. View notes made for the Release. Creating a Release What You Can Do from the Releases Page See Actions You Can Perform on the Releases page to know more about you can do on the Releases page. For frequently asked questions, see Questions about the Releases Page and Configuring Releases of a project. You can create a Release from the Releases page. To create a Release: 1. In the navigation bar, click Releases. 2-55

95 Managing Releases in Oracle Developer Cloud Service 2. In the Releases page, click + New Release. 3. Scroll to the top of the page and click Save. About the New Release Page The New Release page enables you to create a new release and identify artifacts that are available for the release. What You See on the New Release Page The following table describes the key information and elements shown on the New Release page. Name Status Builds Enter the release name. Select the release status tag as Draft, Pre-Release, or Public. See About Release States. Enter the release description. In the Builds section, specify the artifacts you want to add to the release. In Job, select the job name. In Build, select the build number of the job. Select Last Build to specify the last build of the job. In Artifacts, select the artifact. Select all in zip to make all artifacts of the specified job-build to be added to the release. Select Store to store the artifact in the storage, in case the specified job or build is removed. Click when you are done. All artifacts of the specified jobs and builds will be available for download. To remove a job, click at the right. Note: If you specified Last Build as the Build of a job, when you change the status of the release to Public, the last build of the job will be used. Make sure that the last build is successful and has generated desired artifacts. 2-56

96 Managing Releases in Oracle Developer Cloud Service Maven Artifacts In the Maven Artifacts section, specify all Maven artifacts of the release. To add an artifact, select or enter the artifact s group ID in GroupId, artifact ID in ArtifactId, and version in Version. You can select the ID from the list or start typing and then select the ID from the list of suggestions. The auto-suggest list is based on the Maven indexes. If no index data is available, the auto-suggest list will not appear. Click when you are done. Repositories Notes To remove an artifact, click at the right side. In the Repositories section, view all Git repositories branch/tag attached to the release. To add a Git repository to the release, enter or select the Git repository in Repository, tag name in Tag, and branch in Branch. Click when you are done. If you enter an existing tag name, it will be used when the release s status is marked as Public. If you enter a tag name that does not exist, the Git repository tag will be created when the release is marked as Public. To remove a repository, click repository. at the right side of the added Git Enter the release notes in the Page Text tab. Preview the notes in the Preview tab. You can also use the project s wiki markup language to format the notes. About Release States A release can be in one of the following states: Draft, Pre-Release, and Public. Draft Set the release s status to Draft when you and your team is working on the features of the release. When you create a release, you specify the Maven artifacts and the Git repository tags that will be available for download. While adding a Git repository to a release, you will want to specify a branch that has the stable code at the time of release. Usually, it is the master branch, but you can specify any branch name. You will also want to specify the Git repository tag that indicates the stable state of the branch. Usually, the tag is created before the release when the code in the branch is stable. While creating a release, if you specify a tag name that has not been created, it will be automatically created when you change the status of the release to Public. If you specify an existing tag name, it will be used. Pre-Release Set the release s status to Pre-Release when you and your team has completed all feature, staged the software, and are waiting for approvals to release the software. 2-57

97 Managing Releases in Oracle Developer Cloud Service This indicates that the release is stable, but might have some issues that might need fixing before the release is Public. You might want to edit the release and update the Maven artifacts, Git repositories, tags, or branch names if they have changed while the release was in the Draft state. See About the Edit Release Page. Public Set the release s status to Public when you and your team is ready to release the software, or has already released the software. While creating a release, if you specify a tag name that has not been created, it will be automatically created for the specified branch when the release is set to Public. If you have specified an existing tag name, it will be used. This might be useful when you create a release which is already public. You might want to edit the release and update the Maven artifacts, Git repositories, tags, or branch names if they have changed while the release was in the Pre-Release or the Draft state. See About the Edit Release Page. Editing or Cloning a Release You can edit a Release s name and description, tag name, and other details from the Edit Release page. When you clone a release, you can change all fields of the page. To edit or clone a release: 1. In the navigation bar, click Releases. 2. In the Releases page, select the release that you want to edit or clone. 3. Click the icon on the right of the details page and choose Edit or Clone. 4. Scroll to the top of the page, and click Save. About the Edit Release Page The Edit Release page opens when you edit a release or clone it. What You See on the Edit Release Page The following table describes the key information and elements shown on the Edit Release. Name Status Enter or edit the release name. Select the release status tag as Draft, Pre-Release, or Public. See see About Release States. Enter or edit the release description. 2-58

98 Managing Releases in Oracle Developer Cloud Service Binaries Builds Maven Artifacts Repositories Notes In the Binaries section, view all added binaries of the release. To add binary files, in the Drop section, drag and drop the binary files that you want to include in the release. Select the Choose Files link, browse, and then select files manually. Click Attach Files to add files. To remove an attached binary file, click binary file size. at the right side of the You cannot add a binary file when you create a release. In the Builds section, specify build jobs and their builds whose artifacts you want to add to the release. In Job, select or enter the job name. In Build, select or enter the build number of the specified job. Select Last Build to specify the last build of the job. Click when you are done. All artifacts of the specified job and build will be available for download. If you specified Last Build as the Build of a job, when you change the status of the release to Public, the last build of the job will be used. Make sure that the last build is successful and has generated desired artifacts. To remove a job, click at the right. In the Maven Artifacts section, view all artifacts of the release. To add an artifact, enter the artifacts group ID in GroupId, artifact ID in ArtifactId, and version in Version. Click To remove a job, click at the right side. when you are done. In the Repositories section, view all Git repositories branch/tag attached to the release. To add a repository, enter or select the Git repository in Repository,tag name in Tag, and branch in Branch. Click you are done. To remove a repository, click at the right side. when Enter or edit the release notes in the Page Text tab. Preview the notes in the Preview tab. You can also use the project s wiki markup language to format the notes. Changing a Release s Status You can change the status of a release from the Edit Release page. To change the status of a release: 1. In the navigation bar, click Releases. 2. In the Release list, select the release whose status you want to change. 3. Click the icon on the right and select Edit. See About the Edit Release Page. 4. In the Edit Release page, change the selected option in Status option buttons to the desired option. 2-59

99 Managing Releases in Oracle Developer Cloud Service The name of the release at the top of the page shows the selected release state. To know more about release states, see About Release States. 5. Click Save. A notification about the change in the state of the release is displayed in the Activity Feed of the Project page. Downloading Artifacts of a Release You can download the artifacts of a release individually from the Releases page. The following artifacts can be downloaded for a Release: Binary files from the Binaries section Build artifacts of successful builds from the Builds section Maven artifacts from the Maven Artifacts section An archive of a tag of a Git repository in the Repositories section Downloading Binary Files 1. In the navigation bar, click Releases. 2. In the Release list, select the release whose artifacts you want to download. 3. Expand the Binaries section, if required. 4. For each file you want to download, click the file name link in the File column. Save the file at the desired location on your computer. Downloading Build Artifacts 1. In the navigation bar, click Releases. 2. In the Release list, select the release whose artifacts you want to download. 3. Expand the Builds section, if required. 4. For each artifact you want to download, click the zip link in the Artifact column. You can download artifacts of successful builds only. Save the file at the desired location on your computer. Downloading Maven Artifacts 1. In the navigation bar, click Releases. 2. In the Release list, select the release whose artifacts you want to download. 3. Expand the Maven Artifacts section, if required. 4. For each artifact you want to download, click the name link in the Artifact column. Save the file at the desired location on your computer. Downloading Git Repository Archives of Tags 1. In the navigation bar, click Releases. 2. In the Release list, select the release whose artifacts you want to download. 3. Expand the Repositories section, if required. 2-60

100 Using Snippets in Oracle Developer Cloud Service Deleting a Release 4. For a tag s archive file you want to download, click the zip or the tar.gz link in the Download column. Save the file at the desired location on your computer. You can delete a release from the Release page. To delete a release: 1. In the navigation bar, click Releases. 2. In the Releases page, select the release that you want to delete. 3. Click the icon on the right of the details page and choose Delete. 4. In the Delete Release dialog box, select the Are you sure you want to delete <release_name> release? check box. 5. Click Delete. Using Snippets in Oracle Developer Cloud Service Snippet files are small pieces of useful and reusable content, such as code or commands, which you can share with your project members. Topics About the Snippets Page Creating a Snippet About the Snippet Details Page Managing Files of a Snippet Adding Comments to a Snippet Sharing and Liking a Snippet Downloading an Archive of the Snippet Inserting a Snippet File Copying a Snippet File s Contents Creating a Snippet from Selection Using Git with Snippets Deleting a Snippet About the Snippets Page Using the Snippets page, you can create a snippet, view snippets shared by team members, and view your favorite snippets. About Snippets A Snippet in Oracle Developer Cloud Service hosts code files in a Git repository, enabling you to view, edit, and track the history of the files using Git commands. The content in snippet files may not be code, but it should be useful. The content could be 2-61

101 Using Snippets in Oracle Developer Cloud Service some notes that you want to share with project members, or something you want to keep private to yourself. For a shared snippet, the project members can copy or download the snippet files and then use it in their own applications. See Using Snippets in Oracle Developer Cloud Service. What You See on the Snippets Page No Snippets If there are no snippets in your project, click the New Snippet button to create a snippet. Existing Snippets The following table highlights the elements of the Snippets page. View Lists links to view your snippets, shared snippets, and your favorite snippets. The following links are available: My Snippets: Displays all snippets created by you Shared Snippets: Displays all snippets shared by the project members Favorite Snippets: Displays your favorite snippets + New Snippet Create a snippet. See Creating a Snippet. Snippets Shows the snippets in the selected View. For each snippet, the following information is shown: Name of the member who created the snippet. Click the member name link to see all snippets created by the member. Snippet name. Click the name link to open the snippet. Date-time stamps when the snippet when was created and updated Snippet description Icons indicating the shared status and the favorite status of the snippet. indicates a private snippet indicates a shared snippet indicates you have not marked the snippet as a favorite Recently Updated First / Most Popular First indicates you have marked the snippet as a favorite Number of project members who have liked the snippet (marked the snippet as their favorite) First ten lines of the first file of the snippet Click to open the drop-down list and select the order in which the snippets are displayed. To search for a snippet, enter the search term in the Search box at the top of the page. You can search for a term in the snippet name, snippet author name, snippet description, and file contents of a snippet. 2-62

102 Using Snippets in Oracle Developer Cloud Service Creating a Snippet What You Can Do from the Snippets Page See Actions You Can Perform on the Snippets page. For frequently asked questions, see Questions about the Snippets Page and Snippet Files. You can create a snippet from the Snippets page. A Snippet can contain several files. You will add the files after creating the snippet. To create a snippet: 1. In the navigation bar, click Snippets. 2. Click New Snippet. 3. In the New Snippet dialog, complete the elements using the descriptions in the table. Name Visibility Enter a name for the snippet. Enter a description for the snippet. Select Private if you do not want to share the snippet with project members. Select Shared to share the snippet with project members. 4. Click Create. The snippet is created and opens. Now you can add files to the snippet. Viewing and Editing a Snippet You can open a snippet from the Snippets page to view its files. If you own the snippet, you can configure its properties and edit its files. To open and view a snippet: 1. In the navigation bar, click Snippets. 2. In Views, click the desired view. Your snippets are available in the My Snippets view. Snippets shared by project members are available in the Shared Snippets view. 3. Click the snippet name link. The Snippet Details page opens. If you own the snippet, the Edit Snippet page opens. 2-63

103 Using Snippets in Oracle Developer Cloud Service About the Snippet Details Page You can view and edit a snippet from the Snippet Details page. What You See on the Snippet Details Page The following table describes the key information and elements shown on the Snippet Details page. Snippet name New Snippet Save drop-down list Cancel Delete Project member name Date-time stamp / / HTTP/SSH Click to go back to the Snippets page. Displays the name of the snippet. If you own the snippet, click the Create a snippet. See Creating a Snippet. icon to edit the name. Save the snippet updates. From the drop-down list, click Save to save the updates. Click Save and Exit to save the updates and exit the snippet. The button is available in the Edit Snippet page of a snippet you own. Cancel the updates and restore the snippet and its files to the previous state. The button is available in the Edit Snippet page of a snippet you own. Delete the snippet and its files. The button is available in the Edit Snippet page of a snippet you own. Name of the project member who created the snippet and owns it. Click the name link to view all snippets owned by the project member. The name link is available only for shared snippets that you do not own. The date-time stamp when the snippet was created and updated. The description of the snippet. The field is available in the Edit Snippet page of the snippet you own. Indicates the shared status of your snippet. The icon is available in the Edit Snippet page of the snippet you own. Click the Eye icon to toggle the share state of the snippet. See Sharing and Liking a Snippet. Indicates the favorite status of the snippet and the number of members who like it. Click the Star icon to toggle the favorite status of the snippet. See Sharing and Liking a Snippet. The Git repository URL of the snippet. Click HTTP to see the HTTP URL of the Git repository. Click SSH to see the SSH URL of the Git repository. You can use Git tools to clone the snippet repository and then use the files as desired. You can add and update files in the local Git repository, but you can push the updates to the snippet Git repository only if you own the snippet. 2-64

104 Using Snippets in Oracle Developer Cloud Service zip/tgz Snippet files Comments Click the zip button to download a.zip file of the snippet. Click the tgz button to download a.tgz file of the snippet. See Downloading an Archive of the Snippet. Displays the code of all files of the snippet. For each file, you can do the following: Click the icon to copy the file content to the clipboard. In some browsers, you must press Ctrl+C to copy the code to the clipboard after clicking the icon. Click the Hide link to hide the code of the file. The link is available in the Snippet Details page of shared snippets that you do not own. If you own the snippet, see Managing Files of a Snippet to configure and manage files of the snippet. Displays comments. Enter new comments in New Comment. Managing Files of a Snippet You can add, edit, and delete files of a snippet that you own. You cannot modify the shared snippets owned by other project members. Adding Files To add files to a snippet: 1. Open the snippet. See About the Snippet Details Page. 2. Click the Add File button at the bottom of the page. 3. In the file name text box, modify the default file name and extension, if required. Based on the file extension, the file icon on the left of the filename changes automatically. 4. If necessary, click the icon to copy the file content to the clipboard. In some browsers, you must press Ctrl+C to copy the content to the clipboard after clicking the icon. 5. In the editor, enter the file content. The editor supports various features such as autocomplete, indentation, syntax highlighting, code folding, and bracket matching. 6. To control indentation and word wrapping in all files, use the drop-down lists in the header bar of any file. Indent drop-down list: Specify whether to use Tabs or Spaces for indenting. Indent Size drop-down list: Select the predefined indent size number. 2-65

105 Using Snippets in Oracle Developer Cloud Service Wrap Lines drop-down list: Select the desired option to enable or disable word wrapping. The selected values are applied to all files of the snippet. 7. At the top of the page, click Save. From the drop-down list, select Save to save the updates. Click Save and Exit to save the updates and exit the snippet. Editing Files To edit files of a snippet: 1. Open the snippet. See About the Snippet Details Page. 2. If necessary, rename the file and configure its properties. 3. In the editor, if necessary, update the file contents. The editor supports various features such as autocomplete, indentation, syntax highlighting, code folding, and bracket matching. 4. At the top of the page, click Save. From the drop-down list, select Save to save the updates. Click Save and Exit to save the updates and exit the snippet. Deleting Files To delete files of a snippet: 1. Open the snippet. See About the Snippet Details Page. 2. For the file that you want to delete, in the file header, click the icon on the right. 3. In the Delete Snippet File dialog, click Yes to confirm. 4. At the top of the page, click Save. From the drop-down list, select Save to save the updates. Click Save and Exit to save the updates and exit the snippet. Adding Comments to a Snippet You can add comments on a snippet in the Comments section. You can also edit and delete your comments. To add a comment on a snippet: 1. Open the snippet. See About the Snippet Details Page. 2. Scroll down to the Comments section. 3. Enter the comment in the comment box and click Add. To format the comment, see Formatting Comments using the Wiki Markup Language. 2-66

106 Using Snippets in Oracle Developer Cloud Service To edit a comment that you added, click the Edit Comment dialog and click Save. To delete a comment that you added, click the dialog, click Yes. icon. Update the comment in the icon. In the Delete Comment Sharing and Liking a Snippet You can share any snippets that you own, and you can like any snippet by marking it as a favorite. You can like any shared snippet or a snippet that you own. To share a snippet: 1. In the navigation bar, click Snippets. 2. Open the My Snippets view. 3. Click the icon of the snippet to share it. The icon changes to. You can also open the snippet and click the icon from the Edit Snippet page. The shared snippet and its files are available to all members of the project in their Shared Snippets view. The snippet is removed from the view when you click the To like a snippet: icon to mark the snippet as private. The icon changes to. 1. In the navigation bar, click Snippets. 2. Open the My Snippets or the Shared Snippets view. 3. Click the of the snippet. The icon changes to. You can also open the snippet and then click the icon from the Snippet Details page. Your liked snippets are available in the Favorite Snippets view. The snippet is removed from the view when you click the icon to unlike it. The icon changes to. Downloading an Archive of the Snippet You can download a zip or a tgz file of the snippet. To download an archive of a snippet: 1. In the navigation bar, click Snippets. 2. Click the name link of the snippet whose archive you want to download. 3. In the Snippet Details page, click the zip or the tgz button next to the snippet repository URL. 2-67

107 Using Snippets in Oracle Developer Cloud Service Inserting a Snippet File An archive file containing the latest content of all files in the snippet is downloaded to your computer. To view the previous versions of the files, clone the snippet repository and use Git to view the history of the files. See Using Git with Snippets. On a page that uses the code editor, you can insert contents of a snippet file using the context menu. The code editor is available in various editing pages and input fields such as the Edit Wiki page, Code editor of the browser-based IDE, edit mode of the ReadMe.md file, Snippet file editor, Merge Request comment box, and the Execute Shell command box of the Configure Build page. To insert contents of a snippet file: 1. In the code editor, right-click, and select Insert from Snippet. 2. In the Insert from Snippet dialog, click the snippet name that contains the file that you want to insert. Click My Snippets to view snippets that you own. Click Shared to view all shared snippets. Click Favorites to view your favorite snippets. You can also use the Search Snippets search box to search for a snippet. 3. Click Next. 4. In the Select File page, click the file name whose contents you want to insert. 5. Click Finish. The contents of the selected file are inserted in the code editor. Copying a Snippet File s Contents Open a snippet and click the Copy icon to copy a snippet file s contents from a Snippet. To copy a snippet file s contents of a snippet file: 1. In the Snippets page, open the snippet that contains the file. 2. For the file you want to copy, click the icon to copy the file content to the clipboard. In some browsers, you must press Ctrl+C to copy the code to the clipboard after clicking the icon After the contents are copied to the clipboard, use the Paste shortcut key or command to insert the contents. Creating a Snippet from Selection You can create a snippet from the selected text of the open file in the code editor. To create a snippet from the selected text: 1. In the open file of the code editor, select the text. 2. Right-click and select New Snippet from Selection. 2-68

108 Using Snippets in Oracle Developer Cloud Service 3. In the Snippet Details page of the New Snippet wizard, complete the elements using the descriptions in the table. Name Visibility Edit snippet when finished Enter a name for the snippet. Enter a description for the snippet. Select Private if you do not want to share the snippet with project members. Select Shared to share the snippet with project members. Select the check box to edit the snippet file after the snippet is created. 4. Click Next. 5. In the Snippet Content page of the New Snippet wizard, if required, edit the contents of the snippet. 6. Click Finish. A snippet of the specified name is created. If the Edit snippet when finished check box was selected, you are navigated to the Edit Snippet page. Using Git with Snippets Deleting a Snippet You can use Git to manage and track previous versions of snippet files. You can clone a Snippet repository, view the file history, update and commit files locally. However, you can push the updates to the repository only for snippets that you own. To use Git with a Snippet: 1. In the navigation bar, click Snippets. 2. Click the snippet name link to open it. 3. In the Snippet Details page, click the HTTP or the SSH toggle button to view and copy the HTTP or the SSH URL of the snippet repository. After copying the snippet s Git repository URL, you can clone the repository and perform Git related actions.see Using Git in Oracle Developer Cloud Service and Using the Git Command Line Interface. You cannot push updates to the snippet repository that you do not own. You can delete a snippet that you own from the Edit Snippet page. To delete a snippet: 1. In the navigation bar, click Snippets. 2. Click the name link of the snippet that you want to delete. 3. In the Edit Snippet page, click the Delete button. 4. In the Delete Snippet dialog, click Yes to confirm. The snippet is deleted, along with its files. 2-69

109 Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service The review of the source code helps in avoiding bugs, identifying design issues, and catching design and implementation problems that might affect application performance. To get the source code reviewed, you must create a merge request. Watch a short video or click the Tutorial link to learn more about merge requests in Oracle Developer Cloud Service. Tutorial Video Topics About the Merge Requests Page Creating a Merge Request About Merge Request Notifications Opening a Merge Request Add or Remove Reviewers Adding Comments and Reviewing the Source Code Reviewing the Review Status of Reviewers Merging Branches Closing a Merge Request About the Merge Requests Page You can create a code review and branch merge request from the Merge Requests page. About Merge Requests You create a Merge Request merge a branch with another. The branch to be merged is called the review branch and the branch that the review branch will merge into is called the target branch. Before you create a merge request, you should have a target branch and a review branch in the Git repository. The review branch contains the source code that requires review. After the code review is complete, the review branch is merged to the target branch. For more information about creating a branch, see Creating a Branch in the Git Repository. Also see Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service. What You See on the Merge Requests Page The following table highlights elements of the Merge Requests page. 2-70

110 Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service Merge Requests + New Merge Request Related to Me Created By Me Open Merged All More Merge Request table Click to return to the default view of the Merge Request page. Create a merge request. See Creating a Merge Request. Displays all Open merge requests that are created by you or assigned to you. Merged and Closed merge requests are not displayed. Displays all merge requests that are created by you. The list includes Merged and Closed merge requests too. Displays all Open merge requests of the project. Displays all Merged merge requests of the project. Displays all merge requests of the project. Click to see other merge request search queries. Assigned to Me: Displays all merge requests that are assigned to you, that is where you are a reviewer. Merged and Closed merge requests are not displayed. Closed: Displays all Closed merge requests of the project. <custom search query>: Displays merge requests matching the search criteria of the search query. To create a custom search query, see Creating a Custom Merge Request Search Query. For each merge request, the information is displayed in the following columns: Merge Request: Displays the following information: Profile picture of the merge request creator Merge request ID and summary Click the ID and the summary link to open the merge request. Name of the merge request creator Number of days since the merge request was created Repository: Displays the following information Git repository name Review branch Click the branch name to view its contents in the Code page. A number in a blue box showing the number of commits the review branch is ahead of the target branch Mouse over the box to see more information. Target branch Click the branch name to view its contents in the Code page. Status: Status of the merge request (OPEN, MERGED, or CLOSED). See About Merge Request States for more information. The sub-status (Pending, Approved, or Rejected) indicates your action as a reviewer on the merge request. No sub-status indicates you are not a reviewer of the merge request. Changed: Date when the merge request was updated. : Click the icon to view the details of the merge request in a pop-up window. What You Can Do from the Merge Requests Page See Actions You Can Perform on the Merge Requests page. 2-71

111 Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service For frequently asked questions, see Questions about the Merge Request Page and Code Reviews. Creating a Merge Request To create a source code review of a branch, you must create a merge request and assign team members as reviewers. If you are an Owner of the project, you can assign default reviewers to a particular branch. See Managing Branches of Git Repositories in Oracle Developer Cloud Service. To create a merge request: 1. In the navigation bar, click Merge Requests. 2. Click + New Merge Request. 3. In the Branch page of the New Merge Request wizard, complete the elements using the descriptions in the table. Repository Target Branch Review Branch Select the Git repository that has the source code. Select the branch that the review branch would merge into. Select or enter the name of the branch to be reviewed. If the branch does not exist, it will be created. You can create only one merge request per branch. If a merge request has been already created for a branch, the branch name won t appear in the list. All commits to the review branch are listed. 4. Click Next. 5. In the Details page of the New Merge Request wizard, complete the elements using the descriptions in the table. Linked Issues Linked Builds Summary Add issues related to the merge request. Enter the summary or the ID of the issue and select it from the drop-down list. You can add multiple issues and close them when you merge or close the merge request. If the Summary or the fields are not specified, they are populated automatically with the titles of related issues. Add related builds and jobs to the merge request. Enter the job name or the ID and select it from the drop-down list. Enter a summary (or title) of the merge request. If not specified, the default summary Merge Request for branch <review_branch_name> will be set. 2-72

112 Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service Reviewers Select members of the project who will review the source code. Names of default reviewers will be added automatically, however, you may choose to remove them. In the list, select the request created by you. icon to add reviewers of the last merge 6. Click Next. 7. In the page of the New Merge Request wizard, complete the elements using the descriptions in the table. Enter a description of the merge request. By default, the value of Summary field is set as the description. If you have specified related issues in Linked Issues, descriptions of all issues are automatically added. You can use the wiki markup language to format your comment. Click the Preview tab to preview the description. 8. Click + Create. When a merge request is created, all reviewers are assigned the REVIEWER role. The submitter of the request is assigned the REQUESTOR role. After the merge request has been created, an notification is sent to all reviewers. Any member can post a comment or reply to a comment, but only reviewers can approve or reject the merge request. See Approving or Rejecting a Merge Request. About Merge Request Notifications As the reviewer, the submitter, or the subscriber (watcher) you will receive notifications when the merge request is created or updated. A notification of the event also appears in the Recent Activity feed on the Project page. To enable or disable notifications, see Setting Notifications. Some events that send notifications are: Merge request is created Additional source code changes are committed to the review branch and pushed to the upstream A general comment is added An inline comment is published Reviewers are added or removed Merge request is approved or rejected Merge request is closed or merged Batch s are sent when: A user submits multiple inline comments A user submits several private inline comments and publishes them later 2-73

113 Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service A user submits several general comments in a short duration Multiple users carry on multiple conversations at once in different inline comments Multiple users carry on multiple conversations in general comments Batch s are also sent for review events that occurred before the inactivity period, which is usually five minutes after users stop entering comments. Review activities, other than comments related activities, do not send notifications in the inactivity period. A batch is sent after the inactivity period listing all review activities that happened prior to the period of inactivity expires. Creating a Custom Merge Request Search Query If the given searches do not meet your search criteria, you can create custom search queries and save them for future use. To create a custom merge request search query: 1. In the navigation bar, click Merge Requests. 2. Click after the More list. 3. In the New Custom page, complete the elements using the descriptions in the table. Status Submitter Reviewer Repository Review Branch Target Branch Specify the status of the merge request. By default, Open, Merged, and Closed are added. To remove a status, click status, select it from the list.. To add a Enter or select users who created merge requests. By default, All is selected. Enter or select users who are added as reviewers in merge requests. By default, All is selected. Enter or select the Git repositories. By default, All is selected. Enter or select the review branches of Git repositories. By default, All is selected. Enter or select the target branches of Git repositories. By default, All is selected. 4. Click Search. 5. To save the search, enter a name in the Search Name field, and click Save. The search query is added to the More list. To edit the search criteria, select it from the More list and click Delete. Opening a Merge Request. To delete a custom search, open its edit page and click You can open a merge request from the Merge Requests page, notification, or the recent activity feed notification. To open a merge request from the Merge Requests page: 1. In the navigation bar, click Merge Requests. 2-74

114 Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service 2. In the merge request table, click the merge request ID or the summary link. Merge requests created by you are available in the Created By Me standard search and requests assigned to you are available in the Assigned to Me standard search. The merge request review page opens. Add or Remove Reviewers You can add or remove reviewers from the Merge Request Review page. You must be the merge request submitter or a reviewer to add or remove reviewers. Add a Reviewer If you are a request submitter or a reviewer, you can add other project members to a merge request as reviewers. 1. Open the merge request. 2. In the Review Status section on the right side of the page, click Click to add a reviewer. 3. In the Add Reviewer list, enter the project member name or select the member from the list. 4. Click the icon. Add Yourself as a Reviewer If you are a project member but not a reviewer, you can send a request to add yourself as a reviewer to a merge request. 1. Open the merge request. 2. Click Add Me If you are a project Owner or a branch administrator, you are added immediately to the merge request. If you are not a project Owner or a branch administrator, then enter a justification in the Request to be added as a reviewer dialog, and click OK. Approve a Reviewer Request If you are a request submitter or a reviewer, you can approve requests of project members to join the merge request as reviewers. 1. Open the merge request. 2. In the Conversation tab, click the icon in the requested to be a reviewer request. If you do not want to add the user, you can ignore the request. Remove a Reviewer To remove a reviewer: 1. Open the merge request where you want to remove the reviewer. 2-75

115 Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service 2. In the Reviewers section on the right side of the page, click the icon next to the reviewer you want to remove. Adding Comments and Reviewing the Source Code You can review the source code and add comments after a merge request has been created. You can open the merge request from the ID or the Summary link in the Merge Request list of the Merge Request page, from the link in the notification, or from the recent activity feed on the Project page. Topics About the Merge Request Review Page About Merge Request States Adding a General Comment in a Conversation Adding Inline Comments to the Source Code Linking Issues to a Merge Request Linking Builds to a Merge Request Approving or Rejecting a Merge Request As a reviewer, you can perform the following actions while reviewing the source code: Add comments You can add general comments, reply to a comment, or add comments for events such as commits. All reviewers and project members who are not reviewers can add comments or reply to a comment. For a shared project, non-members can also add comments or reply to a comment. See Adding a General Comment in a Conversation and Adding Inline Comments to the Source Code. Approve or reject the merge request Approving or rejecting a merge request is a way of adding a special comment that you approve or disapprove the proposed changes. Only reviewers can Approve or Reject a merge request. Project members who are not reviewers cannot approve or reject a merge request. See Approving or Rejecting a Merge Request. Merge branches You can merge the code changes of the review branch with the target branch. See Merging Branches. Close the merge request You can close or cancel the merge request. See Closing a Merge Request. About the Merge Request Review Page When you open a merge request in the Merge Requests page, you land on the review page. Using the review page, you can view all conversations and comments related to 2-76

116 Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service the opened merge request, all commits made to the review branch, and all files that have changed since the merge request was created. What You See on the Merge Request Review Page The following table describes the key information and elements shown on the Merge Request Review page. Merge Requests merge request OPEN/MERGED/ CLOSED user name wants to merge n commits to target branch from review branch in Git repository Conversation Click to go back to the merge request list. Displays the summary of the merge request. If you are the creator or reviewer of the merge request, click the summary and then click Status of the merge request. to save the update. to edit user name: Indicates the user who created the merge request. Click the user name to open a popup displaying the user name, user s address, and the user s profile picture. n: Indicates number of commits that are ready to be merged. target branch: Indicates the merge request s target branch. Click to view the contents of the target branch in the Code page. review branch: Indicates the review branch. Click to view the contents of the review branch in the Code page. Git repository: Indicates the Git repository of the merge request. Click to open the Commits view of the Git repository review branch. Open the tab to view all conversations, merge request state updates, activities, commits, and comments since the merge request was created. The Introduction box displays the merge request description. If you are the creator or reviewer of the merge request, click description and then click Update to save the update. to edit the In the upper-right corner, click the icon to open the Filtering Options menu and select (or deselect) the check boxes of the conversation options that you want to see (or hide) in the Conversations tab. Commits Next to the icon, click Oldest First (default option) to open the Ordering Options menu and select the desired order option to sort the conversations. Each conversation is displayed its own box. See Adding a General Comment in a Conversation. Open the tab to view all commits made to the review branch since the merge request was created. See About the Commit History List View. 2-77

117 Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service Changed Files Pending Comments Linked Issues Linked Builds Merge, Approve, Reject, Close CC Me / CCed Add me Open the tab to view list of all files that have changed since the merge request was created. The tab also shows the source code of the files that have changed. See the Commits element in Reviewing the Compare Result in the Compare Page. Open the tab to view list of all unpublished comments added to the source code. To add a comment, see Adding Inline Comments to the Source Code. Open the tab to view all linked issues of the merge request. See Linking Issues to a Merge Request. Open the tab to view linked jobs and builds. See Linking Builds to a Merge Request. Click to show or hide the Merge, Approve, Reject, Close buttons and the Review Status pane on the right-side of the page. Click the buttons to merge, approve, reject, or close the merge request. See Approving or Rejecting a Merge Request, Closing a Merge Request and Merging Branches. The buttons are visible to reviewers only. Click to subscribe to notifications when the merge request is updated. The button is visible only if you are not a reviewer. To unsubscribe, click CCed. If you are a project member but not a reviewer, click to add yourself as a reviewer. If you are a project Owner or a branch administrator, you are added immediately to the merge request as a reviewer. If you are not a project Owner or a branch administrator, in the Request to be added as a reviewer dialog, enter a justification, and click OK. The button disappears after the request is submitted. Note: You must be a project member or owner to add yourself as a reviewer. The request is rejected if the review branch has been merged. The button is visible only if you are not a reviewer. Review Status Write Lists the review status of reviewers and linked builds. To add a reviewer, click Click to add a reviewer, select the project member from the list, and click the icon. To remove a reviewer, mouse over the reviewer name, and click the icon. The Linked Builds section lists all linked jobs of the merge request. At the bottom of the page, open the tab to enter a general comment. See Adding a General Comment in a Conversation. 2-78

118 Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service Preview Open the tab to preview the comment. About Merge Request States A merge request can be in one of various states such as Open, Merged, and Closed. State Open Merged Closed Code review is in progress. A merge request s status remains Open until a reviewer closes the request. Code review is complete, the review branch has been merged with the target branch, and the request is closed for comments. Code review is closed for comments. Note: When you commit files, you must always ensure that you are committing them to the correct branch and the repository. If you do not see the correct commits in the Merge Request user interface, be sure you have selected the correct branch as the review branch and your commits have been made to the correct branch. Adding Comments to a Merge Request In a merge request, you can add general comments in a conversation or add inline comments to source code files. Topics: Adding a General Comment in a Conversation Adding Inline Comments to the Source Code If a merge request is merged or closed, you can continue to add general comments or reply to them, but you cannot add inline comments. Adding a General Comment in a Conversation You can add general comments in the Conversation tab. The comment could be a generic comment or for an event such as a commit. To add a general comment: 1. Open the merge request. See Opening a Merge Request. 2. In the Write tab of the Conversation tab, enter your comment. 2-79

119 Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service To format the comment, see Formatting Comments using the Wiki Markup Language. Click the Preview tab to preview the format. 3. Click Submit. The comment is added in a conversation box. The conversation box displays the name of the comment s user and the date-time stamp when the comment was entered. It also displays icons to reply, edit, and delete your comment. To reply to a comment or an event, click, enter your comment, and click Submit. To edit your comment, click. Update your comment in the Write tab, and click Update. To delete your comment, click. You cannot edit or delete comments entered by other users. Adding Inline Comments to the Source Code When a code review is in progress, you can add inline comments directly to the source code. You cannot add an inline comment after a merge request is merged or closed. To add an inline comment to a particular line of the source code: 1. Open the merge request. See Opening a Merge Request. 2. Click the Changed Files tab. 3. Mouse over the line number of the source code and click the icon For more information about the compare tools and options, see Reviewing the Compare Result in the Compare Page. 4. Add your comment in the comment box. To format the comment, see Formatting Comments using the Wiki Markup Language. 2-80

120 Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service Click Comment to publish it and make it visible to all reviewers. You cannot edit or delete a published comment. Click Save to save the comment and publish it later. The comment is not published and is not visible to all reviewers. All pending (or unpublished) comments are available in the Pending Comments tab. Click the icon to edit the comment. Click the icon to delete the comment. Click Publish to publish the comment and make it visible to all reviewers. Click Cancel to cancel the comment. To view your pending or unpublished comments, click the Pending Comments tab. The Pending Comments tab displays all pending comments along with the code where they were added. The comments appear inline in the code. Click the icon to edit the comment. Click the icon to delete the comment. To publish a particular pending comment, click Publish on the right side of the comment header. Click Publish All on the top to publish all pending comments. Click Discard All to discard all pending comments. To reply to a published comment, click the icon, enter your comment, and click Comment. Comment replies to a published comment are published immediately and cannot be edited or deleted. Note: You can also add comments to the source code from the Conversation and the Commits tabs. You can add only general comments from the Conversation tab. You can add both general comments and comments to the source code from the Commits tab. To add comments to the source code, open the Commits tab, click the SHA-1 checksum hash button or the link of the commit that updated the file, mouse over the line number of the source code, and click the icon. Linking Issues to a Merge Request Oracle Developer Cloud Service provides a tight integration between Merge Requests and Issues. When you link issues to a merge request, you can close them when you merge or close a merge request. To manage linked issues to a merge request: 1. Open the merge request. See Opening a Merge Request. 2. Click the Linked Issues tab. All issues linked to the merge request are displayed. To link an issue to the merge request, enter the issue summary text or the issue ID in the Search and Link Issues search box, select the issue from the drop-down list, and click the icon. To remove an issue, click the icon on the right. 2-81

121 Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service If an external Jira server is linked with a project, you can also link Jira issues with the merge request. Select the Jira issues from the window that opens when you click the Search and Link Issues search box. Contact the project Owner to know more about the linked external Jira server. While merging branches or closing the merge request, you can choose to resolve the linked issues. See Merging Branches and Closing a Merge Request. Linking Builds to a Merge Request You can link existing jobs of your project to a merge request, view the build status of those jobs, and then run builds of those jobs directly from the merge request itself. Linking a merge request to a build enables you to run a build job with the review branch. Depending on the build s status, reviewers can determine whether the merge request is ready to be merged with the target branch. To link a job to a merge request: 1. Configure the job to accept merge request parameters. See Configuring Merge Request Parameters. 2. Open the merge request. See Opening a Merge Request. 3. Click the Linked Builds tab. All jobs linked to the merge request are displayed. 4. Enter the job name and select it from the list. 5. Click the icon. After a job is linked to a merge request, a build automatically runs when the review branch is updated with a commit. You can also perform the following actions from the Linked Builds tab: All linked jobs are listed Linked Builds tab and in the Review Status list. In the Linked Builds tab, expand Build History to view the build history of the job. Click the build number link to view the build s details. Click to reload the build history. Click the job name or the build number in the Linked Builds tab or the Review Status list to open its page in the Build page. Click Build Now to run a manual build. When a build runs automatically or manually, a comment is automatically added to the Conversation tab. You can track the build s status in the Build History table of the build. If the build succeeds, it auto-approves the merge request and is added to the Approve section of the Review Status list. A comment is also added to the Conversation tab. If the build fails, it auto-rejects the merge request and is added to the Reject section of the Review Status list. Reviewers might want to review the code again and reconsider the merge request. 2-82

122 Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service Click to remove the job from the Linked Builds tab. Approving or Rejecting a Merge Request After reviewing the source code, as a reviewer, you can add a special comment indicating that you approve or reject the code changes to the review branch. Approving a merge request implies that you do not have any objection to changes made to the source code. Similarly, rejecting a merge request implies that you have an objection and are not satisfied with the updates. To approve or reject a merge request: 1. Open the merge request. See Opening a Merge Request. 2. Click the Approve or Reject button at the right side of the page. 3. In the dialog box that appears, add your comment, and click OK. To format the comment, see Formatting Comments using the Wiki Markup Language. The reviewer s approved or rejected status is visible in the reviewer list on the right side of the review page. Note: If you are the creator of the merge request, but you did not assign yourself as a reviewer, you cannot approve or reject a merge request. However, you can close or merge the request. Reviewing the Review Status of Reviewers Before merging the review branch with the target branch, as a reviewer, you might want to review the review status of all reviewers and linked builds of the merge request. You can do that from the Review Status section of the merge request. In the Review Status section, the review status of all reviewers and linked jobs can be categorized into three categories: Approve Lists all reviewers who have approved the merge request and linked jobs whose last build was successful. Reject Lists all reviewers who have rejected the merge request and linked jobs whose last build failed. No Response Lists all reviewers who have not provided their feedback, and linked jobs whose builds have not run. Depending on the number of Approves, Rejects, and No Response, you can decide whether you want to merge the review branch or wait for more approvals. 2-83

123 Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service Merging Branches You must be assigned the REVIEWER role or the REQUESTOR role to merge the review branch with the target branch. To merge the review branch with the target branch: 1. Open the merge request. See Opening a Merge Request. 2. Click the Merge button at the right side of the page. The Merge button is disabled for a locked branch. Contact the project Owner to unlock the branch before merging. 3. Complete the elements of the Merge dialog. You can choose from multiple methods to merge the review branch with the target branch. Create a Merge Commit Squash and Merge Rebase and Merge Manual Merge Note: It is not mandatory to get approval from all reviewers before you merge the review branch. Approving or rejecting a merge request is a special method of adding a comment that you approve or disapprove the changes made to the source code. The Merge button is disabled if the target branch is locked. Create a Merge Commit Using a Merge Commit, you merge all commits of the review branch to the target branch. The merge commits continue to show two parents. To create a merge commit: 1. In the Merge dialog, in the Merge Options section, select Create a Merge Commit from the list. At the top, select the Remember My Choice check box to pre-select the current option next time you open the Merge dialog. An information is displayed showing the number of commits that will be merged. If necessary, you may update the Merge Summary and enter a Merge in the text box. If any linked issues are selected in the Post Merge section, their summaries are displayed by default. You can use the wiki markup language to format the message. If Markdown is configured as the project s Wiki markup language, you can also add emoji icons in the content. See for the complete list of supported emoji icons and text patterns. 2-84

124 Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service If you do not enter a commit message, the default message will be added that includes the review and the target branch names. 2. In the Post Merge section, select Delete Branch to delete the review branch after the commits are merged with the target branch. The check box is not selected by default. 3. If there are any linked issues, you may deselect the check boxes of the issues that you do not want to mark as resolved after the commits are merged with the target branch. By default, all linked issues are marked as resolved when the commits are merged with the target branch. Deselect the Resolve (close) linked issues check box to deselect all check boxes of related issues. If a linked build is in progress or has not run, a message is displayed. 4. Click Create a Merge Commit. Squash and Merge Using the Squash and Merge option, the commit history of the review branch is added to the target branch. All commits of the review branch are merged as a single commit and then the merged commit is added to the target branch. To create a squash and merge commit: 1. In the Merge dialog, in the Merge Options section, select Squash and Merge from the list. At the top, select the Remember My Choice check box to pre-select the current option next time you open the Merge dialog. An information is displayed showing the number of commits that will be merged. If necessary, you may update the Merge Summary and enter a Merge in the text box. If any linked issues are selected in the Post Merge section, their summaries are displayed by default. You can use the wiki markup language to format the message. If Markdown is configured as the project s Wiki markup language, you can also add emoji icons in the content. See for the complete list of supported emoji icons and text patterns. If you do not enter a commit message, the default message will be added that includes the review and the target branch names. 2. In the Post Merge section, select Delete Branch to delete the review branch after the commits are squashed and merged with the target branch. The check box is not selected by default. 3. If there are any linked issues, you may deselect the check boxes of the issues that you do not want to mark as resolved after the commits are squashed and merged with the target branch. By default, all linked issues are marked as resolved when the commits are squashed and merged with the target branch. Deselect the Resolve (close) linked issues check box to deselect all check boxes of related issues. If a linked build is in progress or has not run, a message is displayed. 4. Click Squash and Merge. Rebase and Merge Using the Rebase and Merge option, the commits from the review branch are reapplied and added to the top of the target branch. 2-85

125 Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service To create a squash and merge commit: 1. In the Merge dialog, in the Merge Options section, select Rebase and Merge from the list. At the top, select the Remember My Choice check box to pre-select the current option next time you open the Merge dialog. An information is displayed showing the number of commits that will be reapplied and added to the top of the target branch. 2. In the Post Merge section, select Delete Branch to delete the review branch after the commits are squashed and merged with the target branch. The check box is not selected by default. 3. If there are any linked issues, you may deselect the check boxes of the issues that you do not want to mark as resolved after the commits are squashed and merged with the target branch. By default, all linked issues are marked as resolved when the commits are squashed and merged with the target branch. Deselect the Resolve (close) linked issues check box to deselect all check boxes of related issues. If a linked build is in progress or has not run, a message is displayed. 4. Click Rebase and Merge. Manual Merge Instructions Using the Manual Merge Instructions option, you can follow the commands displayed and merge the review branch to the target branch using the command line. To manually merge branches: 1. In the Merge dialog, in the Merge Options section, selectmanual Merge Instructions from the list. At the top, select the Remember My Choice check box to pre-select the current option next time you open the Merge dialog. An information is displayed showing the number of commits that will be merged. 2. Open the command line terminal and run the commands displayed. Use the Fetch and check out commands to fetch and check out the review branch. Use the Merge and resolve conflicts commands to checkout the target branch, resolve conflicts (if any), and merge the review branch. Use the Push the target branch commands to push the target branch to the project Git repository. You can run other commands too, if required. 3. Click Cancel. After the review branch is merged, the merge request is automatically closed and no other action is allowed. While merging the review branch, if you did not select the Delete branch check box, note that the review branch is not removed from the Git repository. You can continue to make commits to the branch and create another merge request to review the new source code. 2-86

126 Reviewing Source Code with Merge Requests in Oracle Developer Cloud Service Closing a Merge Request You should close a merge request after the review branch has been merged, or to cancel the request if it was created by mistake or if you do not want to merge the review branch to the target branch. Make sure that you perform any needed merge action before you close the request. Once a merge request is closed, you cannot merge the review branch, add comments, or review the source code. To close a merge request: 1. Open the merge request. See Opening a Merge Request. 2. Click the Close button at the right side of the page. 3. Complete the elements of the Close Merge Request dialog. Closing Issues To resolve the open linked Jira issues while closing the merge request, specify the issues in the Resolve Issues List page. Note that an issue types template must exist that defines the transition of Jira issues. If the template does not exist, the Jira issues will not be updated. You may choose not to resolve issues while merging branches and click Next to switch to the Close Details page. a. In the Resolve Issues List page of the Merge wizard, in Linked Issues list, select the Jira issue that you want to resolve when the branches are merged. b. Enter or update the mandatory fields that are required to complete the transition. The values are not optional. c. Click Add. The issue is added to the Resolve Issues list. d. Click Next. Close Details Close as Merged Delete branch Resolve (close) linked issues Select the check box to change the review status to Merged and close the review. You may choose the Close as Merged option if the review branch was merged through some other means (such as the Git command line or git cherry-pick). If you do not select the Close as Merged check box, the Merge Request is closed without changing the review status to Merged. You may want to do this if the merge request was created on the wrong branch or created by mistake. Select the check box to delete the review branch after the merge request is closed. The check box is not selected by default. Select the check boxes of the linked issues you want to resolve when the branches are merged. All check boxes of the linked issues are selected by default. Deselect the check box of the issue that you do not want to resolve when you merge branches. 2-87

127 Tracking Issues in Oracle Developer Cloud Service Write Add a message. You can use the wiki markup language to format the message and preview it in the Preview tab. If Markdown is configured as the project s Wiki markup language, you can also add emoji icons in the content. See for the complete list of supported emoji icons and text patterns. 4. Click OK. Note: To close a merge request, it is not necessary to merge the review branch to the target branch. Tracking Issues in Oracle Developer Cloud Service Oracle Developer Cloud Service provides an issue tracking system to manage tasks, defects, and features. You can create an issue to track a new feature request or file a bug against a product. You can also create a task that needs to be performed and then assign it to yourself or another project member. Tutorial You can also use REST APIs to create, retrieve, and update Oracle Developer Cloud Service issues. See REST API for Managing Issues in Oracle Developer Cloud Service. Topics: About the Issues Page About Issue Types About Issue Status About Issue Priority and Severity Creating an Issue About the New Issue Page Opening and Updating an Issue About the Issue Details Page Updating Time Spent on an Issue Associating an Issue with a Sprint Resolving an Issue Updating Multiple Issues Updating Issues from IDEs Adding a Comment to an Issue 2-88

128 Tracking Issues in Oracle Developer Cloud Service Adding an Attachment to an Issue Searching Issues About the Issues Page From the Issues page, you can manage all tasks, defects, and features of the project. You must always follow your organization's issue filing guidelines and ensure that a similar issue does not exist. An issue can be categorized as a task, feature, or defect. If you are using Agile Issue Management, you can create two more issue types: Epic and Story. What You See on the Issues Page The following table highlights what you can do from the Issues page. Advanced Searches Standard Searches My Searches Shared Searches Global Searches Clear Selection Select All Update Selected Click to create a custom search. See Searching Issues. Show the standard or pre-defined search filters. All issues: Shows all issues of the project Assigned to me: Shows issues assigned to the logged-in user. Open issues: Shows all open issues. Recently Changed: Shows all issues of the project that were recently updated. Related to me: Shows all issues assigned to the logged-in user or where the logged-in user is mentioned in the CC field. Shows the logged-in user s saved search filters. Shows the logged-in user s saved shared search filters and search filters shared by other users of the project. Shows the logged-in user s saved global search filters and search filters shared globally by other users of the project. Clear the selection, if any issues are selected. Select all issues. Update selected issues. See Updating Multiple Issues. + New Issue Click the button to create an issue. See About the New Issue Page. Issue Search Type title Page Size Issues table Displays the title of the Issue search type. Select the number of issues you want to see on the Issues page. By default, 20 issues are shown. Click Refresh to refresh the page and show the latest updates. View issues as per the search type selected. The table, by default, lists all recently changed tasks, defects, and features of the project. To view all issues created for the project, click All issues under Standard Searches. Click the issue ID or its Summary link to view the issue details or edit it. For more information about editing an issue, see About the Issue Details Page. 2-89

129 Tracking Issues in Oracle Developer Cloud Service Page Enter the page number that you want to go to. The Issues table is updated automatically. You can also use the navigation controls or click the page number link to go to a page. About Issue Types If you are an Owner of the project, you can also create and configure issue components such as products and its components, tags, and custom fields. See Configuring Oracle Developer Cloud Service Issue Components. Before you create an issue, learn about the various status and severity states of an issue. See About Issue Status and About Issue Priority and Severity. What You Can Do from the Issues Page See Actions You Can Perform on the Issues page. For frequently asked questions, see Questions about the Issues Page and Tasks. An Oracle Developer Cloud Service issue can be categorized into task (or action), defect (or bug), and feature (or enhancement). The following table describes the various types of an issue. Issue Type Indicates a task, which means an action is required. A Task type issue could be an action such as a piece of work that must be completed within a certain time, or a simple function to be performed. Indicates a defect, which means a bug or a fault in the product. This is the default issue type. A Defect type issue could be an error or a flaw that prevents the software from working correctly, or creates an unexpected output. Indicates a new feature or an enhancement request. A Feature type issue could be a request to add a new aspect or characteristic to the product, or enhance an existing feature. Indicates an Epic, a unit of work that cannot be completed in one sprint. It can contain any other types of sub-issues necessary to complete that work. An Epic is a larger issue typically comprised of multiple smaller subissues or stories. An epic can span multiple sprints and must have sub-issues (as stories or other issues). Indicates a Story, a sub-issue of a parent epic issue. The story issues of an epic issue can be allotted to different sprints of an Agile board. 2-90

130 Tracking Issues in Oracle Developer Cloud Service About Issue Status The status of an Oracle Developer Cloud Service issue can be any of its various states including Assigned, Resolved, or Reopened. The following table describes the various status values of an issue. Status Unconfirmed New Assigned Resolved Verified Closed Reopened Indicates the issue has been recently added but has not been verified. This is the default issue status. If you are not sure whether the issue that you are creating requires some action or is a duplicate issue, set its status to Unconfirmed. Any member of the project can verify the issue and change its status to another type. Indicates the issue has been recently added and verified. Indicates the issue has been assigned to a member. Indicates the issue has been resolved and is awaiting feedback from the QA team. Indicates the QA team has verified the issue updates in the source code and agrees with the resolution. Indicates the issue has been verified by the QA team and no more updates are required. Indicates the issue had been once resolved, verified, and closed, but has been reopened. If the status of an issue is set to Resolved, you can set its sub-status in the Resolution field to a state described in the following table. Sub-status Fixed Invalid Will not fix Duplicate Works for me Need info Indicates the issue has been fixed and is awaiting feedback from the QA team. After verifying the fix, the QA team will set the issue s status to Verified or Closed. Indicates the issue is not a valid issue. Indicates the issue will not be fixed. Indicates the issue is a duplicate of an existing issue. Enter the issue ID of the existing issue in Duplicate Of. Indicates the issue cannot be reproduced. Indicates the current issue description is insufficient to reproduce the issue and more information is required. About Issue Priority and Severity The importance of an issue is defined by its priority and severity. The severity of the issue defines how important it is. The priority of the issue defines how critical it is and whether it must be resolved immediately. The following table describes the various priorities of an Issue. 2-91

131 Tracking Issues in Oracle Developer Cloud Service Priority Indicates that the issue is of the highest priority and must be resolved immediately. Indicates that the issue is of the high priority and must be fixed in the current release. Indicates that the issue is of the normal priority and would be nice to have fixed in the current release. Indicates that the issue is of the low priority and can be fixed in the current release or in the next patch. Indicates that the issue is of the lowest priority and can be fixed in the current release or in a patch. The following table describes the various severities of an Issue. Severity Indicates that the issue is blocking further development of the project. Indicates that the issue is critical and requires immediate resolution. Indicates that the issue creates a major loss of functionality of a product or component. Indicates that the issue creates a minor loss of functionality of a product or component. Indicates that the issue has an average severity. This is the default issue severity. Indicates that the issue is a trivial issue, such as a typo or formatting error. Indicates that the issue is a new feature request, or requires a change in functionality of an existing feature. Creating an Issue You can create an Oracle Developer Cloud Service issue from the Issues page. To create an Oracle Developer Cloud Service issue: 1. In the navigation bar, click Issues. 2. Click New Issue. 3. In the New Issue page, complete the elements using the descriptions in the table. 4. Click Create Issue. You can also create an issue from an open issue and from an Agile board. 2-92

132 Tracking Issues in Oracle Developer Cloud Service About the New Issue Page The New Issue page contains fields to create an issue in the project. What You See on the New Issue Page The following table describes the key information and elements shown on the New Issue page. Summary Type Severity Priority Product Component Found In Status Release Owner CC Tags Due Date Estimated Days Story Points Custom Fields Provide a title or a brief summary for the issue. Enter a detailed description of the issue. Select the issue type as Task, Defect (default), or Feature. See About Issue Types. Select the severity of the issue. By default, it is set to Normal. See About Issue Priority and Severity Select the priority of the issue. By default, it is set to Normal. Select the product name from the list. To create a product, contact the project Owner. Select the component name from the list. To create a component, contact the project Owner. Specify where the issue was found or noticed. The value could be a wiki page name, another issue, a release number or a version, or a simple text entry. Select the status of the new issue. By default, it is set to Unconfirmed. See About Issue Status. Select the applicable release from the list. To create a release, contact the project Owner. Select the owner of the issue from the list. Specify project members who would be notified by when the issue is updated. Specify tags for the issue. Click the text box to open the list of available tags. Tags are keywords used to categorize an issue and are helpful while searching for related issues. Tags added by you are not visible to other members. To create a global tag, contact the project Owner. Specify the due date of the issue. Enter a numerical value as the estimate in days. Use decimal values to specify estimate in hours. See How do I specify estimate in hours?. Enter the effort estimate of the issue in Agile Story Points. Enter details as required in the custom fields. 2-93

133 Tracking Issues in Oracle Developer Cloud Service Opening and Updating an Issue You can open and update an Oracle Developer Cloud Service issue from the Issues page. When you open an issue, you can update its status, reassign it to another member, change its priority or severity, add a comment, or attach a file. To open and update an issue: 1. In the navigation bar, click Issues. 2. Click the desired search filter. 3. In the issues table, click the issue ID or the summary link. 4. If required, edit the values of elements described in About the New Issue Page. 5. Click Save. 6. To navigate back to the Issues page, click the icon on the left of the issue ID. Updates made to issues can also be tracked in the Recent Activity feed of the Project page. Note: After an issue has been created, it cannot be deleted. For an issue that was created by mistake, set its Status to Resolved and Resolution to Invalid. About the Issue Details Page The Issue Details page displays the details of the open issue and enables you to update it. What You See on the Issue Details Page The following table describes the key information and elements shown on the Issue Details page. Defect/Task/Feature number Save New Issue New Sub-Issue Click to go back to the Issues page. Indicates the issue type and its unique ID. For a child issue, the parent s issue ID is also displayed in a breadcrumb format. Click the ID link to open the parent issue. Click the button to save your changes. Click the button to create a new issue. See About the New Issue Page. Click the button to create a child issue. The current issue automatically becomes the parent issue of the child issue. See About the New Issue Page. 2-94

134 Tracking Issues in Oracle Developer Cloud Service Overview Update the name and description of the issue. Summary Edit and change the issue summary. Edit and change the issue description. Details Update the issue s common fields. Type Severity Priority Product Component Found In Status Resolution Duplicate Of Release Owner CC Tags Select and change the issue type to Task, Defect,or Feature. See About Issue Types. Select and change the severity of the issue. See About Issue Priority and Severity Select and change the priority of the issue. Select and change the product name from the list. To create a product, contact the project Owner. Select and change the component name from the list. To create a component, contact the project Owner. Specify or edit where the issue was found or noticed. The value could be a wiki page name, another issue, a release number or a version, or a simple text entry. To manage the Found In list values, contact the project Owner. Select and change the status of the issue. See About Issue Status. If the Status is Resolved, select the issue s resolution. See About Issue Status. If the Resolution is Duplicate, enter and select the duplicate issue s ID from the list. Enter the issue ID or few characters from issue s summary, and select the issue from the auto-suggest list. Select and change the applicable release from the list. This is a mandatory field. To create a release, contact the project Owner. Select and change the owner of the issue. Specify project members who would be notified by when the issue is updated. Specify or change tags for the issue. Click the text box to open the list of available tags. Tags are keywords used to categorize an issue and are helpful while searching for related issues. Tags added by you are not visible to other members. To create a global tag, contact the project Owner. 2-95

135 Tracking Issues in Oracle Developer Cloud Service External Links Associations Sub Issues Duplicates Lists external URLs related to the issue. Click + New Link and add the absolute URL in the dialog that opens. To edit the URL, click the icon. icon. To delete the URL, click the Displays the parent issues, if any, in Parent Issue. If the field is empty, you can enter the details of the parent issue, if required. Enter the issue ID or few characters from issue s summary, and select the issue from the auto-suggest list. An issue can have one parent issue. Lists all sub issues (or child issues) of the issue. Click the ID or Summary link to open the sub-issue. To create a sub-issue, click + New Sub-Issue. See About the New Issue Page. To remove a sub-issue, click the icon. The sub-issue will not be deleted, but unlinked from the issue. Lists all issues marked as duplicate of this issue. Click the duplicate issue ID or Summary link to open the duplicate issue. This section is available if there are duplicate issues of the open issue. 2-96

136 Tracking Issues in Oracle Developer Cloud Service Time Specify time and duration details. When a new issue is assigned to you with no estimate defined, you must first set the value of the Estimated field as it helps you to track time spent on the issue. When the Estimated field is set, a bar graph is displayed representing the Estimated Time, Time Spent, and the Remaining Time of the issue and its sub issues (if any). Due Date Estimated Remaining Time Spent Time Spent Log Specify the due date of the issue. Enter or change the estimated time (in days) of the issue. Use decimal values to specify estimate in hours. See How do I specify estimate in hours?. Enter or change the estimated remaining time (in days) of the issue. Use decimal values to specify estimate in hours. See How do I specify estimate in hours?. Displays a numerical value as the time spent (in days) to fix the issue. Use decimal values to specify estimate in hours. See How do I specify estimate in hours?. Click Add Time Spent to track and update the progress of the issue. See Updating Time Spent on an Issue. Displays the change log of the time spent updates for each user on the issue. A graph is also displayed showing the time spent on the issue by each user. Click to update an older time spent activity. Note: The above Time section fields are not available for Epic issues. 2-97

137 Tracking Issues in Oracle Developer Cloud Service Agile Specify the Story points and Sprint details. View the progress of the issue and its sub issues with a story point graph. Story Points Sprint Enter the estimate required in Story Points. Displays the sprint name the issue is associated with. Click the sprint link to open the sprint in the Agile page. If no sprint link is displayed, click the search box to view all boards and their sprints, or enter sprint name to filter the sprints that match the name. Then, select the sprint from the list to associate the issue with it. You can associate only one sprint with an issue. Note: The above Agile section fields are not available for Epic issues. For an Epic issue, a link to the related sprint s Epic Report is available. Custom Fields Activity Enter details as required in the custom fields. Add comments or attachments, and track the activity history of the issue. Comments History Attachments Add or view comments of the issue. See Adding a Comment to an Issue. View the activity history of the issue, including Sprint activities such as when the issue was added or removed from a sprint. Add and view the attachments of the issue. See Adding an Attachment to an Issue. Updating Time Spent on an Issue When you start working on an issue, you should update the issue and create an entry for the Time Spent field. To update time spent on an issue: 1. Open the issue in Issues page and click the Add Time Spent button in the Time section. 2. In the Add Time Spent dialog, complete the elements using the descriptions in the table. 2-98

138 Tracking Issues in Oracle Developer Cloud Service Time Spent Remaining Comment Specify the number of days you have spent on the issue. Use decimal values to specify estimate in hours. See How do I specify estimate in hours?. Use the default Reduce remaining... days by entered Time Spent option to automatically subtract the value specified in Time Spent from the existing value of Remaining, if Remaining was set previously. If Remaining was not set, then the value specified in Time Spent is subtracted from Estimate. The option is disabled if the Estimated field is not set. To specify the remaining days manually, select the Set to option and specify the remaining days estimate. Enter a comment, if necessary. To format the comment, see Formatting Comments using the Wiki Markup Language. 3. Click OK. An entry of the time spent is created in the Time Spent Log section and the graph is updated accordingly. To edit the time spent entry, click and update the fields in the Edit Time Spent dialog. To remove a time spent entry, click and update the fields in the Update Time Spent dialog. The remaining time is adjusted accordingly. Associating an Issue with a Sprint Resolving an Issue You can associate an issue with a Sprint in the Edit Issue page. You can associate only one sprint with an issue. To associate an issue with a sprint: 1. Open the issue in the Issues page. 2. In the Sprint drop-down list of the Agile section, click the search box to view all boards and their sprints. Select the sprint from the list to associate the issue with it. You can resolve an issue as Fixed, Invalid, Duplicate, Will not fix, Works for me, or Need info. To resolve an issue: 1. Open the issue in the Issues page. 2. In the Status drop-down list, select Resolved. 3. In the Resolution drop-down list, select the resolution. See About Issue Status. If you specify Duplicate in Resolution, specify the existing issue ID in Duplicate Of. After resolving an issue, the Status of the issue can be changed to Verified or Closed. If required, you can reopen the issue by changing its Status to Reopened. See About Issue Status 2-99

139 Tracking Issues in Oracle Developer Cloud Service Updating Multiple Issues You can update multiple issues in a batch from the Issues page. To update multiple issues: 1. In the navigation bar, click Issues. 2. In the issues table, select the issues you want to update. To select all issues, click Select All. To select issues, press the Ctrl key or the Shift key and click the rows of issues. You can also use the Space bar and Up- Down arrow keys to select the issues. 3. Click Update Selected. 4. In the Issues Selected for Update page, select the check boxes of fields that you want to update and select their values. For a description of fields, see About the New Issue Page. Note: The Component field check box is enabled if the Product field is selected for update. The contents of the Found In and Release fields are determined by the Product field. If the Product field is not specified, the intersection of all known products is used. For example, if product P1 has Found In set to 1.0, 2.0 and product P2 has Found In set to 1.0, 1.5, then with no product specified the Found In will be set to 1.0. The same logic is applied for Release too. 5. Click Next. 6. In the Issues will be Updated page, click Save. Issues that fail the update are listed with a description of the error. To resolve the error of multiple issues, select the error issues and click Update Selected. You are navigated to the Issues Selected page where the previous changes that you made are shown. If all issues are successfully updated, you are navigated back to the Issues page. Updating Issues from IDEs You can also update the issues from IDEs such as OEPE, NetBeans IDE, and JDeveloper that support Oracle Developer Cloud Service. See the following topics for more information: Updating Oracle Developer Cloud Service Issues in the Eclipse IDE Updating Oracle Developer Cloud Service Issues in NetBeans IDE Updating Oracle Developer Cloud Service Issues in JDeveloper 2-100

140 Tracking Issues in Oracle Developer Cloud Service Adding a Comment to an Issue You can add a comment to an issue from the Edit Issue page. To add comments to an issue: 1. In the navigation bar, click Issues. 2. In the issues table, click the issue ID or the summary link. 3. Click the Comments tab, if it is not open. 4. Add your comment in the text box. To format the comment, see Formatting Comments using the Wiki Markup Language. 5. Click Add. The comment is added to the Comments tab and a notification appears in the History tab of the issue and the Recent Activity Feed on the Project page. To edit a comment, click the delete a comment. Adding an Attachment to an Issue icon, edit the comment, and click Save. You cannot You can add an attachment to an issue from the Edit Issue page. To add attachments to an issue: 1. In the navigation bar, click Issues. 2. In the issues table, click the issue ID or the summary link. 3. Click the Attachments tab. 4. Expand Upload Files, if necessary. 5. Click the select files link, browse, select the files you want to attach, and click Open. You can also drag-and-drop files to the dotted box area. The selected files are added to the Files table. 6. In the Comments text box of the Files table, add a comment (if necessary) about the attached file. To delete a file before it is uploaded, click the icon. To delete all files in the Files table, click the in the table header. You cannot delete a file or stop the upload process while the file is being uploaded. 7. Click Upload Files. The file is uploaded and is now available in the Attachments tab. A notification of the upload appears in the History tab of the issue and the Recent Activity Feed on the Home page. To delete a file after it is uploaded, open the Attachments tab, and click the icon

141 Tracking Issues in Oracle Developer Cloud Service Searching Issues You can search for issues using the filters under Standard Searches, or using custom Advanced Searches. Topics: Using the Basic Search Using the Basic Search Using the Advanced Search Use the Search Issues box in the upper-right corner of the Issues page. To search issues using the basic search: 1. In the navigation bar, click Issues. 2. In the Search Issues box, enter the search term, and press Enter. Issues matching the search term in their Summary,, or Comments are listed in the Issues table. 3. Click to clear the search term. Click Save this search to save the search query as a filter. Click Edit this search to edit the search query. Click Show Search String to see the search query expression. Using the Advanced Search Use the Advanced Searches link if you want to specify a detailed search criterion. The Advanced Search enables you to search for issues using various parameters such as sprints, product, version, date, owner, type, and priority. To search issues using the Advanced search: 1. In the Issues page, click Advanced Searches. 2. In the Advanced Search page, enter the search term and specify the search criterion. Text Search Search In Search Term Select the Summary check box to search for the search term in the issue summary. Select the check box to search for the search term in the issue description. Select the Comments check box to search for the search term in the issue comments. Search text. Product and Version Search Sprint Enter or select Sprints to which the issues are associated with

142 Tracking Issues in Oracle Developer Cloud Service Product Component Release Enter or select Products associated with issues Enter or select Components associated with issues Enter or select Releases associated with issues Parameter Search Type Status Resolution Priority Severity Tags Enter or select issue types. Enter or select issue statuses. Enter or select issue resolutions. Enter or select issue priorities. Enter or select issue severities. Enter or select issue tags. User Search Owner Creator Commenter CC Enter or select issue owners. Enter or select issue creators. Enter or select issue commenters. Enter or select users who are marked in CC. Date Search Search In Since Before Select Created to search for issues created in the specified date range. Select Updated to search for issues updated in the specified date range. Specify the start date for the date range. Specify the end date for the date range. Saving a Custom Search 3. Click Search at the top of the page. Click Save this search to save the search query as a filter. See Saving a Custom Search. Click Edit this search to edit the search query. Click Show Search String to see the search query expression. You can save your basic or the advanced search query as a custom search filter for future use. Custom searches can be categorized into three categories: My Searches, Shared Searches, and Global Searches. To save a search query: 2-103

143 Tracking Issues in Oracle Developer Cloud Service 1. In the Issues page, run a basic or advanced search. 2. On the search results page, click Save this search. 3. In the Save Search dialog, enter the search name To share the search query with project members, in the Save Search dialog, select the Shared check box. In Share with the following users, select the users with whom you want to share the search query. To share the search query with all project members, select the Share with everyone check box. 4. Click OK. If you did not select the Shared check box, the search query appears as a filter under My Searches. If you selected the Shared check box, the search query appears as a filter under Shared Searches. If you selected the Share with everyone check box, the search query appears as a filter under Global Searches. Managing Shared Searches Using shared searches, you can share your custom search filters with other project members, which they can use to view the issues as you want. Sharing a My Search Query with Specific Project Members 1. In My Searches, mouse over the filter link, and click the icon. 2. In the Start Sharing Search dialog, select the project member names in Share with following users. 3. Click OK. The filter link moves from My Searches to Shared Searches. Sharing a My Search Query with All Project Members 1. In My Searches, mouse over the filter link, and click the icon. 2. In the Start Sharing Search dialog, select the Share with Everyone check box. 3. Click OK. The filter link moves from My Searches to Global Searches. Stopping Share of a Search 1. In Global Searches or Shared Searches, mouse over the filter link and click the icon. 2. In the Stop Sharing Search dialog, click OK. If the search query is being used by other project members, the dialog shows their list. When you stop sharing the search query, it is removed from the Shared Searches or Global Searches list of the project members who are using it

144 Using the Agile Methodology in Oracle Developer Cloud Service Using the Agile Methodology in Oracle Developer Cloud Service The Agile methodology of software development is a type of Incremental model that focuses on process adaptability and customer satisfaction. Topics Tutorial About the Agile Page About Agile Concepts Creating a Board Opening a Board Using a Scrum Board Working with Sprints Using a Kanban Board Using Agile Reports and Charts Configuring the Board Deleting a Board About the Agile Page The Agile page displays boards owned by you, your favorite boards, and all boards of the project. Agile is an iterative approach to software delivery that builds software incrementally. If you are new to Agile, see for more information. What You See on the Agile Page The following table describes the key information and elements shown on the Agile page. Owned/Favorites/All By default, the Agile page displays all boards that you own. Click Favorites to view your favorite boards. Click All to view all boards created by the members of the project. Click the icon to mark a board as your favorite board and add it to the Favorites list. + New Board Click to create a board. See Creating a Board. Scrum/Kanban/All Board Types By default, all board types are displayed. Click Scrum to see Scrum boards only. Click Kanban to see Kanban boards only

145 Using the Agile Methodology in Oracle Developer Cloud Service Filter Boards Boards List Search for a board. Enter a regular expression in the Filter Boards search box and click the Search icon to find a board. Click the board name link to open the board. See Opening a Board. About Agile Concepts What You Can Do from the Agile Page Click the icon to mark a board as your favorite board and add it to the Favorites list. In the list, indicates a Kanban board and indicates a Scrum board. See Actions You Can Perform on the Agile page. For frequently asked questions, see Questions about the Agile Page and Sprints. Before you start using the Agile methodology in Oracle Developer Cloud Service, it is important that you know key components of the Agile page. Board A Board is used to display and update issues of the project. There are two types of boards available: Scrum and Kanban. When you create a board, you associate it with an issue query. The board shows issues returned by the query. You can either use a board created by a team member, or create your own board. You can create as many boards as you like. Scrum A Scrum board enables use of Agile framework where a task is broken small actions to be completed into fixed duration cycles, called as Sprints. Kanban A Kanban board enables use of Kanban framework where tasks are managed with focus on continual delivery. Sprint A Sprint is a short duration (usually, a week or two) during which your team members try to implement a product component. You add the product component related issues to a sprint. When you start working on a product component, you start (or activate) the related sprints. To update issues using a sprint, you must first activate the sprint and add the sprint to the Active Sprints view. Story Points A Story Point is a metric that defines the relative effort of work and helps to understand how complex the issue is. Backlog view Lists all issues returned by the board s query. The view also displays all active and inactive sprints of the board, and the sprints from other boards that contain issues matching the board s query. Each sprint lists issues that are added to it. The Backlog section (the last section of the Backlog page) lists all open issues that are not part of any sprint yet. The Backlog view does not show the resolved and closed issues. Active Sprints view Lists all active sprints of the board and enables you to update an issue status simply by dragging and dropping it to the respective status columns

146 Using the Agile Methodology in Oracle Developer Cloud Service Creating a Board Reports view Select the Burndown Chart tab to display the amount of work left to do in a sprint or use the Sprint Report tab to list open and completed issues of a sprint. You can create a Board from the Agile page. Any member of the project can create a board. You can create more than one board in a project. When you create a board, you specify the board type, an issue search query, and the estimation criteria. To create a Board: 1. In the navigation bar, click Agile. 2. Click the New Board button. 3. In the New Board dialog, complete the elements using the descriptions in the table. Type Name Search Estimation Select Scrum (Default) to create a Scrum board. Select Kanban to select a Kanban board. (Required) Enter a unique name. (Required) Select the standard or custom issue search query. By default, All Issues is selected. Issues from the query result are added to the board. To create a custom search query, see Using the Advanced Search. (Required) Select Story Points (default) or Estimated Days as the estimation criteria. 4. Click Create. A board is created and issues matching the search query are added to the board, and you are navigated to the Backlog view. The board Owner role is also granted to you. Note: Issues with the following status are not added to the board: Resolved Verified Closed You can also create a board from the Switch Board menu. In an open board, click the board name, and then click New Board

147 Using the Agile Methodology in Oracle Developer Cloud Service Opening a Board You can open a board from the Agile page. To open a board: 1. In the navigation bar, click Agile. 2. Click the board name link. The board opens and you are navigated to the Backlog view of the board. You can also open a board from the Switch Board menu. In an open board, click the board name, and then click the board name that you want to open

148 Using the Agile Methodology in Oracle Developer Cloud Service Using a Scrum Board A Scrum board uses an Agile framework where a task is broken small actions to be completed into fixed duration cycles, called as Sprints. Topics Opening the Backlog View About the Backlog View Opening the Active Sprints View About the Active Sprints View Opening the Reports View About the Reports View 2-109

149 Using the Agile Methodology in Oracle Developer Cloud Service Opening the Backlog View About the Backlog View The Backlog view displays the sprints of the board and lists issues that match the board s issue search query. You can use the Backlog view to plan your sprints. To open the Backlog view of a Scrum board: 1. Open the Scrum board. 2. If required, click the Backlog toggle button. The Backlog view lists all active and inactive sprints of the board, and a backlog list. The active sprints are displayed first followed by the inactive sprints (sprints that are not started). The Epics do not appear in the Backlog view. For each sprint, the Backlog view displays all issues added to the sprint. At the bottom of the page, it displays a Backlog list of issues that are not added to any sprint. What You See on the Backlog View The following table describes the key information and elements shown on the Backlog view. Board drop-down list Backlog / Active Sprints/Reports Board Displays the name of the open board. Click the board name to open the Switch Board menu and switch to another board. Click Active Sprints to switch to the Active Sprints view. See About the Active Sprints View. Click Backlog to return to the Backlog view. Click Reports to view the Burndown chart and the Sprint Report. From the list, select the desired option. Configure: Configure the board. See Configuring the Board. Copy Board: Copy the board. See Copying a Board. Delete Board: Delete the board. See Deleting a Board

150 Using the Agile Methodology in Oracle Developer Cloud Service Sprints Backlog section Lists all active and inactive sprints of the board. For each sprint, the following information is shown: Sprint title along with number of issues it contains If the sprint is active, the start and end date-time of the sprint Summary boxes The number in the fist box (gray in color) indicates the estimate of all open issues of the sprint. The number in the second box (blue in color) indicates the estimate of all closed issues of the sprint. The number in the third box (green in color) indicates the total estimate of the sprint. If the board is showing estimation in Story Points, the third box will be red in color if the total estimation exceeds the sprint's capacity (if set). If the board is showing estimation in number of days, the third box will be red if any owner's total number of days exceeds the number of working days in the sprint. Click the red box for more details. Edit Sprint button to edit the sprint. See Editing a Sprint. Start Sprint button to start an inactive sprint. See Starting a Sprint.... button to edit, reorder, and delete the sprint. Issue list. Each issue displays its severity, priority, link to the issue, issue summary, issue owner, and the estimate in a colored summary box. New Issue: Click to create and add an issue to the sprint. See About the New Issue Page. You can also create an issue in a sprint. Lists all issues of the board that are not added to any sprint. If a subissue (or story) is associated with en epic, the Epic s name is displayed. Click New Sprint to create a sprint. See Creating a Sprint. Click New Issue to create an issue and add it to the backlog. See About the New Issue Page. What You Can Do on the Backlog View The following table highlights what you can do from the Backlog view of the board. Action Create a sprint Add or move issues to a sprint Start a sprint Edit a sprint Add an issue to a sprint Reorder or organize sprints Delete a sprint Reference Creating a Sprint Adding an Issue to a Sprint Starting a Sprint Editing a Sprint Adding an Issue to a Sprint Reordering Sprints Deleting a Sprint 2-111

151 Using the Agile Methodology in Oracle Developer Cloud Service Action Configure the Board Reference Configuring the Board Tip: You can open the backlog view in a new browser tab or window by rightclicking and the choosing the right option in the context menu. Opening the Active Sprints View In the Active Sprints view, you can update the progress of issues. To open the Active Sprints view of a Scrum board:: 1. Open the Scrum board. 2. Click the Active Sprints toggle button. About the Active Sprints View The Active Sprints view enables you to manage the progress of issues of an active sprint. You can choose either the Swimlanes sub-view or the Columns sub-view to view the issues of the active sprint. The Swimlanes sub-view displays issues categorized into issue owners (member whom the issue is assigned to). For each issue owner, the issues are further categorized into vertical progress (or status) columns. The Columns sub-view displays the issues categorized into vertical progress columns. By default, each board contains three columns: To Do, In Progress, and Completed. If required, you can add more progress columns to the board from the Configure Board page. See Configuring the Board. What You See on the Active Sprints View The following table describes the key information and elements shown on the Active Sprints view. Board drop-down list Backlog / Active Sprints/Reports Board Displays the name of the open board. Click the board name to open the Switch Board menu and switch to another board. Click Backlog to switch to the Backlog view. See About the Backlog View. Click Active Sprints to return to the Active Sprints view. Click Reports to view the Burndown chart and the Sprint Report. From the list, select the desired option. Configure: Configure the board. See Configuring the Board. Copy Board: Copy the board. See Copying a Board. Delete Board: Delete the board. See Deleting a Board

152 Using the Agile Methodology in Oracle Developer Cloud Service Sprint drop-down list Complete Sprint Swimlanes / Columns Sort Issues By Base Swimlanes On Sort Swimlanes by To Do / In Progress / Completed Displays the name of the active sprint along with the start and end date-time stamp. Open the list to view all active sprints of the board and switch to another sprint. Click to complete a sprint. See Completing a Sprint. Toggle the active sprint view to show issues as Swimlanes or Columns. Sort the issues of the active sprint as per the selected option. You can sort issues by Priority, Severity, or Task No. Sort the issues of the active sprint as per the selected option. You can sort issues by User Name, Epic, Story, or Status. Sort the swimlanes of the active sprint as per the selected option. You can sort issues by Heading or Number of Issues. Lists issues as per their issue status What You Can Do on the Active Sprints View The following table highlights what you can do from the Active Sprints view of the board. Action Update an issue s progress and status Complete a sprint Reference Updating an Issue s Progress in an Active Sprint Completing a Sprint Opening the Reports View About the Reports View In the Reports view, you can view various issue reports. To open the Reports view of a Scrum board:: 1. Open the Scrum board. 2. Click the Reports toggle button. You can use the Burndown Chart to view the remaining amount of work to be done in a sprint or epic. Use the Sprint Report to view completed and not completed, or open, issues of a sprint. Use the Epic Report to view completed and not completed, or open, stories of an epic. Use the Velocity Report to view the velocity chart of completed sprints. What You See on the Reports View The following table describes the key information and elements shown on the Reports view

153 Using the Agile Methodology in Oracle Developer Cloud Service Board drop-down list Backlog / Active Sprints/Reports Board Displays the name of the open board. Click the board name to open the Switch Board menu and switch to another board. Click Backlog to switch to the Backlog view. See About the Backlog View. Click Active Sprints to return to the Active Sprints view. Click Reports to view the Burndown chart and the Sprint Report. From the list, select the desired option. Configure: Configure the board. See Configuring the Board. Copy Board: Copy the board. See Copying a Board. Delete Board: Delete the board. See Deleting a Board. View Burndown Chart, Sprint Report, Cumulative Flow Chart, and Control Chart. See Using the Burndown Chart, Using the Sprint Report, Using the Cumulative Flow Chart, and Using the Control Chart. View epic reports: Burndown Chart and Epic Report See Using the Burndown Chart and Using the Epic Report. View the Velocity Chart. See Using the Velocity Report. Working with Sprints A sprint, also known as an iteration, is like a working milestone. Only the project owner or the board owner can create and manage sprints. Topics Creating a Sprint Creating a Sprint Editing a Sprint Adding an Issue to a Sprint Removing an Issue from a Sprint Starting a Sprint Updating an Issue s Progress in an Active Sprint Moving a Sprint to Another Board Reordering Sprints Completing a Sprint Deleting a Sprint You can create a sprint from the Backlog section of the Backlog view. To create a sprint: 1. Open the board where you want to create the sprint. 2. If required, click the Backlog toggle button

154 Using the Agile Methodology in Oracle Developer Cloud Service 3. Click + New Sprint. 4. In the New Sprint dialog, complete the elements using the descriptions in the table. Name Story Points Enter a unique name of the sprint. Enter a estimate capacity of the sprint in story points. Editing a Sprint 5. Click OK. The sprint is created and is added to the Sprints list of the Backlog view. If there are no issues assigned to a sprint, the sprint is available only in the board in which it is created. When an issue is assigned to a sprint, the sprint is displayed in all boards whose issue query returns the any issue of the sprint in its result. You can edit an active or an inactive sprint. For a sprint, you can update its name, owner board, and the story points capacity. To edit an inactive sprint: 1. Open the board that owns the sprint. 2. For an inactive sprint, click... and select Edit sprint. If the sprint is active (or started), click Edit Sprint. 3. In the Edit Sprint dialog, complete the elements using the descriptions in the table. Name Board Start Date End Date Story Points Update the name of the sprint. Select the new owner board name. Use the drop-down list to assign the sprint to another board. Specify the start date and time of the sprint. Specify the end date and time of the sprint. Update the estimate capacity of the sprint in story points. The field is available if Story Points were selected as the estimation for a board. 4. Click OK. Adding an Issue to a Sprint You can add an existing issue from the Backlog list or a sprint s issue list to another sprint by simply dragging and dropping it to the target sprint. To add an existing issue to a sprint: 1. Open the board that contains the issue. 2. If required, click Backlog to open the Backlog view

155 Using the Agile Methodology in Oracle Developer Cloud Service 3. In the Backlog list or in the sprint that contains the issue, drag the issue to the target sprint. A blue dotted rectangle appears when you drag the issue to the target sprint marking the drop area. Drop the issue in the blue rectangle to add it to the sprint. You can also right-click the issue and select Send to > target sprint name to move the issue to the target sprint. To create an issue in a sprint: 1. Open the board that contains the issue. 2. If required, click Backlog to open the Backlog view. 3. In the target sprint, click New Issue. 4. Create the issue as described in About the New Issue Page and click Save. The issue is now added to the target sprint. A Sprint field is also added to the issue indicating the sprint it is associated with. Click the issue ID link to open the Edit Issue page. When you add an issue or create an issue in a sprint, the activity is added to the History tab of the issue s Activity section. Open the issue in the Issues page to view the activity. Tip: If the total story points of the issues is more than the story points capacity of the sprint, a warning message appears indicating the same. In such a case, you may want to increase the capacity of the sprint (see Editing a Sprint) or move some issues to another sprint. To move an issue to another sprint, drag-and-drop it to another sprint or use the context menu Send to > target sprint name option. Removing an Issue from a Sprint When you remove an issue from a sprint, it is added back to the Backlog list. To remove an issue from a sprint: 1. Open the board that owns the sprint 2. If required, click Backlog to open the Backlog view. 3. In the sprint that contains the issue, drag the issue to the Backlog list. You can also right-click the issue and select Send to > Backlog to move the issue to the Backlog list. Note: You cannot remove an issue from the Backlog list

156 Using the Agile Methodology in Oracle Developer Cloud Service Starting a Sprint You can start a sprint from the Backlog view of the board. Only the project owner or the board owner can start a sprint. To start a sprint: 1. Open the board that owns the sprint. 2. For the sprint that you want to start, click Start Sprint. 3. In the Start Sprint dialog, enter the details described in the following table. Name Start Date End Date Story Points Update the name of the sprint, if necessary. Specify the start date and time of the sprint. Specify the end date and time of the sprint. Update the story points capacity of the sprint, if necessary. 4. Click Start. The started sprint is now available in the Active Sprints view. See About the Active Sprints View. Updating an Issue s Progress in an Active Sprint You can update an issue s progress in the Active Sprints view by simply dragging it from one progress column to another. To update an issue s progress: 1. Open the board that owns the active sprint. 2. Click Active Sprints. 3. Choose the desired issue list view: Swimlanes or Columns. 4. To update the progress of an issue, drag the issue from one column to drop it to another. When you start working on an issue, move the issue to the In Progress column. The Change Progress wizard opens. In the To drop-down list of the Set Status page, select the new status of the issue. If necessary, enter a comment in the Comment field. If required, click Next to update the time spent on the issue. When you have completed the issue, move it to the Completed column. The Change Progress wizard opens. In the To drop-down list of the Set Status page, select the new status of the issue. Click Next. In the Add Time Spent page of the wizard, complete the elements using the descriptions in the table

157 Using the Agile Methodology in Oracle Developer Cloud Service Time Spent Remaining Comment Specify the number of days you have spent on the issue. Use decimal values to specify estimate in hours. See How do I specify estimate in hours?. Use the default Reduce remaining... days by entered Time Spent option to automatically subtract the value specified in Time Spent from the existing value of Remaining. If Remaining is not set, then the value specified in Time Spent is subtracted from Estimate. The option is disabled if the Estimated field is not set. To specify the remaining days manually, select the Set to option and specify the remaining days estimate. Enter a comment, if necessary. The Story Points number on right side of the To Do, In Progress, and Completed columns is also updated when you move an issue from one column to another. To know more about the Status values, see About Issue Status. 5. Click OK. When you update an issue s progress in a sprint, the activity is added to the History tab of the issue s Activity section. Open the issue in the Issues page to view the activity. You may also update the issue s progress from the Edit Issue page and assign a different status and resolution. See About the Issue Details Page. Moving a Sprint to Another Board Reordering Sprints You can use the Edit Sprint dialog of the Backlog view to move a sprint to another board. To move a sprint to another board: 1. Open the board that owns the sprint. 2. For the sprint that you want to move, click the... button and select Edit Sprint. 3. In the Board list of the Edit Sprint dialog, select the target board name and click OK. The sprint moves to the target board. By default, the Backlog view lists inactive sprints (or future sprints) in the order they were created. You can move the inactive sprints up or down and change their display order in the Backlog view. To reorder sprints: 1. Open the board. 2. For the inactive sprint that you want to move up or down, click... and select Move sprint up or Move sprint down. The sprint moves a level up or down as per the selected option

158 Using the Agile Methodology in Oracle Developer Cloud Service Note: You cannot change the order of active sprints. The active sprints are ordered by Start Date in the Backlog view. If two sprints have the same Start Date, then they are ordered by name. Completing a Sprint Deleting a Sprint You can complete a sprint from the Active Sprints view of the board. To complete a sprint: 1. Open the board the sprint belongs to. 2. Click Active Sprints. 3. In the Sprint drop-down list on the left, select the sprint that you want to close. 4. Click Complete Sprint. 5. In the Complete Sprint dialog, select the I understand that it will be removed from the Active Sprint view check box, and click Complete Sprint. After a sprint is complete, it is removed from the Active Sprints view. A warning is displayed if there are any incomplete issues in the Sprint. All incomplete issues go back to the next inactive sprint, or to the Backlog section if there are no inactive sprints. The Sprint Report page opens showing the day-by-day progress of the sprint issues. You can delete an inactive sprint from the Backlog view of the board. You cannot delete an active sprint. To delete a sprint: 1. Open the board that contains the sprint that you want to delete. 2. If required, click Backlog. Using a Kanban Board 3. For an inactive sprint, click the... button and select Delete Sprint. 4. In the Delete Sprint dialog, select the I understand that my sprint will be permanently deleted check box and click Delete. The sprint is deleted and all issues of the sprint are moved to the Backlog list. A Kanban board uses Kanban framework where tasks are managed with focus on continual delivery. Topics Opening the Backlog View About the Backlog View Activating an Issue in a Kanban Board 2-119

159 Using the Agile Methodology in Oracle Developer Cloud Service Opening the Active Issues View About the Active Issues View Updating an Active Issue s Progress State Archiving Completed Issues Opening the Reports View Using the Reports View Opening the Backlog View About the Backlog View In a Kanban board, the Backlog view displays the active issues and the issues that match the board s issue search query. To open the Backlog view of a Kanban board: 1. Open the Kanban board. 2. If required, click the Backlog toggle button. The Backlog view lists active issues (issues that are being actively worked on) in the Active Issues section and a backlog list of issues (issues are not being actively worked on) in the Backlog section. The Epic issues do not appear in the Backlog view. What You See on the Backlog View The following table describes the key information and elements shown on the Backlog view of a Kanban board. Board drop-down list Backlog / Active Issues /Reports Board Displays the name of the open board. Click the board name to open the Switch Board menu and switch to another board. Click Active Issues to switch to the Active Issues view. Click Backlog to return to the Backlog view. Click Reports to view the Burndown chart and the Active Issues Report. You can open a view in a new browser tab or window by right-clicking and the choosing the right option in the browser context menu. From the list, select the desired option. Configure: Configure the board. See Configuring the Board. Copy Board: Copy the board. See Copying a Board. Delete Board: Delete the board. See Deleting a Board

160 Using the Agile Methodology in Oracle Developer Cloud Service Active Issues section Backlog section Lists all active issues, the total number of issues, and summary boxes showing the estimation of all active issues. The number in the first box (gray in color) indicates the estimate of all open issues. The number in the second box (blue in color) indicates the estimate of all completed issues. The number in the third box (green in color) indicates the total estimate of active issues. For each issue, its priority, severity, issue ID and type, issue summary, issue owner, and its estimation is displayed. Click the issue ID link to open the issue in the Issues page. A strike-through issue ID indicates the issue is resolved. Click New Issue to create and add it to the active issues list. See About the New Issue Page. Lists all issues of the board that are currently not being actively worked on. The issues are sorted by priority. If a sub-issue (or story) is associated with en epic, the Epic s name is displayed too. For each issue, its priority, severity, issue id and type, issue summary, issue owner, and its estimation is displayed. Click the issue ID link to open the issue in the Issues page. A strike-through issue ID indicates the issue is resolved. Issues active in another Kanban board or in a sprint of a Scrum board are not displayed in the Backlog section. Click New Issue to create an issue and add it to the backlog. See About the New Issue Page. Activating an Issue in a Kanban Board To activate an issue in a Kanban board, drag the issue from the Backlog section to the Active Issues section. To activate an issue: 1. Open the board that contains the issue. If the board is already open, refresh the page to get the latest updates of board issues. 2. If required, click Backlog to open the Backlog view. 3. From the Backlog section, drag the issue to the Active Issues section. A blue dotted rectangle appears when you drag the issue to the Active Issues section marking the drop area. Drop the issue in the blue rectangle to add it to Active Issues section and activate it. You can also right-click the issue and select Send to > Active Issues. To add a new issue as an active issue: 1. Open the board where you want to add the issue. 2. If required, click Backlog to open the Backlog view. 3. In the Active Issues section, click New Issue. 4. Create the issue as described in About the New Issue Page and click Save

161 Using the Agile Methodology in Oracle Developer Cloud Service The issue is now added Active Issues list. Click the issue ID link to open the Edit Issue page to edit it, if necessary. In the Edit Issue page, navigate to the Agile section and notice the board name in the Added To field. When you add an active issue, the activity is added to the History tab of the issue s Activity section. Open the issue in the Issues page to view the activity. Opening the Active Issues View You can manage the progress of active issues of a Kanban board from the Active Issues view. To open the Active Sprints view of a Kanban board: 1. Open the Kanban board. 2. Click the Active Issues toggle button. About the Active Issues View The Active Issues view enables you to manage the progress of active issues. You can choose either the Swimlanes sub-view or the Columns sub-view to view the active issues. The Swimlanes sub-view displays issues categorized into issue owners (member whom the issue is assigned to). For each issue owner, the issues are further categorized into vertical progress (or status) columns. The Columns sub-view displays the issues categorized into vertical progress columns. By default, each board contains three columns: To Do, In Progress, and Completed. If required, you can add more progress columns to the board from the Configure Board page. See Configuring the Board. What You See on the Active Issues Page The following table describes the key information and elements shown on the Active Issues view. Board drop-down list Backlog / Active Issues/Reports Board Archive Completed Issues Swimlanes / Columns Displays the name of the open board. Click the board name to open the Switch Board menu and switch to another board. Click Backlog to switch to the Backlog view. See About the Backlog View. Click Active Issues to return to the Active Issues view. Click Reports to view the Burndown chart and the Active Issues Report. From the list, select the desired option. Configure: Configure the board. See Configuring the Board. Copy Board: Copy the board. See Copying a Board. Delete Board: Delete the board. See Deleting a Board. Create an archive of Completed column issues and remove them from the Active Issues list. Toggle the active issues view to show issues as Swimlanes or Columns

162 Using the Agile Methodology in Oracle Developer Cloud Service Sort Issues By Base Swimlanes On Sort Swimlanes by To Do / In Progress / Completed Sort the issues as per the selected option. You can sort issues by Priority, Severity, or Task No. Sort the issues as per the selected option. You can sort issues by User Name, Epic, Story, or Status. Sort the swimlanes as per the selected option. You can sort issues by Heading or Number of Issues. Lists issues as per their issue status. A Capacity Exceeded warning message with an icon is displayed in the column header of a progress state if the number of issues in the progress state exceeds the suggested issue capacity for that state. Mouse over the column header to know the suggested capacity for the progress state. Updating an Active Issue s Progress State You can update an active issue s progress in the Active Issues view by simply dragging it from one progress column to another. To update an issue s progress: 1. Open the board. 2. Click Active Issues. 3. Choose the desired issue list view: Swimlanes or Columns. 4. If necessary, use the sort list boxes to sort the active issues. 5. To update the progress of an issue, drag the issue from one progress state column and drop it to another. When you start working on an issue, move the issue from the To Do column to the In Progress column. The Change Progress wizard opens. In the To drop-down list of the Set Status page, select the new status of the issue. If necessary, enter a comment in the Comment field. If required, click Next to update the time spent on the issue. When you have completed the issue, move it to the Completed column. The Change Progress wizard opens. In the To drop-down list of the Set Status page, select the new status of the issue. Click Next. In the Add Time Spent page of the wizard, complete the elements using the descriptions in the table. Time Spent Specify the number of days you have spent on the issue

163 Using the Agile Methodology in Oracle Developer Cloud Service Remaining Comment Use the default Reduce remaining... days by entered Time Spent option to automatically subtract the value specified in Time Spent from the existing value of Remaining. If Remaining is not set, then the value specified in Time Spent is subtracted from Estimate. The option is disabled if the Estimated field is not set. To specify the remaining days manually, select the Set to option and specify the remaining days estimate. Enter a comment, if necessary. The Story Points number on right side of the To Do, In Progress, and Completed columns is also updated when you move an issue from one column to another. To know more about the Status values, see About Issue Status. 6. Click OK. When you update an issue s progress, the activity is added to the History tab of the issue s Activity section. Open the issue in the Issues page to view the activity. You may also update the issue s progress from the Edit Issue page and assign a different status and resolution. See About the Issue Details Page. Archiving Completed Issues You can create an archive of all issues listed in the Completed progress state from the Active Issues view of the board. The archived issues are then removed from the Active Issues view. Before you archive completed issues, make sure that all parent and child issues are moved to the Completed progress state before you create an archive. An error is reported if the Completed progress state contains a completed parent issue with an open child issue, or a completed child issue with an open parent issue. To create an archive of completed issues: 1. Open the board. 2. Click Active Issues. 3. Verify the issues list in the Completed progress state. Note that the list may include some issues that are filtered out of the display of the current Active Issues view by the board s query. 4. Click Archive Completed Issues. 5. In the Archive Completed Issues dialog, in Archive Name edit the archive name (by default it is Archive <date-time stamp>) if required, verify the list of issues in the Completed progress state, select the I understand that the archived issues will be removed from the Active Issue view check box, and click Archive Issues. If you edited the default archive name, make sure that it is unique across all Kanban boards and Scrum sprint names. The name must not be longer than 255 characters. The completed issues are archived in the specified archive name and the Issues Report of the archive opens in the Reports view

164 Using the Agile Methodology in Oracle Developer Cloud Service Opening the Reports View Using the Reports View In the Reports view, you can view various issue reports To open the Reports view of a Kanban board: 1. Open the Kanban board. 2. Click the Reports toggle button. You can use the Burndown Chart to view the remaining amount of work to be done in a issues or epic. Use the Issues Report to view active issues and archived issues. Use the Epic Report to view completed and not completed, or open, stories of an epic. Use the Velocity Report to view the velocity chart of completed issues. What You See on the Reports View The following table describes the key information and elements shown on the Reports view. Board drop-down list Backlog / Active Sprints/Reports Board Displays the name of the open board. Click the board name to open the Switch Board menu and switch to another board. Click Backlog to switch to the Backlog view. See About the Backlog View. Click Active Sprints to return to the Active Sprints view. Click Reports to view the Burndown chart and the Sprint Report. From the list, select the desired option. Configure: Configure the board. See Configuring the Board. Copy Board: Copy the board. See Copying a Board. Delete Board: Delete the board. See Deleting a Board. View Burndown Chart, Sprint Report, Cumulative Flow Chart, and Control Chart. See Using the Burndown Chart, Using the Sprint Report, Using the Cumulative Flow Chart, and Using the Control Chart. View epic reports: Burndown Chart and Epic Report See Using the Burndown Chart and Using the Epic Report. Using Agile Reports and Charts Using the Burndown Chart Various types of reports and charts are available for your Scrum and Kanban boards. Use the Burndown Chart to view the remaining amount of work to be done in issues or epics. The Burndown Chart is available in Scrum boards and Kanban boards for issues and epics

165 Using the Agile Methodology in Oracle Developer Cloud Service To view the Burndown Chart: 1. Open the desired board. 2. Click Reports. 3. Click or. 4. Select theburndown Chart tab. Scrum Boards For a Scrum board, the chart for your active sprint is displayed. To choose a different sprint, click the Sprint drop-down. To choose a different estimate criterion, click the Burndown drop-down and select from Estimated Days, Story Points, or Number of Issues. The Y-axis in the chart reflects this setting. The Burndown Chart displays the configured Tracking Statistic for the active sprint, start and end dates, capacity for the sprint, and a guideline for completing the statistic you are tracking in the sprint. The horizontal axis in a Burndown Chart tracks time, and the vertical axis represents your configured Tracking Statistic: story points, estimation days, or number of issues. Use a Burndown Chart to see the total work remaining and to increase the accuracy of predicting the likelihood of achieving the sprint goal. By tracking the remaining work throughout the iteration, your team can manage its progress and respond appropriately if things do not go as planned. If Time Tracking is enabled for the board, the Burndown Chart will always show Remaining Days and Time Spent. The Burndown Chart includes all issues in the sprint, those that have been completed and those that have yet to be completed. The mapping of statuses to your board determines when an issue is considered Not Completed or Completed. At the bottom of the page there is a historical table of events associated with the sprint, including issues that are incomplete at the end of the sprint. Kanban Boards For a Kanban board, the chart for your active issues is displayed. To choose an archived issue version, click the Issues list and select the desired option. The Burndown Chart displays the configured Tracking Statistic for the active issues. The horizontal axis in a Burndown Chart tracks time, and the vertical axis represents your configured Tracking Statistic: story points, estimation days, or number of issues. Use a Burndown Chart to see the total work remaining and to increase the accuracy of predicting the likelihood of achieving the goal. By tracking the remaining work throughout the iteration, your team can manage its progress and respond appropriately if things do not go as planned. If Time Tracking is enabled for the board, the Burndown Chart will always show Remaining Days and Time Spent. The Burndown Chart includes all issues, completed and pending. The mapping of statuses to your board determines when an issue is considered Not Completed or Completed. At the bottom of the page there is a historical table of events associated with the issues, including issues that are incomplete

166 Using the Agile Methodology in Oracle Developer Cloud Service Using the Sprint Report Use the Sprint Report to view completed and not completed, or open, issues of a sprint. The Sprint Report is available for sprints in Scrum boards only. To view the Sprint Report: 1. Open the desired board. 2. Click Reports. 3. If necessary, click. Using the Issues Report 4. Select the Sprint Report tab. The Sprint Report Chart for your active sprint is displayed. To choose a different sprint, click the Sprint drop-down. To choose a different estimate criterion, click the Burndown drop-down and select from Estimated Days, Story Points, or Number of Issues. The Y-axis in the chart reflects this setting. The Sprint Report provides a day-by-day progress report with much of the same information that is in the Burndown Chart, albeit in a slightly different format. The Sprint Report shows the list of issues in each sprint. It can provide useful information for your Sprint Retrospective meeting and for mid-sprint progress checks. The mapping of statuses to your board determines when an issue is considered "Completed" or "Not Completed. If Time Tracking is enabled for the board, the Sprint Report chart will always show Remaining Days and Time Spent. At the bottom of the page, the Sprint Report displays tables of completed, open, and removed issues. Use the Issues Report to view active issues and archived issues. The Sprint Report is available for issues in Kanban boards only. To view the Issues Report: 1. Open the desired board. 2. Click Reports. 3. If necessary, click. 4. Select the Issue Report tab. The Issue Report Chart of active issues is displayed. To choose an archived issue version, click the Issues list and select the desired option. The Issues Report provides a day-by-day progress report with much of the same information that is in the Burndown Chart, albeit in a slightly different format. The Issues Report shows the list of active issues and completed issues. If Time Tracking is enabled for the board, the Issue Report chart will always show Remaining Days and Time Spent

167 Using the Agile Methodology in Oracle Developer Cloud Service Using the Epic Report At the bottom of the page, the Issues Report displays a table of issues. If Active Issues (default) is selected in the Issues dropdown list, the table lists completed and non-completed issues. If an archive is selected in the Issues dropdown list, the table lists only completed issues. For each issue, the report shows the original estimate value and modified values in Estimated Days (or Story Points). Use the Epic Report to view completed and not completed, or open, stories of an epic. The Epic Report is available in Scrum boards and Kanban boards for epics. To view the Epic Report: 1. Open the desired board. 2. Click Reports. 3. Click. 4. Select the Epic Report tab. For Scrum Boards The Epic Report Chart for your active sprint is displayed. To choose a different epic, click the Epic drop-down. To choose a different estimate criterion, click the Burndown drop-down and select from Estimated Days, Story Points, or Number of Issues. The Y-axis in the chart reflects this setting. The Epic Report provides a day-by-day progress report with much of the same information that is in the Burndown Chart, albeit in a slightly different format. The Epic Report shows the list of stories (or sub-issues) in each epic. It can provide useful information for your Epic Retrospective meeting and for mid-sprint progress checks. The mapping of statuses to your board determines when a story is considered "Completed" or "Not Completed. If Time Tracking is enabled for the board, the Epic Report chart will always show Remaining Days and Time Spent. At the bottom of the page, the Epic Report displays tables of completed, open, and removed stories. For Kanban Boards The Epic Report Chart for your active issues is displayed. To choose an archived issue version, click the Issues list and select the desired option. The Epic Report provides a day-by-day progress report with much of the same information that is in the Burndown Chart, albeit in a slightly different format. The Epic Report shows the list of stories (or sub-issues) in each epic. It can provide useful information for your Epic Retrospective meeting and for progress checks. The mapping of statuses to your board determines when a story is considered "Completed" or "Not Completed. If Time Tracking is enabled for the board, the Epic Report chart will always show Remaining Days and Time Spent. At the bottom of the page, the Epic Report displays tables of completed, open, and removed stories

168 Using the Agile Methodology in Oracle Developer Cloud Service Using the Velocity Report Use the Velocity Report to view the velocity chart of completed sprints. The Velocity Report is available for Scrum boards only. To view the Velocity Report: 1. Open the desired board. 2. Click Reports. 3. Click. 4. In Estimation, select Estimated Days, Story Points, or Number of Issues. 5. Depending on the value selected for Estimation, Velocity Chart is displayed for Committed and Completed values. If Story Points is selected in Estimation, then the chart also shows the Suggested Capacity for each sprint as a dashed horizontal line. The Velocity Report shows a Velocity chart, which shows a graph of the last seven completed sprints for the selected estimation, and a table listing the completed sprints, the number of issues in each sprint, estimated values committed, and estimated values completed. Active sprints are not shown or listed. Using the Velocity Report, you can plan the amount of work that can be committed to future sprints. Managers can see whether the team met the original estimation and can plan the effort required for new or future sprints. At the bottom of the page, the Velocity Report displays the sprint table. The columns change depending on the value selected in Estimation. Estimation Table Columns Estimated Days Sprint: Displays the name and link of the sprint Owning Board: Displays the name and link of the parent board. Sprint Completed Time: Displays the date-time stamp when the sprint was completed. Number of Issues: Displays the number of issues in the sprint. Estimated Days Committed: Displays the sum of the estimated day values for all of the committed issues in the sprint. Estimated Days Completed: Displays the sum of the estimated days for all of the completed issues in the sprint. Story Points Sprint: Displays the name and link of the sprint Owning Board: Displays the name and link of the parent board. Sprint Completed Time: Displays the date-time stamp when the sprint was completed. Number of Issues: Displays the number of issues in the sprint. Story Points Committed: Displays the sum of story points for all committed issues in the sprint when the sprint is completed. Story Points Completed: Displays the sum of story points for all completed issues when the sprint is completed. Story Points Capacity: Displays the story point capacity of the sprint

169 Using the Agile Methodology in Oracle Developer Cloud Service Estimation Table Columns Number of Issues Sprint: Displays the name and link of the sprint Owning Board: Displays the name and link of the parent board. Sprint Completed Time: Displays the date-time stamp when the sprint was completed. Number of Issues Committed: Displays the number of issues added to the sprint. Number of Issues Completed: Displays the number of issues that were closed when the sprint was completed. Using the Cumulative Flow Chart Use the Cumulative Flow Chart to view the total number of issues in each of the board's progress states over time. The Cumulative Flow Chart is available in Scrum boards and Kanban boards for issues only. To view the Cumulative Flow Chart: 1. Open the desired board. 2. Click Reports. 3. If you are using a Scrum board, click. If you are using a Kanban board, click. 4. Select the Cumulative Flow Chart tab. Scrum Boards The Cumulative Flow Chart displays the total number of issues in each of the board's progress states over time for the active sprint. The issues listed in the chart are the same issues displayed in the Sprint Report. The following events can change the number of issues in a progress state: An issue is added to the sprint An issue is removed from the sprint An issue s progress state in the sprint changes because its status or resolution was changed The progress states correspond to the board's current list shown in the Configure Board page. The chart is a stacked area chart enabling the user to view the number of issues in each progress state and also the total number of issues in the sprint at any given point on the timeline. The color for each progress state is randomly assigned. The user can also show or hide any of the progress states on the chart by clicking on their names in the chart legend. The events table has a column for each progress state and shows the number of issues for each progress state that is affected by the event

170 Using the Agile Methodology in Oracle Developer Cloud Service Kanban Boards Using the Control Chart The Cumulative Flow Chart displays the total number of issues in each of the board's progress states over time for the Active Issues or an archive. The issues listed in the chart are the same issues displayed in the Issues Report. The following events can change the number of issues in a progress state: An issue is added to active issues or an archive An issue is removed from active issues or an archive An issue s progress state in active issues or an archive changes because its status or resolution was changed The progress states correspond to the board's current list shown in the Configure Board page. The chart is a stacked area chart enabling the user to view the number of issues in each progress state and also the total number of issues in active issues or archive at any given point on the timeline. The color for each progress state is randomly assigned. The user can also show or hide any of the progress states on the chart by clicking on their names in the chart legend. The events table has a column for each progress state and shows the number of issues for each progress state that is affected by the event. Use the Control Chart to view information for issues about their progress state changed event on the timeline. The Control Chart is available in Scrum boards and Kanban boards for Sprint Report and Issues Report. The Control chart is a scatter chart and each point on the chart represents a progress state changed event on the timeline. The progress state changed event occurs when an issue is moved from one progress state to another progress state. To view the Control Chart: 1. Open the desired board. 2. Click Reports. 3. If you are using a Scrum board, click. If you are using a Kanban board, click. 4. Select the Control Chart tab. The Y-axis of the chart shows the number of days that an issue spent in its previous progress state (the progress state from which the issue was moved). For example, if the status of an issue was changed on Jan 10 from To Do to In Progress, the chart displays a point on Jan 10 and the Y-axis shows the number of days the issue was in the To Do progress state. The colors for the progress states are randomly assigned and the user can hide or show the points for each progress state by clicking on the names of the progress states in the chart legend. Click the chart legend to display a line on the chart that shows the average number of days spent in a progress state

171 Using the Agile Methodology in Oracle Developer Cloud Service Configuring the Board The events table has a column for each progress state in the board, where the values are the number of days spent in the progress state at the time of each event. Note that the average number of days is NOT displayed in the table as it is displayed in the chart. You can configure a board and edit its name and other properties from the Board menu. To configure a board: Editing Board Properties 1. In the navigation bar, click Agile. 2. Open the board that you want to configure. 3. Click Board and select Configure. You can perform the following actions from the Configure Board page: Edit board properties, such as its name, description, associated search query, and estimation criterion. Edit or add the progress states of the board. From the Configure Board page, you can edit and update the name, description, associated issue search query, and estimation criterion of a board. To edit board properties: 1. Open the Configure Board page of the board you want to edit. See Configuring the Board. 2. If necessary, select the General tab. 3. In the Configure Board page, complete the elements using the descriptions in the table. Type Owner Name Search Estimation Displays the board type: Scrum or Kanban. Displays the name of the board owner. Edit the name of the board. Enter or edit the description of the board. Select the issue search query that you want the board to be associated with. To create your own issue search query, see Using the Advanced Search. Select Story Points or Estimated Days to define the estimation units or divisions that will be shown in the sprint reports or burndown charts

172 Using the Agile Methodology in Oracle Developer Cloud Service Time Tracking Select On to enable time tracking in the board. If enabled, then the Active Sprints page will show the estimation in Remaining Days only. The Backlog page will show the estimation in Remaining Days if estimation metric is Estimated Days. Select Off to disable time tracking in the board. If disabled, then the Backlog, Active Sprints and Reports pages will show the chosen metric for Estimation (estimated days or story points) instead of Remaining Days and Time Spent. 4. Click Save. Editing Board Progress States You can edit the conditions of a board s progress states. To edit board progress states: 1. Open the Configure Board page of the board you want to edit. See Configuring the Board. 2. Select the Progress States tab. 3. In the Configure board page, complete the elements using the descriptions in the table. New Progress State Progress States list Click to create a custom progress state. List of all progress states of the current board. By default, To Do, In Progress, and Completed are available. Select a progress state to edit its name, description, and conditions. Note: Use the order buttons in the list to change the orders of the states, if necessary. The buttons appear when you mouse over the state name. The order of states in the list are reflected in the Swimlanes and Columns views of the Active Sprint page. The Completed state must be the last state in the list. You cannot delete the Completed state, but you can delete other states. If Completed is not the last state in the list, a icon appears next to the state name. Any changes made to the page will not be saved until the Completed state is the last state in the list. You can use the order buttons to move it as the last state. Name Enter or edit the name of the progress state. Enter or edit the description of the progress state

173 Using the Agile Methodology in Oracle Developer Cloud Service Suggested Issue Capacity Completed State Conditions and Unassigned Conditions Displays the recommended issue capacity of the selected progress state. If the number of issues exceed the suggested capacity, a warning icon and a message appears in the Active Sprints / Active Issues view. Indicates if the selected progress state is the Completed state. Lists all conditions of the progress state that are used to decide which state issues should be displayed in the board. To remove a condition from the Conditions list, select the condition, click the > icon, and move it to the Unassigned Conditions list. For example, if you have added Resolved - WorksForMe in the Unassigned Conditions list, all issues that are in the Resolved - WorksForMe state will not be displayed in the board. Note: You cannot create a custom condition. 4. Click Save. Editing Board Working Days You can configure the working days and non-working of a week by modifying the board calendar. The working and non-working days that you specify affects the output of the Sprint Report, Issues Report, and the Burndown Chart. To specify working and non-working days of the board: 1. Open the Configure Board page of the board you want to edit. See Configuring the Board. 2. Select the Working Days tab. 3. In the Working Days page, complete the elements using the descriptions in the table. Standard Working Days Select or deselect the check boxes of the working weekdays. By default, all week day check boxes are selected. Saturday and Sunday check boxes are not selected by default

174 Using the Agile Methodology in Oracle Developer Cloud Service Non-Working Days Show Non-Working Days in Sprint Report Chart Lists all non-working dates (such as holidays) of the board calendar. To add a date as a non-working date, click + New, add a description in, and select the date in the calendar. To mark the date as a non-working date every year, select the Repeat Every Year check box. To remove a date, mouse over the date in the left list and click the icon. Select (or deselect) to show (or hide) the non-working days in the sprint reports. If selected, the non-working days appear in gray at the top in the burndown charts. Copying a Board Deleting a Board 4. Click Save. The Sprint Report, Issues Report, and the Burndown charts will be updated to reflect the working and non-working days. You can copy an existing board to copy its properties to the new board. The properties include time tracking, progress states, and working days. To copy a board: 1. In the navigation bar, click Agile. 2. Open the board that you want to copy. 3. In the open board page, click Board on the right side of the page. 4. Select Copy Board. 5. In the Copy Board dialog, click Copy. 6. In the Configure Board page that opens for the copied board, in Name, enter a unique name. Update other properties of the board as desired. 7. Click Save. You can delete a board from the Board menu. Before you delete a board, make a note of the following: You cannot delete a Scrum board with active sprints. You must complete the active sprints before you delete the board. See Completing a Sprint. You can delete a Kanban board with Active Issues or archives. All issues of the deleted board are returned to the backlog. When you delete a Kanban board, a confirmation dialog appears listing the names of the archives owned by the board. To delete a board: 1. In the navigation bar, click Agile. 2. Open the board that you want to delete

175 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service 3. In the open board page, click Board on the right side of the page. 4. Select Delete Board. 5. In the Delete Agile Board dialog, select the I understand that my agile board will be permanently deleted check box and click Delete. Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Oracle Developer Cloud Service includes continuous integration services to build project source files. Topics About the Build Page Managing and Configuring Jobs Managing and Configuring Pipelines Using the Oracle Maven Repository Using the Oracle Developer Cloud Service Build Executor Environment Variables About the Software Installed on the Build Executor Running a Build Configuring a Job to Run a Build Automatically on Git Repository Updates Configuring a Job to Run a Maven Build Configuring a Job to Run an Ant Build Configuring the POM File to Upload or Download Dependencies from the Project Maven Repository Discarding Old Builds and Artifacts Downloading Build Artifacts Subscribing to a Job s Build Notifications Viewing a Build s Details About the Build Details Page Configuring a Build s Details Viewing a Build s Log About the Build Log Page Viewing SCM Changes About the SCM Changes Page Viewing a Build s Test Results About the Test Results Page Viewing the Test Details Page About the Test Details Page Viewing Test Suite Details 2-136

176 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service About the Test Suite Details Page Viewing Test Results History About the Test Results History Page Viewing a Build s SCM Polling Log About the SCM Poll Logs Page Viewing a Job s User Action History About the Audit Page About the Build Page Viewing a Job s SonarQube Analysis Summary About the SonarQube Analysis Summary Page Viewing a Project s Recent Build History About the Recent Build History Page Monitoring Jobs and Builds from IDEs Using the WebLogic Maven Plugin The Build page, also called as the Jobs Overview page, displays information about all build jobs and provides links to configure and manage them. About Builds, Jobs, and Pipelines A Job is a configuration that defines the software builds of your software application in the Oracle Developer Cloud Service project. The Oracle Developer Cloud Service build system is pre-configured with some plugins that you can use without installing any additional software. You can use the Oracle Developer Cloud Service build system for continuous integration and continuous delivery to Oracle Cloud services. A Pipeline enables you to define dependencies of jobs and create a path or a chain to run builds. A pipeline helps in running continuous integration jobs and reduce network traffic. Oracle Developer Cloud Service runs builds of jobs on Build VMs. To know more about Build VMs, see About Build VMs and Build VM Templates. What You See on the Builds Page The following table highlights what you see on the Jobs Overview page. Build Queue View Recent Build History Job Statistics Jobs tab Pipelines tab Displays all jobs in the queue. To stop a build in the queue, click the icon. Displays the history of all builds of the project. See About the Recent Build History Page. Displays the job statistics in a pie chart format. Create, view, and manage build jobs. See About the Jobs Tab. Create, view, and manage build pipelines. See About Pipelines. About the Pipelines Tab

177 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service What You Can Do from the Builds Page See Actions You Can Perform on the Build page. For frequently asked questions, see Questions about the Builds Page and the Build System. Managing and Configuring Jobs About the Jobs Tab You can create, manage, and configure jobs from the Jobs tab of the Build page. You use the Jobs tab in the Build page to create a job and view existing jobs. The following table highlights what you see on the Jobs tab. + New Job Create a build job. See Creating a Job. All Jobs/Successful Jobs/Failed Jobs/ Test Failed Jobs Jobs table The button is disabled for non-members of a shared project. Click the toggle button to filter the jobs list in the jobs table. By default, the jobs table lists all jobs. Lists jobs matching the filter criteria and displays information in the following columns: Status: Indicates the status of the last job build. See About the Job Status. Weather: Indicates the stability of the job. See About the Job Stability. Job: Displays the name of the job. Click the link to open the job details page. Last Success: Displays the build number and date-time stamp of the last successful build. Last Failure: Displays the build number and date-time stamp of the last build failure. Duration: Displays the duration of the last build. Actions: Click to run a build. Click to configure the job. Click to open the log console of the last build. Click to delete the job. Note: For non-members of the project, is disabled, and and actions are not available

178 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service About the Job Status A job can be in one of the various states including successful, failed, in progress, and aborted. The following table describes the job status icons. Status Icon Indicates the last build of the job was successful. Indicates the last build of the job failed. Indicates a build of the job is in progress. Indicates the last build of the job was aborted. Indicates the last build of the job was unstable. Indicates a build of the job has not run and is pending. Indicates builds of the job have been disabled. About the Job Stability The stability of a job is indicated by an icon in the Weather column of the Jobs table in the Jobs tab. The following table describes the job stability weather icons in the Jobs table. Weather Icon Indicates the build stability of the job is between 0% and 20%. Indicates the build stability of the job is between 20% and 40%. Indicates the build stability of the job is between 40% and 60%. Indicates the build stability of the job is between 60% and 80%. Indicates the build stability of the job is between 80% and 100%. Creating a Job To run builds and generate artifacts that you can deploy, you must create a job. You can create a job from the Build page. To create a job: 1. In the navigation bar, click Build

179 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service 2. Click the Jobs tab, if necessary. 3. Click + New Job. 4. In the New Job dialog, complete the elements using the descriptions in the following table. Viewing Job Details Job Name (Required) Enter a unique job name of length less than 256 characters. Use for Merge Request Create New Copy Existing Job Software Template 5. Click Create Job. Enter a description of the job. Select the check box if you want to link this job with a merge request. If you select the check box, the merge request parameters are automatically enabled for the job. Select the option and create a blank job where you must configure parameters to run a build. Select the option and then select an existing job from the From Job list whose parameters you want to copy to the new job. After the job is created, you can then change the parameters of the new job. Select the Compute Build VM template with the necessary software. 6. In the Configure Build Job page, specify the configuration options and click Save. For more information about the configuration options, see Configuring a Job. Click the job name in the Jobs Overview page to view its details. To view details of a job: 1. In the navigation bar, click Build. 2. Click the Jobs tab, if necessary. 3. In the Jobs table, click the job name link. The Job Details page opens. About the Job Details Page The Job Details page displays the job build history, build trend, and links to various pages that show more details of the open job. What You See on the Job Details Page The following table describes the key information and elements shown on the Job Details page. Jobs Overview > job name Breadcrumb navigation of the job. Click Jobs Overview to return to the jobs Overview page

180 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Build Now Configure Enable or Disable Delete Job Details Notifications Permalinks Build History Run a build of the job. When a build runs, the message New build #<build_id> Waiting for Executor appears in Build History indicating that it is waiting for the next available executor to run the job. When it gets an executor, the status is replaced by a status bar, and the build number appears in the Build History table. To cancel a running build, click the bar above the Build History table. icon adjacent to the progress Configure the job. For more information about available configuration options, see Configuring a Job. Enable or disable the job. Delete the job. Displays details of the job. Displays the job's description. Indicates the status of job s build notifications for subscribed users. The notifications are enabled by default when a job is created. Click the On or Off toggle button to enable or disable build notifications for all subscribed users. To subscribe yourself to the build notifications of the job, click the CC Me icon and configure the build events in the CC Me dialog. See Subscribing to a Job s Build Notifications. Displays the permanent links of the following job build: Last: Opens the Build Details page of the last build Successful: Opens the Build Details page of the last successful build Failed: Opens the Build Details page of the last failed build Test Failed: Opens the Build Details page of the last build whose tests failed Unsuccessful: Opens the Build Details page of the last unsuccessful build (CANCELED, ABORTED, or RESCHEDULED). Displays the job s build history. See Viewing a Job s Build History. View recent changes made to the source code that triggered the build. The Recent SCM Changes page displays the files that were edited or added in the latest build of the selected job. You can also view the console output and Git build data from the Recent SCM Changes page. View and download archived artifacts of the recent build from the Artifacts Archived page. View Javadoc of the latest build. View the latest JUnit test results of the latest build. See About the Test Results Page. View the console log of the latest build. View the SCM polling log of the latest build. See About the SCM Poll Logs Page

181 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Build Trend View the Audit log of user actions. See About the Audit Page. View the SonarQube analysis report of the job. See About the SonarQube Analysis Summary Page. Displays a graphical representation of the build time trend. The X-axis represents build numbers and the Y-axis represents the duration (in minutes). Note: A build with duration of less than one second is not displayed in the graph. Test Result Trend Displays a graphical representation of the JUnit tests trend. The graph indicates the number of Error, Skipped, Failed, and Passed Tests. Click the graph buttons Vertical, Horizontal, Unstack, Stack to change the graph. Configuring a Job From the Configure Build Job page, you can configure or edit a job so that when the job is built, it will perform the specified tasks. The tasks may include enabling and disabling builds, discarding old builds, configuring parameters for the build, and configuring Git repositories for the builds. To configure a job: 1. In the navigation bar, click Build. 2. Click the Jobs tab, if necessary. 3. In the Jobs table, click the job name link. 4. Click Configure. The Configure Build page is categorized into two categories, where each category is divided into various tabs for the configuration settings of the job and its builds. Tab Configure the job to use and set source control, build parameters, build environment, builders (or build steps), and post build options. Configure the settings, such as general settings, software settings, build triggers, and advanced options of the job. Configuring the Source Code Management System for Builds Use the Source Control tab in the Configure Build Job page to configure repositories, branches, and advanced Git settings

182 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service To configure Git source control: 1. Open the Configure Build Job page of the job. See Configuring a Job. 2. Click, if necessary. 3. Click the Source Control tab. 4. Click the Add Source Control list and select the Git option. In the Git section, specify and configure the Git repository for the job. To remove the section, on the right side of the section header, click the icon. To move the section, mouse over the section title, and then drag-and-drop it above or below another section. The following table highlights what you can set in the Git section. Repository Advanced Repository Options Name Ref spec Local Checkout Directory Branch Automatically perform build on SCM commit (Required) Select or enter the repository name from the list. While creating the job, if you selected the Use for Merge Request check box in the New Job dialog, the field will be automatically populated with the${git_repo_url} value. Expand the Advanced Repository Options subsection to configure the advanced options for the selected Git repository. Enter the unique remote name of the repository. Leave the field empty to use the default remote name origin of the repository. Specify the reference specification of the repository. This is an optional field. Leave the field empty to create a default reference specification. Specify a local directory where the Git repository will be checked out. If left empty, the workspace root itself will be used. Select the branch name of the repository that you want to track. By default, master will be tracked. While creating the job, if you selected the Use for Merge Request check box in the New Job dialog, the field will be automatically populated with the${git_repo_branch} value. Select the check box if you want run a build on every push to the project Git repository. Note: The builds do not run automatically for external Git repositories. To run automatic builds of external Git repositories, enable SCM polling. See Configuring SCM Build Triggers. Advanced Git Settings Expand the Advanced Git Settings to configure the advanced options for the Git repository

183 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Included Region Excluded Region Excluded User Merge another branch Checkout revision Config user.name Config user. Merge from another repository Prune remote branches before build Skip internal tag Clean after checkout Recursively update submodules Use commit author in changelog Enter the list of files and directories that will be tracked for changes in the SCM. If a change occurs in any of the specified files or directories, a build is triggered automatically. Each inclusion uses regular expression pattern matching, and must be separated by a new line. An empty list implies that all files and directories will be tracked. For example, the following list illustrates that a build will be triggered when any HTML, JPEG, or GIF file is committed to the / main/web/ directory in the SCM. myapp/src/main/web/.*\.html myapp/src/main/web/.*\.jpeg myapp/src/main/web/.*\.gif Enter the list of files and directories that will not be tracked for changes in the SCM. If a change occurs in any of the specified files or directories, a build will not run. If there is an overlap between included and excluded regions, exclusions take precedence over inclusion. Enter the list of users whose commits to the SCM will not trigger builds. You can use literal pattern matching and users must be separated by a new line. Specify the branch name to merge to. If specified, checkout the revision to build as HEAD on this branch. If Merge another branch is specified, checkout the specified revision to build as HEAD on the value of Merge another branch. Enter a user name value for the Git user.name variable. Enter the user s address for the Git user. variable. Select the check box to perform a merge to a particular branch before running a build. Repository: Enter or select the name of the repository to be merged. Branch: Enter or select the name of the branch to be merged. If no branch is specified, the default branch of the repository is used. The build runs only if the merge is successful. Select the check box to run the git remote prune command for each remote to prune obsolete local branches before running a build. Selected by default to skip the internal tag. By default, a tag is applied to the local repository after the code is checked out. Deselect the check box to not to skip the internal tag. Select the check box to run the git clean -fdx command after every checkout to ensure a clean build. Select the check box to retrieve all sub-modules recursively. Select the check box to use the commit's Author value in the build's changesets. By default, the commit's Committer value is used. Git creates a changeset every time you do a checkin. All the files that are checked in together are included in the changeset

184 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Wipe out workspace before build Select the check box to delete the contents of the workspace before running a build. 5. Click Save. You can specify multiple Git repositories for the job and then configure the job to access the files in the repositories. Note that if you specify more than one Git repository, the Local Checkout Directory field of the first Git repository can remain empty, but it must be set for other Git repositories. Configuring Build Parameters You can configure the Build Parameters from the Build Parameters tab. 1. Open the Configure Build Job page of the job. See Configuring a Job. 2. Click, if necessary. 3. Click the Build Parameters tab. 4. Select the build parameter from the Add Build Parameter list. String Parameter See Adding a String Parameter for more information. Password Parameter See Adding a Password Parameter for more information. Boolean Parameter See Adding a Boolean Parameter for more information. Choice Parameter See Adding a Choice Parameter for more information. Merge Request Parameters See Configuring Merge Request Parameters for more information. To remove the section, on the right side of the section header, click the icon. To move the section, mouse over the section title, and then drag-and-drop it above or below another section. 5. Click Save. Adding a String Parameter When you run a build after setting build parameters, a form is displayed before the build is started, allowing you to set a value or change the default value of parameters. A string parameter is a text parameter where users can enter a string value, which can be used during a build. The parameter can be used either as an environment variable or through variable substitution in some other parts of the configuration

185 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service To add a string parameter: 1. Open the Build Parameters tab. See Configuring Build Parameters. 2. Click Add Build Parameter and select String Parameter. The following table highlights what options you can set for a string parameter. Name Default Value (Required) Enter the name of the parameter that will be exposed to the build as an environment variable. Specify the default value of the field. Enter a description of the parameter. 3. Click Save. Adding a Password Parameter A password parameter is a text parameter, where users can enter a string value, which you can use during a build. The value can be specified either as an environment variable or through variable substitution in some other parts of the configuration. To add a password parameter: 1. Open the Build Parameters tab. See Configuring Build Parameters. 2. Click Add Build Parameter and select Password Parameter. The following table highlights what options you can set for a password parameter. Name Default Value (Required) Enter the name of the parameter that will be exposed to the build as an environment variable. Specify the default value of the field. Enter a description of the parameter. 3. Click Save. Adding a Boolean Parameter A boolean parameter is a parameter that can be used during a build, either as an environment variable, or through variable substitution in some other parts of the configuration. Its value could be true or false. To add a boolean parameter: 1. Open the Build Parameters tab. See Configuring Build Parameters. 2. Click Add Build Parameter and select Boolean Parameter. The following table highlights what options you can set for a boolean parameter value

186 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Name Default Value (Required) Enter the name of the parameter. Select the default value of the field. By default, True is selected. Enter a description of the parameter. 3. Click Save. Adding a Choice Parameter A choice parameter is a string parameter that users can select from a list. This parameter can be used during a build, either as an environment variable, or through variable substitution in some other parts of the configuration. To add a choice parameter: 1. Open the Build Parameters tab. See Configuring Build Parameters. 2. Click Add Build Parameter and select Choice Parameter. The following table highlights the options you can set for a choice parameter. Name Choices (Required) Enter the name of the parameter that will be exposed to the build as an environment variable. (Required) Enter the list of potential choices. The first choice value will be the default. Enter a description of the parameter. 3. Click Save. Configuring Merge Request Parameters While creating the job, if you selected the Use for Merge Request check box, you can configure the merge request parameters. To add or configure merge request parameters: 1. Open the Build Parameters tab. See Configuring Build Parameters. 2. Click Add Build Parameter and select Merge Request Parameters. 3. Specify the default values for the following parameters: GIT_REPO_URL GIT_REPO_BRANCH MERGE_REQ_ID 4. Click Save. Merge Request parameters are automatically added the Use for Merge Request check box was selected in the New Job dialog. The job configuration dialog creates three String parameters GIT_REPO_URL, GIT_REPO_BRANCH, and MERGE_REQ_ID to accept the Git repository URL, the Git repository branch name, and the merge request ID as input 2-147

187 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service from the merge request respectively. The GIT_REPO_URL and GIT_REPO_BRANCH variables are automatically set in the Repository and Branch fields of the Source Control tab. Configuring the Build Environment Use the Build Environment tab to configure build environment options for the X virtual frame buffer (Xvfb), copy artifacts, SonarQube settings, SSH configuration, and Oracle Maven Repository. To configure the build environment: 1. Open the Configure Build Job page of the job. See Configuring a Job. 2. Click, if necessary. 3. Click the Build Environment tab. Select the build environment from the Add Build Environment drop-down list to add the relevant section. You can add the following kinds of build parameters to your build: Xvfb Wrapper See Configuring the Build Environment to use the Xvfb Wrapper for more information. SonarQube See Configuring the Build Environment to use SonarQube for more information. Copy Artifacts See Configuring the Build Environment to Copy Artifacts from Another Job for more information. Oracle Maven Repository Connection See Configuring the Build Environment to use the Oracle Maven Repository for more information. SSH Configuration See Configuring the Build Environment to use SSH for more information. To remove the section, on the right side of the section header, click the icon. To move the section, mouse over the section title, and then drag-and-drop it above or below another section. Configuring the Build Environment to use the Xvfb Wrapper Xvfb is an X server that implements the X11 display server protocol and can run on machines with no physical input devices or display. To add the Xvfb Wrapper to the build environment: 1. Open the Build Environment tab. See Configuring the Build Environment

188 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service 2. Click Add Build Environment and select Xvfb Wrapper. The following table highlights what options you can set for the Xvfb Wrapper. Display Number Specify the ordinal number of the display the Xvfb server will be running on. The default value is 0. If left empty, a random number will be chosen. Screen offset Specify the offset for display numbers. The default value is 0. Screen Size (WxHxD) Additional options Timeout in seconds Log Xvfb output Shutdown Xvfb with whole job, not just with the main build action 3. Click Save. Configuring the Build Environment to use SonarQube Specify the resolution and color depth of the created virtual frame buffer in the WxHxD format. The default value is 1024x758x24. Specify any additional Xvfb command line options. The default options are -nolisten inet6 +extension RANDR -fp /usr/ share/x11/fonts/misc. Specify the timeout duration for the build to wait before returning control to the job. The default value is 0. The check box is selected by default to redirect the output of Xvfb to the job log. Deselect the check box if you do not want to redirect the output. The check box is selected by default to keep the Xvfb server running for post-build steps. Deselect the check box if you do not want to keep the server running. You can configure the build environment to use SonarQube, an open source quality management software that enables you to continuously analyze your application. When configured, the build will generate an analysis summary that you can view from the job or the build details page. For more information about SonarQube, see its documentation at To configure SonarQube with the build environment: 1. Open the Build Environment tab. See Configuring the Build Environment. 2. Click Add Build Environment and select SonarQube Settings. The following table highlights options you can set for the SonarQube Settings. Sonar Server Username Password SonarQube Server URL Advanced SonarQube Settings Select the pre-configured SoarQube server from the list. Displays your SonarQube user name. Displays your SonarQube SSO password. Displays the URL of the SonarQube server

189 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Project Key Project Name Enter or update the SonarQube project key. By default, the field is set to <organization>_<projectname>.<jobname>. The SonarQube project key must be unique. Enter or update the SonarQube project name. By default, the field is set to <projectname>.<jobname>. The SonarQubename will be displayed in the Analysis Report. 3. Click Save. Configuring the Build Environment to Copy Artifacts from Another Job You can configure the build environment to copy artifacts from another build job. To configure a build environment to copy artifacts from another job: 1. Open the Build Environment tab. See Configuring the Build Environment. 2. Click Add Build Environment and select Copy Artifacts. The following table highlights what you can set in the Copy Artifacts section. From Job Which Build Select the job whose artifacts you want to import. Select the build that generated the artifacts. You can choose from the following options: Last Successful Build: Import artifacts from the last successful build. Last keep forever build: Import artifacts from the latest build that is marked as Keep Forever. For more information about how to mark a build as Keep Forever, see About the Build Details Page Upstream build that triggered this job: Import artifacts from the upstream build. Select the Use last successful build as fallback check box to use the artifacts from the last successful build if an error occurs in the upstream build. Specified by permalink: Import artifacts from the job specified by Permalink. In the Permalink list, select the desired permalink option (Last build, Last successful build, Last failed build, Last test failed build, or Last unsuccessful build). Specific build: Import artifacts from the selected build number in Build Number. In Build Number, specify the build number of the job whose artifacts you want to copy. Specified by a build parameter: Import artifacts from the build with the parameter specified in Parameter Name. By default, the value of Parameter Name is BUILD_SELECTOR

190 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Artifacts to copy Target Directory Flatten Directories Optional (Do not fail build if artifacts copy failed) 3. Click Save. Specify the artifacts that you want to import with their relative paths. If no value is specified, all artifacts are copied. Note that the archive.zip file is never copied. In the Job Details page or the Build Artifacts section of the Build Details page, you can find the artifacts generated by the job. Specify the target directory where the artifacts will be imported. Select the check box to flatten the target directory structure after importing artifacts. Select the check box to not to mark the build as failed if the artifacts specified in the Artifacts to copy are not copied to the current build. Configuring the Build Environment to use the Oracle Maven Repository You can configure the build environment to use and access the Oracle Maven Repository. Before you run a build, you must accept the Oracle Maven repository license agreement at using your Oracle Technology Network (OTN) Single-Sign On (SSO) credentials. To configure the Oracle Maven Repository to the build environment and to download artifacts and dependencies for your application.: 1. Open the Build Environment tab. See Configuring the Build Environment. 2. Click Add Build Environment and select Oracle Maven Repository Connection. The following table highlights what options you can set for the Oracle Maven Repository. Use Existing Connection OTN Login OTN Password Server Id Custom settings.xml The toggle button is enabled by default to use an existing and preconfigured OTN connection to connect to the Oracle Maven Repository. In the Select Connection list, select the desired connection. Disable the toggle button if you do not want to use an existing connection and want to provide your own details. Enter your OTN SSO user name. The field is enabled if the Use Existing Connection toggle button is disabled. Enter your OTN SSO password. The field is enabled if the Use Existing Connection toggle button is disabled. If required, enter the ID to use for the <server> element of the Maven settings.xml file. If not provided, the ID will default to maven.oracle.com. If you are using a custom settings.xml file, enter the path of the file in the project Git repository

191 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service 3. Click Save. Configuring the Build Environment to use SSH You can configure a job to use SSH to access any Oracle Cloud service that has SSH enabled, such as Oracle Cloud Infrastructure Compute Classic VMs. You can configure the job to use any of the following options, or both. Create an SSH tunnel to access a process running on a remote system, including an on-premise system, via the SSH port. The SSH tunnel is created at the start of the build job and is destroyed automatically when the job finishes. Set up the default ~/.ssh directory with provided keys in the build system workspace for use with the command-line tools. The modifications are reverted when the job finishes. To configure SSH Configuration of a job: 1. Open the Build Environment tab. See Configuring the Build Environment. 2. Click Add Build Environment and select SSH Configuration. The following table highlights what options you can set for the SSH configuration. Private Key Public Key Pass Phrase SSH Server Public Key Create SSH Tunnel Enter the private key of your SSH Private-Public key pair. Enter the public key of your SSH Private-Public key pair. Leave the field empty to use fingerprint. Enter the pass phrase of your SSH Private-Public key pair. Leave the field empty if keys are not encrypted with a pass phrase. Enter the public key of the SSH server. If you are using command-line SSH tools require, note that the host name and the IP address must match exactly. The host name and the IP address can be comma separated. Example: ssh1.example.com, ssh-rss.... Leave the field empty to skip host verification. For command-line tools like ssh the option -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null must be added explicitly to skip host verification. SSH tunnel provides an additional layer of security and can only be set up between trusted hosts. Select the check box to create an SSH tunnel and enter details in the following fields: Username: Name of the user who can connect to the SSH server Password: Password of the SSH user. Leave the field empty to use the key based authentication. Local Port: Port number of the client to used for local port forwarding Remote Host: Name of the remote host, or an interface on the SSH server Remote Port: Port number of the remote host or interface SSH Server: Name or IP address of the target SSH server Connect String: Displays the connect string to be used to set up the SSH tunnel 2-152

192 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Setup files in ~/.ssh for command-line ssh tools If you want to use command line SSH tools such as scp or sftp, select the check box to create and set up the private key and add the selected host in the known_hosts file in the ~/.ssh directory of the build system workspace. 3. Click Save. Configuring Build Steps Use the Builders tab in the Configure Build Job page to configure various types of build steps that can then be incorporated in the build. To configure the build steps: 1. Open the Configure Build Job page of the job. See Configuring a Job. 2. Click, if necessary. 3. Click the Builders tab. 4. Click Add Build Step and choose the desired build step. The following table highlights what you can set from the Add Build Step menu of the Build Steps tab. Unix Shell Builder Ant Builder Maven Builder Gradle Builder Node.js Builder SQLcl Builder PSMCli Builder OCICli Builder Docker Builder Reference See Adding an Unix Shell Builder. See Adding an Ant Builder. See Adding a Maven Builder. See Adding a Gradle Builder. See Adding a Node.js Builder. See Adding a SQLcl Builder. See Adding a PSMcli Builder. See Adding a OCIcli Builder. See Adding a Docker Builder. 5. Click Save. Adding an Unix Shell Builder To remove the section, on the right side of the section header, click the icon. To move the section, mouse over the section title, and then drag-and-drop it above or below another section. You can use the Unix shell builder to run a shell script for building the job. To add and configure Unix Shell Builder: 1. Open the Builders tab

193 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service See Configuring Build Steps. 2. Click Add Builder and select Unix Shell Builder. The following table highlights what you can set in the Unix Shell Builder section. Script Command print option Enter the contents of your shell script. This is a required field. The script runs with the workspace as the current directory. If there is no header line such as #!/bin/sh in your shell script, then the shell configured system-wide will be used, but you can also use the header line to write a script in another language (such as #!/bin/ perl) or control the options that shell uses. By default, the shell is invoked with the -ex option. All commands are printed before they run, and the build is considered a failure if any of the commands exits with a non-zero exit code. You can change this behavior by adding the #!/bin/... line. Tip: Do not enter a long shell script in this field. For a long script, create a script file and add it in the SCM. You can run the script with a command (such as bash -ex myscript.sh) and track changes in your shell script. You can use Kubernetes, PSMcli, Docker, Terraform, and OCIcli commands in the Shell script. Make sure that you have the required software in the Build VM template before you run a build. Select the Expand variables in commands, don t show I/O redirection (-x) option to show the values of the variables and hide the input-output redirection in the command log. Select the Show commands exactly as written (-v) option to show the command as it is in the log. Adding an Ant Builder 3. Click Save. You can use the Ant Builder option to use Ant as the build system. When the build runs, Ant is invoked with the given targets and options. Any non-zero exit code marks the build as a failure. To add and configure Ant Builder: 1. Open the Builders tab. See Configuring Build Steps. 2. Click Add Builder and select Ant Builder. The following table highlights what you can set in the Ant Builder section. Targets Build File Specify a list of Ant targets to be invoked, or leave it empty to invoke the default Ant target specified in the build script. You can also use this field to specify other Ant options. If your build requires a custom -buildfile, specify it here. By default, Ant will use the build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory

194 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Properties Properties needed by your Ant build can be specified here (in standard properties file format): # comment name1=value1 name2=$var2 These are passed to Ant like -Dname1=value1 -Dname2=value2. Always use $VAR style for parameter references (do not use %VAR% style, even when the build runs on Windows). Slashes are used for escaping, so use \\ for a single slash. Avoid double quotes (") because Ant on UNIX wraps parameters in quotes and runs them through eval, and Windows has its own issues with escaping. In either case, the use of quotes may result in a build failure. To define an empty property, simply write varname=. Java Options If your build requires a custom ANT_OPTS, specify it here. Typically this may be used to specify Java memory limits to use, for example -Xmx512m. Note that other Ant options (such as -lib) should go to the Targets field. 3. Click Save. Adding a Maven Builder You can use Maven Builder to use Maven as the build system. When a build runs, Maven is invoked with the given goals and options. A non-zero exit code marks the build as a failure. Some Maven versions have a bug that causes Maven not to return the exit code correctly. To add and configure Maven Builder: 1. Open the Builders tab. See Configuring Build Steps. 2. Click Add Builder and select Maven Builder. The following table highlights what you can set in the Maven Builder section. Goals POM File Advanced Maven Settings Use Private Repository Use Private Temp Directory Offline Enter Maven goals, or phases, to run. This is a required field. For example: clean and install are added by default. For more information about Maven goals, see the Maven Lifecycle Reference documentation at Enter the Maven POM file name and location, relative to the workspace root. The default value is pom.xml at the Git repository root. Expand to configure advanced options for the Maven builder. Select the check box to use a private repository for builds. Select the check box to use a private temporary directory for builds. Select the check box to work offline

195 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Show Errors Recursive Profiles Properties Verbosity Checksum Snapshot Projects Resume From Fail Mode Make Mode Threading JVM Options Select the check box to produce execution error detail messages. Indicates that all sub-modules will build recursively. The check box is selected by default. Enter the list of profiles to activate. The list can be comma or space separated. This is an optional field. For more information about Maven profiles, see the Maven documentation at Enter custom system properties in the key=value format. Select the Maven verbosity level from the list. You can select the level as NORMAL (default), QUIET, or DEBUG. Select the checksum handling mode from the list. You can select the mode as NORMAL (default), STRICT, or LAX. Select how SNAPSHOT artifact updates are handled. You can select the handling mode as NORMAL (default), FORCE, or SUPPRESS. This is an optional field. Enter the list of Maven project jobs to include in the reactor. The reactor is a mechanism in Maven that handles multi-module projects. This is an optional field. A project job can be specified by [groupid]:artifactid or by its relative path. The list can be comma or space separated. Enter the Maven job project name from where you would like to resume the reactor. The Maven job project can be specified by [groupid]:artifactid or by its relative path. Select the failure handling mode from the list. You can select the handling mode as NORMAL (default), AT_END, FAST, or NEVER. This is an optional field. Select the Make-like reactor mode from the list. You can select the mode as NONE (default), DEPENDENCIES, DEPENDENTS, or BOTH. Enter the configuration of the reactor threading model. Enter the parameters to be passed to the Java VM when running Maven via the MAVEN_OPTS environment variable. 3. Click Save. Adding a Gradle Builder You can use Gradle Builder to use Gradle as the build system. When a build runs, Gradle is invoked with the given goals and options. A non-zero exit code marks the build as a failure. For more information about Gradle, see To configure a Gradle Builder: 1. Open the Builders tab. See Configuring Build Steps. 2. Click Add Builder and select Gradle Builder. The following table highlights what you can set in the Gradle Builder section

196 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Gradle Tasks Build file Build file folder Switches Force GRADLE_USER_H OME to use workspace Select Invoke From (default) to invoke the default Gradle script to run builds. Select Use wrapper to use the specified Gradle wrapper script to run builds. Select the Make gradlew executable check box to make the gradlew command as an executable command. Select the From Root Build Script Dir check box to use the gradlew command from the root build script directory. Enter Gradle tasks to be invoked. The default tasks are clean build. Enter the name of the Gradle build file if it is not named as build.gradle. Enter the path and directory name of the top-level build.gradle file if it is available in a directory other than the module root directory. The specified path must be relative the module root directory. If left empty, the path defaults to build.gradle in the root directory. Enter Gradle switches to be invoked. If you are using a multi-executor slave, select the check box to set the GRADLE_USER_HOME to the workspace and avoid collisions while accessing Gradle cache. By default, GRADLE_USER_HOME is set to $HOME/.gradle. 3. Click Save. To view the dependency information of an artifact, see About the Browse View. Note: To download the external dependencies during a build, configure the proxy settings using the Gradle proxy configuration. See current/userguide/build_environment.html. Adding a Node.js Builder You can add a Node.js builder that invokes a Node.js script when the build runs. To configure a builder to invoke a Node.js script: 1. Open the Builders tab. See Configuring Build Steps. 2. Click Add Builder and select Node.js Builder. The following table highlights what you can set in the Node.js Builder section. Source Select NodeJS File to specify a NodeJS file in the Git repository. Select Script to enter the NodeJS script manually. The Script option is selected by default

197 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service NodeJS File Path NodeJS Script Enter the path of the Node.js script file that you want to run. You can copy the path of the file from the Code page. The field is available if you selected NodeJS File as Source. Enter the Node.js script code that you want to run. The field is available if you selected NodeJS File as Source. The field is available if you selected Script as Source. If you have the Node.js code in a snippet file, you can copy the code using the context menu Insert from Snippet option. Note: 3. Click Save. Adding a SQLcl Builder You can view the Node.js version from the Software tab. See Configuring Build Software. You can add a SQLcl builder that invokes SQL statements on an Oracle Database when the build runs. You can use the SQLcl builder to access any Oracle Database that you can connect to using a JDBC connect string. You can run DML, DDL, and SQL Plus statements. You can also use the SQLcl build step in a test scenario to run SQL scripts to initialize seed data or validate database changes. To know more about SQLcl, see Also see Using the help command in SQLcl in Using Oracle Database Exadata Express Cloud Service and the SQL Developer Command-Line Quick Reference documentation to know more about using SQLcl supported commands. To configure a builder to invoke SQL statements: 1. Open the Builders tab. See Configuring Build Steps. 2. Click Add Builder and select SQLcl Builder. The following table highlights what you can set in the SQLcl Builder section. Username Password Credentials File Enter the user name of the Oracle Database account. Enter the password of the Oracle Database account. Enter the workspace path of the uploaded credentials zip file required to connect to Oracle Database Exadata Express Cloud Service. You can download the credentials zip file from the Oracle Database Exadata Express Cloud Service service console. See Downloading Client Credentials in Using Oracle Database Exadata Express Cloud Service

198 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Connect String Source SQL File Path SQL Statements Role Restriction Level Enter the JDBC or HTTP connection string of the Oracle Database account using any of the host_name:port:sid or host_name:port/ service_name formats. JDBC Example: test_server.us.oracle.com:1521:adt1100 where adt1100 is the SID, and test_server.us.oracle.com:1521/ ora11g where ora11g is the service name. HTTP Example: demo Select SQL File if the SQL statements are in a file uploaded to the project Git repository. Select Inline SQL to specify the SQL statements. If you selected SQL File in Source, enter the path of the SQL file in the Git repository. You can copy the file s path from the Code page. If you selected Inline SQL in Source, enter the SQL statements in the code editor. Select the database role of the user. By default, it is set to Default. Specify the restriction level on the type of SQL statements that are allowed to run. By default, it is set to Default. 3. Click Save. When a build runs, your Oracle Database credentials are stored in an Oracle Wallet. Check the build s console for the SQL output or errors. Note: SQL commands that are specific to editing buffer (such as set sqlformat csv) or editing console are not supported. You can use build parameters in Username, Password, Connect String, and SQL Statements fields. See Configuring Build Parameters. You cannot use build parameters in the SQL file. If you are using Oracle REST Data Services (ORDS), some SQLcl commands, such as the BRIDGE command, would require a JDBC URL. Example: BRIDGE table1 as "jdbc:oracle:thin:demo/demo@ examplehost.com/ords/demo"(select * from DUAL); Adding a PSMcli Builder You can add a PSMcli builder that invokes Oracle PaaS Service Manager command line interface (CLI) commands when the build runs. You use PSMcli commands to manage the lifecycle of various services in Oracle Public Cloud. For more information about PSMcli and its commands, see About the PaaS Service Manager Command Line Interface in PaaS Service Manager Command Line Interface Reference. To configure a builder to invoke PSMcli commands: 1. Open the Builders tab

199 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service See Configuring Build Steps. 2. Click Add Builder and select PSMcli Builder. The following table highlights what you can set in the PSMcli Builder section. Username Password Identity Domain Region Output Format (Required) Enter the user name of the Oracle Cloud account. (Required) Enter the password of the Oracle Cloud account. The password is saved in a keystore plug-in in an encrypted format. (Required) Enter the identity domain. Select your identity domain s region: US ("us") (default) or EMEA ("emea"). Select the preferred output format: JSON ("json") (default) or HTML ("html"). You can also use build parameters in above fields. See Configuring Build Parameters. Tip: To add PSM Commands, add an Unix Shell Builder (see Adding an Unix Shell Builder) and enter PSM commands as the shell commands that you want to run when the build runs. For example, you can run commands to start or stop other Oracle Cloud PaaS environments when you run the build. After adding the Invoke PSMcli section, you can add multiple Unix Shell Builder build steps to run PSM commands and Linux commands. Enter the commands on separate lines of the Command field. No need to add the Invoke PSMcli build step again. Adding a OCIcli Builder You can add a OCIcli builder that invokes Oracle Cloud Infrastructure command line interface (CLI) commands when the build runs. You use OCIcli commands to work with Oracle Cloud Infrastructure objects and services. For more information about OCIcli and its commands, see the Oracle Cloud Infrastructure Command Line Interface documentation. To configure a builder to invoke OCIcli commands: 1. Open the Builders tab. See Configuring Build Steps. 2. Click Add Builder and select OCIcli Builder. The following table highlights what you can set in the OCIcli Builder section

200 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service User OCID Fingerprint Tenancy Private Key Region (Required) Enter the user s Oracle Cloud ID (OCID). Every Oracle Cloud Infrastructure resource has an Oracleassigned unique ID called an Oracle Cloud Identifier (OCID). You can find the user OCID in the web interface of Oracle Cloud Infrastructure Console. (Required) Enter the fingerprint of the public key of the RSA key pair in PEM format. If you have not generated an RSA key pair, generate it in the PEM format, not SSH-RSA format. (Required) Enter the tenancy OCID. You can find the user tenancy in the web interface of Oracle Cloud Infrastructure Console. Enter the private key of the RSA key pair in PEM format. Select the Oracle Cloud Infrastructure tenancy s region. 3. Click Save. Adding a Docker Builder To add OCI Commands, add an Unix Shell Builder and enter OCI commands as the shell commands that you want to run when the build runs. For example, oci and oci iam user list. See Adding an Unix Shell Builder. You can add a Docker builder that invokes Docker commands such as login, build, and push when the build runs. To run docker commands in a build, you must configure the job to use a Build VM template with the Docker software. See Configuring a Job. For more information about Docker commands, see Tip: You should use the Docker container for short tests and builds. Do not run a Docker container for long tests or builds, else the builds might not finish. For example, a Docker image that is listening on a certain port and behaves like a web server, the build will never exit. If you face any network issue while running a Docker command, it is recommended to add the HTTP_PROXY and HTTPS_PROXY environment variables into the Docker file. See Using the Oracle Developer Cloud Service Build Executor Environment Variables. To configure a builder to invoke Docker commands: 1. Open the Builders tab. See Configuring Build Steps. 2. Click Add Builder, select Docker, and then select the desired command. login build 2-161

201 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service tag push images save load rmi version 3. Click Save. The following sections describe the available Docker commands: Docker login command You use the login command to log in to the registry. The following table highlights the fields of the Docker login command section. Registry Host Username Password Select a pre-linked Docker registry, or enter the host name of the registry where Docker images are stored. If left empty, Docker Hub is set as the default registry host. If you are a project Owner, click + Link External Registry to link an external Docker registry. See Adding a Link to an External Docker Registry. (Required) Enter the registry login user name. If you select a pre-linked docker registry, its username is automatically filled in. (Required) Enter the registry login user password. If you select a pre-linked docker registry, its password is automatically filled in. Note: The Docker logout command runs automatically after all Docker commands have run. Docker build command You use the build command to build Docker images from a Dockerfile. The following table highlights the fields of the Docker build command section. Registry Host Image Name Version Tag (Required) Select a pre-linked Docker registry, or enter the host name of the registry where Docker images are stored. If left empty, Docker Hub is set as the default registry host. Enter the Docker image name. Enter the version tag name of the Docker image. The tag name must start with a letter or a number

202 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Full Image Name Options Source Context Root in Workspace Dockerfile Text Remote Context Root Displays the complete Docker image name in the <registry_host/ image_name:version_tag> format. Enter the Docker build command options. For more information, see reference/commandline/build/. (Required) Specify the source of the Dockerfile. Select Context Root in Workspace (default) if the Dockerfile is available in the build s workspace. Select Dockerfile Text if you want to enter the contents of the Dockerfile manually. Select Remote Context Root if the Dockerfile is available on an external source. If you selected Context Root in Workspace as Source, specify the workspace context root of the build context. If you selected Dockerfile Text as Source, enter the Dockerfile code. If you selected Remote Context Root as Source, specify the external context root URL of the build context. Tip: Include the protocol (example, http) if you are referencing a remote tar file (example: mydocker.tar.gz). Ignore the protocol if you are referencing a remote repository (example: git://github.com/me/ my.git#mybranch:myfolder). Dockerfile If you selected Context Root in Workspace or Remote Context Root as Source, specify the name and path of the Dockerfile relative to the build context root. Docker tag command You use the tag command to create a target image tag that refers to the source image. The following table highlights the fields of the Docker tag command section. Source Image Registry Host Image Name Version Tag Full Image Name (Required) Select a pre-linked Docker registry, or enter the host name of the registry where Docker images are stored. If left empty, Docker Hub is set as the default registry host. (Required) Enter the source Docker image name. Enter the version tag name of the source Docker image. The tag name must start with a letter or a number. Displays the complete source Docker image name in the <registry_host/image_name:version_tag> format

203 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Target Image Registry Host Image Name Version Tag Full Image Name (Required) Select a pre-linked Docker registry, or enter the host name of the registry where Docker images are stored. If left empty, Docker Hub is set as the default registry host. (Required) Enter the target Docker image name. Enter the version tag name of the target Docker image. The tag name must start with a letter or a number. Displays the complete target Docker image name in the <registry_host/image_name:version_tag> format. Docker push command You use the push command to push an image to the Docker registry. The following table highlights the fields of the Docker push command section. Options Registry Host Image Name Version Tag Full Image Name Specify the push command options. For more information, see (Required) Select a pre-linked Docker registry, or enter the host name of the registry where Docker images are stored. If left empty, Docker Hub is set as the default registry host. (Required) Enter the Docker image name. Enter the version tag name of the Docker image. The tag name must start with a letter or a number. Displays the complete Docker image name in the <registry_host/ image_name:version_tag> format. Docker images command You use the images command to list available images. The images (without any parameters specified) shows image names, version tags, and size of all top level images. The following table highlights the fields of the Docker images command section. Options Registry Host Image Name Version Tag Full Image Name Specify the images command options. For more information, see (Required) Select a pre-linked Docker registry, or enter the host name of the registry where Docker images are stored. The images are stored in the registry if they are pushed there. If left empty, Docker Hub is set as the default registry host. Enter the Docker image name. Enter the version tag name of the Docker image. The tag name must start with a letter or a number. Displays the complete Docker image name in the <registry_host/ image_name:version_tag> format

204 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Docker save command You use the save command to save an image to a.tar archive file. The following table highlights the fields of the Docker save command section. Output File Registry Host Image Name Version Tag Full Image Name (Required) Specify the relative path and name of the output.tar file in the workspace. (Required) Select a pre-linked Docker registry, or enter the host name of the registry where Docker images are stored. If left empty, Docker Hub is set as the default registry host. (Required) Enter the Docker image name. Enter the version tag name of the Docker image. The tag name must start with a letter or a number. Displays the complete Docker image name in the <registry_host/ image_name:version_tag> format. Docker load command You use the load command to load an image from a.tar archive file. The following table highlights the fields of the Docker load command section. Input File (Required) Specify the relative path and name of the input.tar file in the workspace. Docker rmi command You use the rmi command to remove an image from the client. The following table highlights the fields of the Docker rmi command section. What To Remove Registry Host Image Name Version Tag Full Image Name Options Select Newly Created Images to remove all newly created images. Select One Specific Image to remove a particular image from the registry. Select All Images to remove all images. If you selected One Specific Image in the Remove field, enter the host name of the registry where the Docker images are stored. The images are stored in the registry if they are pushed there. Until the images are pushed, the Registry Host is used to form the fully qualified name of the Docker image on the machine where the image is being created. If left empty, Docker Hub is set as the default registry host. (Required) Enter the Docker image name. Enter the version tag name of the Docker image. The tag name must start with a letter or a number. Displays the complete Docker image name in the <registry_host/ image_name:version_tag> format. Specify the rmi command options. For more information, see docs.docker.com/engine/reference/commandline/rmi/

205 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Docker version command You use the version command to view the version of Docker. The following table highlights the fields of the Docker version command section. Options Specify the version command options. For more information, see version/. Note: The Docker logout command runs automatically after all Docker commands have run. Configuring Post Build Actions You use the Post-build tab in the Configure Build Job page to configure actions you want the system to perform after the build completes. These actions can include archiving artifacts, publishing JUnit results, publishing javadoc, publish to a Git repository, and configure Oracle Cloud deployment tasks. To configure the post build steps: 1. Open the Configure Build Job page of the job. See Configuring a Job. 2. Click, if necessary. 3. Click the Post Build tab. 4. Click Add Post Build Action and choose the desired action. The following table highlights what you can set from the Add Post Build Action menu of the Post Build tab. Artifact Archiver JUnit Publisher SonarQube Result Publisher Javadoc Publisher Git Publisher Oracle Cloud Service Deployment 5. Click Save. Reference Archiving Artifacts Post Build Publishing JUnit Results Post Build Publishing SonarQube Result Post Build Publishing Javadoc Post Build Publishing Git Artifacts Post Build Deploying to Oracle Cloud Post Build 2-166

206 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Archiving Artifacts Post Build To remove the section, on the right side of the section header, click the icon. To move the section, mouse over the section title, and then drag-and-drop it above or below another section. You can use the Artifact Archiver post build action to archive artifacts of the build. In the Artifact Archiver section, you can specify how to archive the build artifacts (for example, distribution ZIP files or JAR files) so that they can be downloaded later. By default, artifacts of a build are kept as long as the build log is kept. To archive artifacts post build: 1. Open the Post Build tab. See Configuring Post Build Actions 2. Click Add Post Build Action and select Artifact Archiver. The following table highlights what you can set in the Artifact Archiver section. Artifacts from files Files to archive Files to exclude Artifacts from Maven build steps Archive Maven Artifacts Options Specify how and where the file artifacts are archived. Enter comma or space separated list of the file names that you want to archive. You can also use wildcards. Example: module/ dist/**/*.zip. The base directory is the build executor workspace. Enter comma or space separated list of the file names that you want to exclude from archive. You can also use wildcards. Example: foo/bar/**/*. A file that matches the specified pattern will not be archived even if it matches the pattern specified in the Files to archive field. Specify how and where the Maven artifacts are archived. Select the check box to archive Maven artifacts created by the build. Select the Include POM.xml check box to archive the Maven POM file from the build. In Compression, select the compression type, which will be applied to the selected artifacts. By default NONE is selected, which indicates no compression is applied. 3. Click Save. Publishing JUnit Results Post Build You can use the JUnit Publisher post build action to get useful information about test results, such as historical test result trends, failure tracking, and so on. To use this feature, you must first set up your build to run tests, then specify the path to JUnit XML files. If you are using Ant, specify the path such as **/build/testreports/*.xml. If you are using Maven, specify the path such as target/surefirereports/*.xml. Be sure not to include any non-report files into this pattern. To publish JUnit results: 2-167

207 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service 1. Open the Post Build tab. See Configuring Post Build Actions 2. Click Add Post Build Action and select JUnit Publisher. The following table highlights what you can set in the JUnit Publisher section. Include JUnit XMLs Exclude JUnit XMLs Retain long standard output/ error Organize test output by parent location Fail the build on fail tests Specify the build executor workspace path and names of generated raw XML report files to include. You can also use wildcards. By default, **/surefire-reports/*.xml is used. The base directory of the fileset is the workspace root. Specify the build executor workspace path and names of XML report files to exclude. You can also use wildcards. The base directory of the fileset is the workspace root. Select the check box to see standard output and errors in the test results after the build completes. The output is always saved in case the test fails, but by default, lengthy output is truncated to save space. Select the check box to see every log message, but note that memory consumption can substantially increase as a result and can slow the performance of the build executor. Select the check box to combine the test results into a single table of results. If you use multiple browsers, then the results will be categorized by browsers, that is you will see a table for each browser you use for testing. Select the check box to mark the build as failed if the JUnit tests fail. Archive Media Files Select the check box to archive videos and image files. 3. Click Save. Publishing SonarQube Result Post Build You can use the SonarQube Publisher post build action to get useful information about SonarQube test results. To publish SonarQube Result post build: 1. Open the Post Build tab. See Configuring Post Build Actions 2. Click Add Post Build Action and select SonarQube Result Publisher. Note: If you see the SonarQube settings not available in the Build environment warning, contact the project Owner to configure an external SonarQube server with your project. The following table highlights what you can set in the SonarQube Result Publisher section

208 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Apply SonarQube quality gate status as build status Archive Analysis Files Select the check box to use the SonarQube Quality Gate status as the build status. If the SonarQube Quality Gate status is Passed, the build would be marked as successful. If the SonarQube Quality Gate status is Failed, the build would be marked as failed. To know more about SonarQube Quality Gates, see docs.sonarqube.org/display/sonar/quality+gates. Select the check box to create an archive file of the SonarQube analysis files. 3. Click Save. Publishing Javadoc Post Build (Optional) Enter the result of the procedure here. You can publish the Javadoc and specify how and where to publish Javadoc that is generated during a build. To publish Javadoc post build: 1. Open the Post Build tab. See Configuring Post Build Actions 2. Click Add Post Build Action and select Javadoc Publisher. The following table highlights what you can set in the JUnit Publisher section. Javadoc Directory Retain Javadoc for each build Specify the path relative to the root of the workspace where generated Javadoc is published. By default, the path is set to target/site/apidocs. Select the check box to configure the build executor to retain Javadoc for each successful build. This enables you to browse Javadoc of older builds, but at the expense of additional disk space. The check box is not selected by default, so the build executor only keeps the latest Javadoc, and overwrites Javadoc of the old build. 3. Click Save. Publishing Git Artifacts Post Build You can publish the Git artifacts, such as tags, and branches, and push merge results to Git repository. To publish Git artifacts post build: 1. Open the Post Build tab. See Configuring Post Build Actions 2. Click Add Post Build Action and select Git Publisher. The following table highlights what you can set in the Git Publisher section

209 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Publish only if build succeeds Merge results Tag to push to remote repositories Tag to push Target remote name Branch to push to remote repositories Branch to push Target remote name Select the check box to push artifacts to the Git repository only if the build succeeds. Select the check box to push merges back to the target remote name. Specify the Git repository tag name to push at the completion of build. Environment variables can also be used in the tag name. They will be replaced when the build runs. The push will fail if the tag does not already exist. Select the Create new tag check box to create the tag if the tag name does not exist. The push will fail if a tag with the given name already exists. Specify the target remote name of the Git repository where the tag will be pushed. By default, origin is used Specify the Git repository branch name to push. Environment variables can also be used in the branch name. They will be replaced when the build runs. The push will fail if the branch does not already exist. Specify the target remote name of the Git repository where the branch will be pushed. By default, origin is used. The target remote name needs to be one of the repositories configured in the Source Control tab. See Configuring the Source Code Management System for Builds. 3. Click Save. Deploying to Oracle Cloud Post Build You can configure deployment actions of the specified deployment configuration and deploy the build artifacts. The build will be successful if the deployment action is successful. A deployment configuration must exist before you configure the deployment actions of the job. If required, create a deployment configuration to meet your requirements. See About the Deployment Configuration Page. To deploy to Oracle Cloud post build: 1. Open the Post Build tab. See Configuring Post Build Actions 2. Click Add Post Build Action and select Oracle Cloud Service Deployment. 3. In the Add Deploy Task list, select the desired deploy task. The following table highlights the deploy tasks that you can set in the Oracle Cloud Service Deployment section

210 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Deploy Task Deploy Undeploy Start Stop In Deployment Configuration, select the deployment configuration whose build generated artifacts that you want to deploy to the target Oracle Cloud Service instance when the build is complete. The list shows only those deployment configurations where the name of the job and the name of the deployment configuration match, and the deployment configuration is of type On Demand. The list is empty if the names do not match, or deployment configurations are of type Automatic. In Deployment Configuration, select the deployment configuration whose build generated artifacts that you want to undeploy from the target Oracle Cloud Service instance when the build is complete. In Deployment Configuration, select the deployment configuration whose deployment you want to start on the target Oracle Cloud Service instance when the build is complete. In Deployment Configuration, select the deployment configuration whose deployment you want to stop on the target Oracle Cloud Service instance when the build is complete. 4. Click Save. You can configure more than one deployment actions in a job. Note: If you change a deployment configuration or delete it after specifying the deployment action in the job, the changes are not reflected in the job and the build might not run as expected. For example, if you change the deployment configuration s type to Automatic after specifying the deployment action in the job, the artifact will get deployed twice. The first deployment will happen when the build is successful. The deployment will then trigger the next automatic deployment action of the deployment configuration. If you delete a deployment configuration or rename it after specifying the deployment action in the job, the build will attempt to deploy the artifact and will fail as the deployment configuration has been deleted or renamed. When you change a deployment configuration, make sure that you update the build s deployment action as well. Configuring the General Settings of a Job You can configure the general settings of job such as name and description, JDK version to be used, and discarding old builds. To configure general settings of a job: 1. Open the Configure Build Job page of the job. See Configuring a Job

211 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service 2. Click. 3. Click the General tab, if necessary. The following table highlights what you can set in the General tab. Name Disable Build (No new builds will be executed until the job is re-enabled) Execute concurrent builds if necessary Discard old builds Edit the name of the job. Edit the description of the job. Select the check box to disable job builds. To enable job builds, deselect the check box. If you created the job as a copy of an existing job, it is disabled by default. You must enable it to run builds. Select the check box to perform concurrent builds, if necessary. Deselect the check box to retain old builds. The check box is selected by default and discards old builds as specified. See Discarding Old Builds and Artifacts. 4. Click Save. Configuring Build Software Using the Software tab of the build configuration page, you can view the versions of software available on the build executor. For some software, you can change their default versions. To view and change the default version of build software: 1. Open the Configure Build Job page of the job. See Configuring a Job. 2. Click. 3. Click the Software tab. The following table highlights what you can set in the Software tab. Select a Software Template Available Software In Software Template, select the Build VM template that you want to use for your builds. View the versions of the software installed on the selected Build VM. Some software, such as Java, allow you to change their default version. 4. Click Save. Configuring Build Triggers Use the Build Triggers tab in the Configure Build Job page to configure options that trigger a build

212 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service To configure build triggers: 1. Open the Configure Build Job page of the job. See Configuring a Job. 2. Click. 3. Click the Triggers tab. The following table highlights what you can set in the Configure Triggers section. Trigger Periodic Build Trigger SCM Build Trigger Reference Configuring Periodic Build Triggers Configuring SCM Build Triggers 4. Click Save. Configuring Periodic Build Triggers You can schedule a job to run builds at specified period and schedule in Coordinated Universal Time (UTC). UTC is the primary time standard by which the world regulates clocks and time. For more information, see You specify the schedule using Corn expressions. If you are not a Cron expert, you can set the schedule easily by specifying values and the Cron expression will be created for you. If you are a Cron expert, use the Expert mode to enter the Cron expression manually. To configure periodic build triggers: 1. Open the Triggers tab. See Configuring Build Triggers. 2. Click Add Trigger and select Periodic Build Trigger. The following table highlights what you can set in the Periodic Polling Trigger section. Expert Mode Select the check box to enter the schedule information in the form of a Cron expression in the text box. See Specifying Cron Expressions. By default, the default pattern is 0/30 * * * *, which runs a build every 30 minutes. The Cron expression is validated immediately when the cursor moves out of the text box. Note that other fields of the section are not available when the check box is selected. If the check box is not selected, it displays the Cron expression of the schedule based on the values entered in the following fields

213 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Minute Hour Day of the Month Month Day of the Week Comment View Schedule Select the check box to specify the schedule in minutes within the hour. Valid values are By default, the check box is selected and 30 is set as the default value. Click Toggle Recurrence to add or remove 0/ in the beginning of the minute s value in the Cron expression. Select the check box to specify the schedule in hour of the day. Valid values are Click Toggle Recurrence to add or remove 0/ in the beginning of the hour s value in the Cron expression. Select the check box to specify the schedule in the day of the month. Valid values are Click Toggle Recurrence to add or remove 1/ in the beginning day of the month s value in the Cron expression. Day of the Month is not available if Day of the Week is selected. Select the check box to specify the schedule in the month. Valid values are JAN DEC, which translates to Click Toggle Recurrence to add or remove 1/ in the beginning of the month s value in the Cron expression. Select the check box to specify the schedule in the day of the week. Valid values are SUN SAT, which translates to 1-7. Click Toggle Recurrence to add or remove 1/ in the beginning of the day of the week s value in the Cron expression. Day of the Week is not available if Day of the Month is selected. Enter a comment for the schedule. Click to view the build schedule of the next ten builds, as per the specified time zone in the list next to the button. By default, it is set to UTC. To check the build schedule in a different timezone, select it from the list. Click View Schedule again to view the schedule. 3. Click Save. Configuring SCM Build Triggers You can schedule a job to run builds on SCM polling and at the specified schedule. If a schedule is specified, polling is triggered at a commit according to the schedule. To configure SCM build triggers: 1. Open the Triggers tab. See Configuring Build Triggers. 2. Click Add Trigger and select SCM Build Trigger. The following table highlights what you can set in the SCM Polling Trigger section

214 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Cron Pattern Schedule in timezone Enter the schedule information in the form of a Cron expression in the text box. The default pattern is 0/30 * * * *, which runs a build in 30 minutes. See Specifying Cron Expressions. The Cron expression is validated immediately when the cursor moves out of the text box. Select the timezone for the build schedule. By default, the timezone is set to UTC. Click View next few build trigger times to see the date and time of the next five builds. 3. Click Save. Specifying Cron Expressions You can use Cron expressions to define periodic build patterns. You can specify the Cron schedule information in the following format: MINUTE HOUR DOM MONTH DOW where: MINUTE is minutes within the hour (0-59) HOUR is the hour of the day (0-23) DOM is the day of the month (1-31) MONTH is the month (1-12) DOW is the day of the week (1-7) To specify multiple values, you can use the following operators: * to specify all valid values - to specify a range, such as 1-5 / or */X to specify skips of X's value through the range, such as 0/15 in the MINUTE field for 0,15,30,45 A,B,...,Z can be used to specify multiple values, such as 0,30 or 1,3,5 For more information about Cron, see Setting Advanced Options for the Job Use the Advanced tab in the Configure Build Job page to configure the advanced options for the job, such as quiet period and retry count. To configure the advanced options build environment: 1. Open the Configure Build Job page of the job. See Configuring a Job. 2. Click. 3. Click the Advanced tab

215 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service The following table highlights what you can set in the Advanced tab. Quiet period Retry count Abort the build if it is stuck Add Timestamps to the Console Output Max Log Size (MB) 4. Click Save. Viewing a Job s Build History Select the check box and specify the period in In seconds that a new build should wait before it runs in Quiet Period. The default value is 0. If the build server is busy with too many builds, setting a longer quiet period can reduce the number of builds. Select the check box to specify how many times a build of a job would run if it fails. In Build Retries specify the number of times the build executor will retry the build. The default value is 5. In SCM Retries specify the number of times the build executor will retry the build to checkout files from the Git repository. The default value is 5. Select the check box and specify the timeout duration in Hours and Minutes. The default value is 0 for both the fields. If a build does not complete in the specified amount of time, then the build will be terminated automatically and marked as aborted. Select the Fail the build on abort check box to mark the build as failed rather than marking it as aborted. Select the check box to add a time stamp for each log line in the build console. Note that the time on the build executor is UTC and the time displayed in the build job log is UTC - 7 hours. Specify the maximum size of the console log output retained by the job. The default value is 50 MB and the maximum value is 1000 MB. A job s build history can be viewed in the Build history section of the Job Details page. It displays the status of the running builds, and completed job builds in descending order (recent first) along with their build numbers, date and time, and a link to the console output of the build. Column By Status Shows an icon indicating who started the build. Mouse-over the icon to view details. : Indicates the build was initiated by a user. : Indicates the build was initiated by an SCM change. : Indicates the build was initiated by a pipeline. : Indicates the build was triggered by a periodic build trigger. Indicates the build s status

216 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Column Build Started Duration Indicates the build number. An * in the build number indicates the build is annotated with a description. Mouse over the build number to see the description. Click the build number link to open the build details page. See About the Build Details Page. Indicates the date-time stamp when the build ran. Indicates the build s duration. Actions Click to open the build s console and view the console log output. Click to delete the build. Note: Discarded and deleted jobs are not displayed. If a running build is stuck in the Queued status for a long time, mouse over the Queued status to see a message about the problem. To sort the table data in ascending or descending order, click the header column name and then click the Previous or Next icon in the column header. You can also right-click inside table column and then select the sort order from the Sort context menu. Disabling or Enabling a Job Deleting a Job You can disable or enable a job from the Job Details page. Copied jobs are disabled, by default. When a job is disabled, its manual or automatic builds won t run. To disable or enable a job: 1. In the navigation bar, click Build. 2. Click the Jobs tab, if necessary. 3. In the Jobs table, click the job name link. 4. Click the Disable or Enable button. You can delete a job from the Job Details page. When deleted, all builds and deployment artifacts of the job are also deleted. To delete a job: 1. In the navigation bar, click Build. 2. Click the Jobs tab, if necessary. 3. In the Jobs table, click the job name link

217 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service 4. Click the Delete button. 5. In the Delete Job dialog, select I understand that this job will be permanently deleted check box and click Delete. You can also delete the job from the Jobs table. Click to delete the job. Managing and Configuring Pipelines About Pipelines You can create, manage, and configure job pipelines from the Pipelines tab of the Builds page. Using a Pipeline, you can define dependencies of jobs and create a path or a chain to run builds. A pipeline helps in running continuous integration jobs and reduce network traffic. You can create a pipeline using a pipeline diagram where you can define the dependencies of jobs. When you create a dependency of a job over another, you define the order of automatic builds of the dependent jobs. The dependent jobs can be configured to use artifacts of the parent job too. For example, in the following diagram, Job 2 is dependent on Job 1 and will run after Job 1 is successful. In the following diagram, Job 2, Job 3, and Job 4 are dependent on Job 1 and will run after Job 1 is successful. The following diagram shows a complex example

218 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service The above diagram defines the following dependencies: Job 2 and Job 3 are dependent on Job 1 and will run after Job 1 is successful Job 4 and Job 5 are dependent on Job 2 and will run after Job 2 is successful Job 6 and Job 7 are dependent on Job 4 and will run after Job 4 is successful Job 8 is dependent on Job 6 and Job 7 and will run after Job 6 and Job 7 are successful Job 1 is the master job. Running Job 1 triggers a chain and all jobs from Job 1 through Job 8 will run automatically one after the other. You can create multiple pipeline diagrams of jobs. If multiple pipelines have some common jobs, then multiple builds will run of those jobs. For example, in the following figure, Pipeline 1 and Pipeline 2 have common jobs. Let s assume that in the Pipelines tab, Pipeline 1 is defined first and Pipeline 2 is defined second. The builds of these jobs will run in the following order: 1. A build of Job 1 runs

219 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service About the Pipelines Tab 2. Builds of Job 2 and Job 3 of Pipeline 1 get in the build executor queue after Job 1 is successful. A build of Job 2 of Pipeline 2 also gets in the build executor queue after Job 1 is successful. 3. Builds of jobs in build executor queue start running on first-come first-served basis. So, Job 2 and Job 3 of Pipeline 1 will run first. Let s call the build as build 1 of Job 2 and Job 3. Then, another build of Job 2 of Pipeline 2 will run. This will be the build 2 of Job A build of Job 4 of Pipeline 1 joins the build executor queue as soon as Job 2 is successful. A build of Job 3 of Pipeline 2 will also join the queue when Job 2 is successful. 5. As soon as the build executor is available, build 1 of Job 4 starts running and build 2 of Job 3 starts running. Remember that build 1 of Job 3 ran in Pipeline After a build of Job 3 of Pipeline 2 is successful, a build of Job 4 of Pipeline 2 will join the queue and run when the build executor is available. Remember that this will be build 2 of Job 4 as build 1 ran in Pipeline 1. While creating multiple pipeline diagrams with common jobs, be careful if a job is dependent on artifacts of the parent job. You use the Pipelines tab in the Build page to create a pipeline and view existing pipelines. The following table highlights what you see on the Jobs tab. + New Pipeline Creates a build pipeline. See Creating a Pipeline. Pipeline list Lists all pipelines. An Auto Start label is displayed if you enabled the pipeline to start when the pipeline jobs are built externally. A Disallow external build label is displayed if the pipelines jobs are disabled to run externally. Click to run a build of the pipeline. See About the Configure Pipeline Page. Click Click to edit the pipeline. See About the Configure Pipeline Page. to delete the pipeline. See Deleting a Pipeline. Creating a Pipeline To run builds of jobs that are dependent on another job, you must create a pipeline. You can create a pipeline from the Build page. To create a pipeline: 1. In the navigation bar, click Build. 2. Click the Pipelines tab. 3. Click + New Pipeline. 4. In the Create Pipeline dialog, enter the following information: 2-180

220 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Name (Required) Enter a unique pipeline name of length less than 256 characters. Auto start when pipeline jobs are build externally Disallow pipeline jobs to build externally when the pipeline is building 5. Click Create. Enter a description of the pipeline Select the check box to trigger the pipeline build if a job of the pipeline is triggered externally (outside the pipeline). All jobs following the triggered job in the pipeline will be built, but jobs preceding the triggered job will not be built. Select the check box to disable manual or automatic builds of the jobs that are part of the pipeline when the pipeline build is running. 6. In the Designing Pipeline page, design the pipeline, and click Save. See Designing Pipeline Diagrams. Viewing Instances of a Pipeline You can view a pipeline s instances, its jobs, and its build history from the Pipeline Instances page. To view instances of a pipeline: 1. In the navigation bar, click Build. 2. Click the Pipelines tab. 3. Click the pipeline name whose instances you want to view. About the Pipeline Instances Page When a pipeline build is triggered, an instance of it is created and is available in the pipeline s instances page. What You See on the Pipeline Instances Page The following table describes the key information and elements shown for each pipeline instance on the Pipeline Instances page. Pipeline Status Date-time stamp Indicates the status of the pipeline. A pipleline s status is determined by the builds of its jobs. : Indicates that all builds of the pipeline are successful. : Indicates that a build of a pipeline job failed, hence the pipeline has failed too. : Indicates the pipeline was cancelled. : Indicates a pipeline is in progress. The date-time stamp of the last pipeline run

221 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Cancel Delete Pipeline diagram If a pipeline is running, click to abort the pipeline. Click to delete the pipeline instance. Displays the pipeline diagram. The color of the job nodes of the pipeline diagram indicate their status. Green: Indicates the last build of the job is successful White: Indicates a build of the job is running or has not run yet Red: Indicates the last build of the job failed Configuring a Pipeline You can configure a job pipeline from the Pipelines tab of the Builds page. While configuring a pipeline, you can design or edit the pipeline diagram, change the pipeline settings, edit the pipeline name name and description. To configure a job pipeline: 1. In the navigation bar, click Build. 2. Click the Pipelines tab. 3. For the pipeline you want to edit, click. About the Configure Pipeline Page The Configure Pipeline page enables you to design or update the pipeline diagram. What You See on the Configure Pipeline Page The following table describes the key information and elements shown on the Configure Pipeline Page. Tab Configure the pipeline diagram. See Designing Pipeline Diagrams. Edit pipeline settings. See Creating a Pipeline to know about the fields you can update. Save Cancel Click to save the diagram. Click to cancel the page updates. Designing Pipeline Diagrams Using a pipeline diagram, you can define the dependency of jobs and the order of their builds. The following table highlights what you see and do on the Pipeline Design page

222 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Jobs Designer area Shows all jobs of the project on the left side of the page. Use to design the pipeline diagram. From the Jobs list, drag-and-drop the jobs you want to add to the pipeline to the designer area and create dependencies among them. You can use the mouse scroll-wheel to zoom in and out on the designer area. Click in the designer area and drag the mouse to move the designer area. Delete the selected node or dependency of the diagram. Creating a One-to-One Dependency Configure the dependency condition between the parent and the child job. See Configuring the Dependency Condition. Click the link between jobs to enable the icon. You can also double-click the link to open the Pipeline flow config editor dialog. A one-to-one dependency is formed between a parent and a child job. When a build of the parent job is successful, a build of the child job runs automatically. To create a one-to-one dependency of a child job to its parent job: 1. From the Jobs list, drag-and-drop the parent job to the designer area. 2. From the Jobs list, drag-and-drop the dependent (or child) job to the designer area. 3. To indicate the parent job, the job that will trigger the pipeline build, mouse over the handle of the Start node. The cursor icon changes to the + cursor icon. Example: In the above example, the Start node indicates the staring point of the pipeline. The Start node is available in all pipelines and cannot be removed. Job 1 is the parent job and Job 2 is the dependent job. 4. Drag the cursor from the handle to the handle of the job. An arrow line will appear. Example: 5. Similarly, mouse-over the handle of the parent job, click, and drag-and-drop the arrow head over the of the child job

223 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service A dependency is now formed. In the above example, Job 2 is now dependent on Job 1. A build of Job 2 will run automatically after every Job 1 build is successful. To delete a job node or a dependency, click to select it, and then click. Creating a One-to-Many Dependency A one-to-many dependency is formed between one parent job and multiple child jobs. When a build of the parent job is successful, builds of child jobs run automatically. To create a one-to-many dependency between jobs: 1. From the Jobs list, drag-and-drop the parent job to the designer area. 2. From the Jobs list, drag-and-drop all dependent (or child) jobs to the designer area. Example: Here, Job 1 is the parent job and Job 2, Job 3, and Job 4 are the dependent jobs. 3. To indicate the parent job, the job that will trigger the pipeline build, mouse over the handle of the Start node. The cursor icon changes to the + cursor icon. 4. Drag the cursor from the handle to the handle of the job. An arrow line will appear. Example: 5. Similarly, mouse-over the handle of the parent job, click, and drag-and-drop the arrow head over the of the child jobs

224 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service A dependency is now formed. In the above example, Job 2, Job 3, and Job 4 are now dependent on Job 1. A build of Job 2, Job 3, and Job 4 will run automatically after every Job 1 build is successful. To delete a job node or a dependency, click to select it, and then click. Creating a Many-to-One Dependency A many-to-one dependency is formed between multiple parent jobs and one child job. When a builds of all parent jobs are successful, a build of the child job runs automatically. To create a many-to-one dependency of parent jobs with a child job: 1. From the Jobs list, drag-and-drop all parent jobs to the designer area. 2. From the Jobs list, drag-and-drop the dependent (or child) jobs to the designer area. Example: Here, Job 2, Job 3, and Job 4 are the parent jobs and Job 5 is the dependent job. 3. To indicate the parent job, the job that will trigger the pipeline build, mouse over the handle of the Start node. The cursor icon changes to the + cursor icon. 4. Drag the cursor from the handle to the handle of the parent job. Repeat the steps for all parent nodes. 5. Drag the cursor from the handle of the parent job. An arrow line will appear. Repeat the steps for all parent nodes. 6. Similarly, mouse over the handle of the parent jobs and drag-and-drop the arrow head over the handle of the dependent job

225 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Example: A dependency is now formed. In the above example, Job 5 is dependent on Job 2, Job 3, and Job 4. A build of Job 5 will run automatically after Job 2, Job 3, and Job 4 are successful. To delete a job node or a dependency, click to select it, and then click. Configuring the Dependency Condition Running a Pipeline Deleting a Pipeline When you create a dependency between a parent and a child job, by default, a build of the child job runs after the parent job s build is successful. You can configure the dependency to run a build of the child job after the parent job s build fails. To configure the dependency condition between two jobs: 1. In the pipeline designer, click to select the dependency condition arrow. 2. In the pipeline designer toolbar, click. 3. In the Pipeline config flow editor, in Result Condition, select Failed or Successful. You can also double-click the dependency arrow to open the Pipeline config flow editor. 4. Click Apply. You can a pipeline from the Build page. To run a job pipeline: 1. In the navigation bar, click Build. 2. Click the Pipelines tab. 3. For the pipeline you want to run, click. The jobs defined in the pipeline start running. You can delete a job pipeline from the Builds page. To edit a job pipeline: 2-186

226 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service 1. In the navigation bar, click Build. 2. Click the Pipelines tab. 3. For the pipeline you want to delete, click. Deleting a pipeline does not delete related jobs, but the dependency or the order of job builds is removed. Using the Oracle Maven Repository You can configure the POM file of your application to access the Oracle Maven Repository and configure the job to download artifacts and dependencies while running a build. For more information about Oracle Maven repository and how to use it, see Here are some tips for accessing the Oracle Maven repository from Oracle Developer Cloud Service build executor: Before configuring the POM file to access the Oracle Maven Repository, open in your web browser, sign-in with your Oracle Account credentials, and accept the license agreement. To run local Maven builds on your computer, configure the Maven settings.xml file and the settings-security.xml file. Configure the Oracle Maven Repository definition and add your Oracle Account user name and the password in the settings.xml file. Example: <servers> <server> <id>maven.oracle.com</id> <username>alex.admin</username> <password>password</password> <configuration>... </configuration> </server> </servers> For more information, see the Configuring the Oracle Maven Repository chapter in Oracle Fusion Middleware Developing Applications Using Continuous Integration. If you want to use encrypted password, create a master password in the settings-security.xml file before you encrypt your Oracle Account password. Note that Oracle Developer Cloud Service does not store credentials in the executor Maven settings file. For more information about the settings.xml file and password encryption, see and mini/guide-encryption.html. To ensure that you are using the correct Oracle Developer Cloud Service proxy settings for your Maven build job, set the HTTP_PROXY_HOST (or HTTPS_PROXY_HOST) and HTTP_PROXY_PORT (or HTTPS_PROXY_PORT) proxy related environment variables in settings.xml. Example: 2-187

227 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service <proxies> <proxy> <port>${env.http_proxy_port}</port> <host>${env.http_proxy_host}</host> <nonproxyhosts> localhost localhost.localdomain [::1] *.test_server.com </nonproxyhosts> </proxy> </proxies> To configure a build job in Oracle Developer Cloud Service to access the Oracle Maven repository, see Configuring the Build Environment to use the Oracle Maven Repository. You don t need to upload the local Maven files to the Git repository to run builds. When a build runs, Oracle Developer Cloud Service creates an internal environment to access the Oracle Maven repository. It updates the internal settings.xml (not accessible to you) to add your Oracle Account credentials, encrypts your password, run the Maven commands defined in the Builders tab of the Job Configuration page, and then reverts the updates made to the Maven files after the build is complete. Using the Oracle Developer Cloud Service Build Executor Environment Variables When you run a build job, you can use the environment variables in your shell scripts and commands to access the software on the Oracle Developer Cloud Service build executor. Common Variables The following table describes some common environment variables. Environment Variable BUILD_ID BUILD_NUMBER BUILD_URL BUILD_DIR JOB_NAME EXECUTOR_NUMBER HTTP_PROXY HTTP_PROXY_HOST HTTP_PROXY_PORT HTTPS_PROXY HTTPS_PROXY_HOST HTTPS_PROXY_PORT JOB_NAME JOB_URL The current build s ID. The current build number. The full URL of the current build. The build output directory. The name of the job. The unique number that identifies the current executor (among executors of the same machine) that's running the current build. The HTTP proxy for outgoing connections. The HTTP proxy host for outgoing connections. The HTTP proxy port for outgoing connections. The HTTPS proxy for outgoing connections. The HTTPS proxy host for outgoing connections. The HTTPS proxy port for outgoing connections. The name of the current job. The full URL of the current job

228 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Environment Variable NO_PROXY NO_PROXY_ALT Specify the comma separated list of domain names or the IP addresses for which the proxy should not be used. You can also specify port numbers. Specify the pipe ( ) separated list of domain names or the IP addresses for which the proxy should not be used. You can also specify port numbers. Software Variables Environment Variable DYNAMO_HOME DYNAMO_ROOT GRADLE_HOME JAVA_HOME JAVACLOUD_HOME The path of the Oracle ATG home directory. The path of the Oracle ATG root directory. The path of the Gradle directory. The path of the directory where the Java Development Kit (JDK) or the Java Runtime Environment (JRE) is installed. If your job is configured to use a specific JDK, the build executor sets the variable to the path of the specified JDK. When the variable is set, PATH is also updated to have $JAVA_HOME/bin. The path of the Oracle Java Cloud Service - SaaS Extension Software Development Kit directory. The following JDeveloper and SOA related variables are also available: JAVACLOUD_HOME_11_1_1_7_1=/opt/Oracle/ Middleware_ /jdeveloper/cloud/oracle-javacloudsdk/lib JAVACLOUD_HOME_11G=/opt/Oracle/Middleware_ / jdeveloper/cloud/oracle-javacloud-sdk/lib JAVACLOUD_HOME_12C3=/opt/Oracle/MiddlewareSOA_12.1.3/ jdeveloper/cloud/oracle-javacloud-sdk/lib JAVACLOUD_HOME_SOA=/opt/Oracle/MiddlewareSOA_12.1.3/ jdeveloper/cloud/oracle-javacloud-sdk/lib JAVACLOUD_HOME_SOA_12_1_3=/opt/Oracle/ MiddlewareSOA_12.1.3/jdeveloper/cloud/oracle-javacloudsdk/lib JAVACLOUD_HOME_SOA_12_2_1=/opt/Oracle/ MiddlewareSOA_ /jdeveloper/cloud/oracle-javacloudsdk/lib 2-189

229 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Environment Variable ORACLE_HOME MIDDLEWARE_HOME WLS_HOME The path of the directory where JDeveloper is installed on the build executor. The following variables are available: ORACLE_HOME=/opt/Oracle/Middleware_ /jdeveloper ORACLE_HOME_11G=/opt/Oracle/Middleware_ / jdeveloper ORACLE_HOME_11_1_1_7_1=/opt/Oracle/Middleware_ / jdeveloper Use the following variables for JDeveloper with SOA : ORACLE_HOME_12C3=/opt/Oracle/MiddlewareSOA_12.1.3/ jdeveloper ORACLE_HOME_SOA=/opt/Oracle/MiddlewareSOA_12.1.3/ jdeveloper ORACLE_HOME_SOA_12_1_3=/opt/Oracle/MiddlewareSOA_12.1.3/ jdeveloper ORACLE_HOME_SOA_12_2_1=/opt/Oracle/MiddlewareSOA_12.2.1/ jdeveloper The path of the directory where Oracle Fusion Middleware is installed on the build executor. The MIDDLEWARE_HOME directory includes the JDeveloper installation directory, WebLogic Server installation directory, and the Oracle Common library dependencies. The following variables are available: MIDDLEWARE_HOME=/opt/Oracle/Middleware_ MIDDLEWARE_HOME_11G=/opt/Oracle/Middleware_ MIDDLEWARE_HOME_11_1_1_7_1=/opt/Oracle/ Middleware_ Use the following variables for SOA : MIDDLEWARE_HOME_12C3=/opt/Oracle/MiddlewareSOA_ MIDDLEWARE_HOME_SOA=/opt/Oracle/MiddlewareSOA_ MIDDLEWARE_HOME_SOA_12_1_3=/opt/Oracle/ MiddlewareSOA_ MIDDLEWARE_HOME_SOA_12_2_1=/opt/Oracle/ MiddlewareSOA_ The path of the WebLogic server binary directory bundled with the JDeveloper install on the build executor. The following variables are available: WLS_HOME=/opt/Oracle/Middleware_ /wlserver_10.3 WLS_HOME_11G=/opt/Oracle/Middleware_ / wlserver_10.3 WLS_HOME_11_1_1_7_1=/opt/Oracle/Middleware_ / wlserver_10.3 Use the following variables for SOA : WLS_HOME_12C3=/opt/Oracle/MiddlewareSOA_12.1.3/wlserver WLS_HOME_SOA=/opt/Oracle/MiddlewareSOA_12.1.3/wlserver WLS_HOME_SOA_12_1_3=/opt/Oracle/MiddlewareSOA_12.1.3/ wlserver WLS_HOME_SOA_12_2_1=/opt/Oracle/MiddlewareSOA_12.2.1/ wlserver 2-190

230 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Environment Variable NODE_HOME NODE_PATH The path of the Node.js home directory. The path of the Node.js modules directory. Tip: You can run the env command as a Shell build step to view all environment variables set on the Oracle Developer Cloud Service build executor. See Adding an Unix Shell Builder. Some Linux programs, such as curl, only support lower-case environment variables. Change the build steps in your job configuration to use lower-case environment variables. Example: export http_proxy="$http_proxy" export https_proxy="$https_proxy" export no_proxy="$no_proxy" curl -v About the Software Installed on the Build Executor Various software, such as Docker, JDeveloper, Xvfb, and Node.js, are installed on the Oracle Developer Cloud Service Build Executor and are available to the Executor threads when running on Oracle Cloud. Executables from the software bundles are available on the builder's PATH variable, which is set to/usr/bin, and can be invoked directly from the Unix Shell builder. You should use the PATH variable and other environment variables to access the installed software. The following table lists software installed on the Oracle Developer Cloud Service Build Executor in addition to the software installed on the operating system. Software Version Ant Docker Findbugs Firefox Git Gradle 4.x 3.x 2.x 2-191

231 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Software Java 9.x Version 1.8.x 1.7.x 1.6.x Kubectl Maven Node.js 0.12.x 4.x 6.x 8.x Node.js grunt Node.js gulp Node.js grunt-cli Node.js gulp-cli Node.js bower Node.js oracledb 1.7 Node.js Driver for Oracle Database OCIcli Oracle ATG Oracle Developer Studio 12c Oracle Forms Developer Oracle Instant Client 12c Oracle JDeveloper Studio Oracle JDeveloper Studio Oracle SOA Suite PSMcli Python Python3 pip Ruby SQLcl 17.x SFTP 1.9.3p488 4.x yum:latest Terraform Xvfb To know about the environment variables that you can use to access the software, see Using the Oracle Developer Cloud Service Build Executor Environment Variables

232 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Note: Various plugins such as Gradle, Node, Xvfb, and Maven 3 ported from Eclipse/Community Hudson are also available in the build executor. Running a Build You can run a job s build from the job s details page and Jobs Overview page. To run a build of a job: 1. In the navigation bar, click Build. 2. Click the Jobs tab, if necessary. 3. In the Jobs table, click the job name link. 4. In the job s details page, click Build Now. You can also run a job s build from the Jobs Overview page. In the jobs table, click the icon to run the build of the corresponding job. Configuring a Job to Run a Build Automatically on Git Repository Updates You can configure a job to monitor the project Git repository and trigger a build automatically after an update is pushed to the Git repository. To configure a job to run build automatically after a Git repository is updated: 1. Open the Source Control tab of Configure Build Job page. See Configuring the Source Code Management System for Builds. 2. For the Git repository whose updates you want to track, select the Automatically perform build on SCM commit check box. 3. Click Save. The builds do not run automatically for external Git repositories. To run automatic builds of external Git repositories, enable time-based trigger. See Configuring Periodic Build Triggers. Configuring a Job to Run a Maven Build Apache Maven is pre-installed on the Oracle Developer Cloud Service build executor. You can use Maven 2.0 or 3.0 to run builds of your application. To run Maven builds: 1. Configure your application to use the Maven POM file. If you are new to Maven, see 2. Commit and push the application files to the project Git repository. 3. Create a job and configure it 2-193

233 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service See Creating a Job and Configuring a Job. 4. Configure the job to use Maven as a build step. See Adding a Maven Builder. 5. Save the job and run a build. See Running a Build. While you are configuring a job to use Maven, you might also want to take a look at the following topics: Using the Oracle Developer Cloud Service Build Executor Environment Variables About the Software Installed on the Build Executor Using the WebLogic Maven Plugin Using the Oracle Maven Repository Building Oracle ADF Applications with Oracle Developer Cloud Service Configuring the POM File to Upload or Download Dependencies from the Project Maven Repository Configuring a Job to Run an Ant Build Apache Ant is pre-installed on the Oracle Developer Cloud Service build executor. To run Ant builds: 1. Configure your application to use the Ant build files. If you are new to Ant, see 2. Commit and push the application files to the project Git repository. 3. Create a job and configure it For more information, see Creating a Job and Configuring a Job. 4. Configure the job to use Ant as a build step. For more information, see Adding an Ant Builder. 5. Save the job and run a build. For more information, see Running a Build. While you are configuring a job to use Ant, you might also want to take a look at the following topics: Using the Oracle Developer Cloud Service Build Executor Environment Variables About the Software Installed on the Build Executor Building Oracle ADF Applications with Oracle Developer Cloud Service 2-194

234 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Configuring the POM File to Upload or Download Dependencies from the Project Maven Repository You can configure the pom.xml file to upload or download dependencies from the project Maven repository while running a build. To configure the pom.xml file: 1. In the navigation bar, click Maven. 2. In the Browse view of the Maven page, click the Maven tab in Distribution Management. 3. Click the to copy the <distributionmanagement> code snippet to the clipboard. 4. Open the pom.xml file of your project in a code editor (or a text editor) and paste the contents of the clipboard under the <project> element. 5. Save the file, commit it to the Git repository, and then push the commit. Note: The credentials in settings.xml are not required to access the project Maven repository when running a build. The Build job has full access to the project Maven repository for uploads and downloads. Discarding Old Builds and Artifacts You can configure a job to discard its old builds and artifacts. The old builds are discarded after the job configuration is saved and after a job is built. To discard old builds and artifacts: 1. Open the Configure Build Job page of the job. See Configuring a Job. 2. Click. 3. Click the General tab, if necessary. 4. Select the Discard Old Builds check box. The following table highlights what you can configure after selecting the Discard Old Builds check box. Number of builds to keep at all times Discard other builds after how many days Specify the number of builds to retain. By default, 100 is selected. If the build is broken, the last working build is kept. Specify the number of days to retain builds. Enter a number greater than 0. All builds older than this number of days will be discarded. If left blank, any builds not discarded by setting Number of builds to keep at all times are kept

235 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Minimum number of builds to retain artifacts for Discard other artifacts after how many days 5. Click Save. Downloading Build Artifacts Specify the number of builds with artifacts to retain. By default, 20 is selected. If left blank, all artifacts for existing builds are retained. Specify the number of days to retain the artifacts created by the build. Enter a number greater than 0. All artifacts older than this number of days will be discarded. If left blank, any artifacts for existing builds other than those discarded by setting Minimum number of builds to retain artifacts for are retained. You can download the job s last successful build s artifacts from the job s details page and from the build s details page. The build artifacts are displayed in a directory tree structure. You can click the link to download parts of the tree including individual files, directories, and subdirectories. To download artifacts of the job s last successful build: 1. In the navigation bar, click Build. 2. Click the Jobs tab, if necessary. 3. In the Jobs table, click the job name link. 4. Click Latest Artifacts. 5. In the Artifacts Archived page, click the artifact link (file or directory) to download it. Click All files in a zip to download a zip file of all artifacts. To download artifacts of a particular build, open the build s details page, click Artifacts, and download the artifacts from the Artifacts Archived page. See About the Build Details Page. About the Artifacts Page The Artifacts page displays the archived build artifacts in a directory tree structure. What You See on the Artifacts Page The following table describes the key information and elements shown on the Artifacts page. Archived artifact All files in zip Click the artifact file name link to download it to your computer. Size of the artifact file is also displayed next to the file name. Click to download a zip file of all artifacts along with their directory structure. Subscribing to a Job s Build Notifications You can subscribe to notifications when a build of a job is successful or fails

236 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Before you subscribe to build notifications, enable the build activity notifications in your account preferences. See Setting Notifications. To subscribe to a job s build notifications: 1. In the navigation bar, click Build. 2. Click the Jobs tab, if necessary. 3. In the Jobs table, click the job name link. 4. If necessary, click the On toggle button to enable build notifications of the job for all subscribed users. The notifications are enabled by default. 5. Click the CC Me icon to subscribe yourself to the job s build notifications. 6. In the CC Me dialog, select the Successful Builds check box to receive when the build is successful. Select Failed Builds to receive when the build fails. 7. Click OK. When you are subscribed to a job s build notifications, the CC Me icon changes to CCed Me. To unsubscribe to notifications, click CCed Me, and deselect the required check box. Note: Do not click the Off toggle button to unsubscribe to your notifications. The Off toggle button disables notifications for all users. Viewing a Build s Details From the build s details page, you can view its status, duration, and download the artifacts. To view build details: 1. In the navigation bar, click Build. 2. Click the Jobs tab, if necessary. 3. Click the build number link in the Build History table. You can also click the build number link in the job page. About the Build Details Page From the build s details page, you can view its status, duration, and download the artifacts. What You See on the Build Details Page The following table describes the key information and elements shown on the Build Details page

237 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service < Jobs Overview Job Name < #Build Number > Configure Delete Result Reason Build Time Duration Keep forever Click < Jobs Overview to return to the Jobs Overview page. Click the job name link to return to the job details page. Click the < or the > icons before or next to the build number to navigate to the previous build or the next build. Configure build s details such name and description. See Configuring a Build s Details. Deletes the build. Displays the build description. Displays the status of the build. If the build has failed, the reason of failure is displayed. Displays the date-time stamp when the build was started. Displays how long the build ran. Displays the build s keep forever status as true or false. Click to view SCM changes that happened before the build ran. Click to view the download links of artifacts. Links are available when a build is successful. View Javadoc of the build. View the console output of the build. View the Git SCM polling log of the build. See About the SCM Poll Logs Page. View the log of build s JUnit test results. Configuring a Build s Details You can update and configure a build s details such as name and description. You can also mark a build to be kept forever and not removed by the job s configuration of removing old builds. To update and configure a build s details: 1. Open the build s details page. See About the Build Details Page. 2. Click Configure. The following table highlights what you can do from the Build Configuration page. Build Enter or update the build s description. The description is helpful if you mark a particular build to keep it forever and not get discarded automatically. When you add a description to a build, an * is added to the build number in the Build History table

238 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Build Name Keep Build Forver Enter a name for the build to identify it easily. For example, you can provide a name to a stable build that you want to use or refer to later. Select the check box to mark a build and keep it forever. When marked, the build is not discarded if you have selected the Select the Discard Old Builds check box in the General Settings page and configured the job to remove old builds automatically. The Delete button is also disabled. The build is deleted when the parent job is deleted. Deselect the check box if you do not want to keep this build forever. 3. Click Save. Viewing a Build s Log After a build has run, you can view its log in the build console. To view a build s console: 1. Open the build s details page. See About the Build Details Page. 2. Click. You can also click the icon in the Build History label. In the Console Output page, review the build log. If the log is displayed partially, click the Full Log link to view the entire log. To download the log as a text file, click the Download Console Output link. Tip: In the Jobs table of the Jobs Overview page, click the icon to view the log of the last build of a job. In the Job Details page of a job, click the icon to view the build log of the last build. About the Build Log Page The Build Log page displays the selected build s log and provides a link to download the log file. What You See on the Build Log Page The following table describes the key information and elements shown on the Build Log page. Download Log Click to download the build s output as a file to your computer

239 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Show All Log Build log If the build log is partially displayed, click the link to display the complete log. Displays the selected build s log. Viewing SCM Changes When a build is triggered, the build system checks the job s Git repositories for any changes to the SCM. If there are any updates, the SCM Change log displays the files that were added, edited or removed. To view SCM changes of a build: 1. Open the build s details page. See About the Build Details Page. 2. Click. The SCM Change log shows all files that have changed in the build. About the SCM Changes Page The SCM Change page log displays the files that were added, edited, or removed from the job s Git repositories before the build was triggered. What You See on the SCM Changes Page The following table describes the key information and elements shown on the SCM Changes page. Summary Commit Id Affected Files Displays the commit message along with the information about the commit author and the date-time stamp of the commit. Displays the commit ID. Click the link to open the Compare page to compare the files affected in the commit with other revisions. Displays a list of files affected in the commit followed by a summary of files changed, inserted, or deleted. If you have opened the Recent SCM Changes page, the above information is displayed for recent builds. Viewing a Build s Test Results You can view the JUnit test results of a build from the build s details page. To view a build s test results: 1. Open the build s details page. See About the Build Details Page. 2. Click 2-200

240 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service About the Test Results Page The Test Results page displays details about all tests and all failed tests of the build. What You See on the Test Results Page The following table describes the key information and elements shown on the Test Results page. Metrics All Failed Tests All Tests Test JUnit Results History Shows test metric including total tests, passed tests, failed tests, skipped tests, error tests, and total duration of tests. Click to view details of the failed tests. The information of all tests is shown in a table format with following columns: Image: Click to download the test image. The image file name is same as the test name followed by failed. For example, if the test name is TestBuildPage.checkBuildCopyJob, the image file name would be TestBuildPage.checkBuildCopyJob-failed.png. The supported image formats are.png,.jpg,.gif,.tif,.tiff,.bmp,.ai,.psd,.svg,.img,.jp eg,.ico,.eps, and.ps. Location: Displays the test directory name. Test Name: Displays the test name. Click the name link to open the test details page. Duration: Displays the test duration. Age: Displays how old the test is. Click to view details of all test suites. The information of all tests is shown in a table format with following columns: Video: Click to download the test video file. The video file name is same as the test suite name. For example, if the test suite name is TestBuildPage, the video file name would be TestBuildPage.webm. The supported formats are.mp4,.mov,.avi,.webm,.flv,.mpg,.gif,.wmv,.rm,.asf,.s wf,.avchd, and.m4v. Location: Displays the test directory name. Suite Name: Displays the test suite name. Click the name link to open the test suite details page. Duration: Displays the test suite duration. Passed: Displays the number of tests of the suite that passed. Failed: Displays the number of tests of the suite that failed. Skipped: Displays the number of tests of the suite that were skipped. Error: Displays the number of tests of the suite that had an error. Total: Displays the number of tests of the suite. Opens the JUnit Results History page that displays the history of all tests and its unit test result trend in a graphical representation

241 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Viewing the Test Details Page The Test Details page shows the test result, parent suite name, status, and duration. To open the test details page: 1. Open the Test Results page. See Viewing a Build s Test Results. 2. Click the All Failed Tests toggle button and the click the test name link in the Test Name column. About the Test Details Page You can also click the All Tests toggle button, open the test suite details page, and then click the test name link in the Test Name column. The Test Details page shows details about a test of a test suite. What You See on the Test Details Page The following table describes the key information and elements shown on the Test Details page. Suite Name Test Name Status Duration Failed Image Error Message Stack Trace Shows the name of the parent test suite. Displays the name of the test. Displays the test status as Passed, Failed, or Skipped. Displays the total duration of the test. If the test failed, click the image to download it. The image file name is same as the test name followed by failed. If the test failed, expand the field to see the error message. If the test failed, expand to see the stack trace report. Viewing Test Suite Details You can open the Test Suite Details page from the Test Details page. To open the Test Suite Details page: 1. Open the Test Results page. See Viewing a Build s Test Results. 2. Click the All Tests toggle button. 3. Click the suite name link in the Suite Name column

242 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service About the Test Suite Details Page The Test Suite Details page shows all tests of the suite along with their status and duration. What You See on the Test Suite Details Page The following table describes the key information and elements shown on the Test Suite Details. Suite Name Test Name Duration Status Shows the name of the test suite. Displays the name of the test. Click the link to open the details page of the test. Displays the total duration of the test. Displays the test status as Passed or Failed. Viewing Test Results History The Test Results History page shows a graphical representation of all tests of the job. To view the Test Results History page: 1. Open the Test Results page. See Viewing a Build s Test Results. 2. Click JUnit Results History. About the Test Results History Page The Test Results History page displays a graphical representation of all tests of the job and a table summarizing the tests. What You See on the Test Results History Page The following table describes the key information and elements shown on the Test Results History page. Graph Build Duration Passed Failed Skipped Error Shows a graphical representation of the passed, skipped, and failed tests. Mouse over the graph bar to view more details. Displays the job name and the build number of the test. Click the link to open the Test Results page of the build. Displays the total duration of the all tests of the build. Displays the total passed tests of the build. Displays the total failed tests of the build. Displays the total skipped tests of the build. Displays the total error tests of the build

243 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Total Displays the total tests of the build. Viewing a Build s SCM Polling Log If you have configured the build to run on a Git SCM polling schedule, you can view the Git SCM polling log in the Build details page. To configure Git SCM polling for a build, see Configuring Build Triggers. To view the Git SCM polling log of a build: 1. In the navigation bar, click Build. 2. Click the Jobs tab, if necessary. 3. In the Jobs Overview page, click the job name. 4. In the Build History table, click the build number link. 5. Click the icon. The Git build logs page shows the polling log. Tip: In the Job Details page of a job, click the polling log of the last build. icon to view the Git SCM About the SCM Poll Logs Page The SCM Poll Logs page displays the log of builds triggered by SCM polling. The log includes scheduled builds and builds triggered by SCM updates. What You See on the SCM Poll Logs Page The following table describes the key information and elements shown on the SCM Poll Logs page. Last build triggered by polling Displays the build number of the build that was triggered by SCM polling

244 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Poll Logs For each build triggered by SCM polling, the following information is displayed: Previous Head Revision: Commit ID of the previous commit head Current Head Revision: Commit ID of the current commit head Polled URL: URL of the Git repository Polled Branch: Name of the poll Git repository branch Polled Time: Date-time stamp when the Git repository was polled Poll Log: Git repository URL and branch name that was polled Poll Result: If SCM changes were detected when the build was triggered, New SCM changes found is displayed along with the build number and the commit ID. If no SCM changes were detected when the build was triggered, No new SCM changes found. No build triggered. message is displayed. Viewing a Job s User Action History You can use the Audit log to track the user actions on a build. Use the log to see who performed particular actions on the job. For example, you can see who cancelled a build of the job, or who disabled the job and when was it disabled. To view the Audit log of a job: 1. In the navigation bar, click Build. 2. Click the Jobs tab, if necessary. 3. In the Jobs Overview page, click the job name. About the Audit Page 4. In the Job Details page, click the icon. The Audit log page tracks and displays the username and date-time stamp of the actions performed on a job. What You See on the Audit Page The following table describes the key information and elements shown on the Audit page

245 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service Audit log The following information is displayed for the actions performed on the selected job. Who created the job Who started a build or how a build was triggered (followed by the build number), when the build succeeded or failed, and the duration of the build A build can also be triggered by a timer, a commit to a Git repository, or an upstream job. Who aborted a build Who changed the configuration of the job Who disabled a job Who enabled a job Viewing a Job s SonarQube Analysis Summary You can view s job s SonarQube analysis report from the Job Details page. To view the SonarQube analysis summary: 1. In the navigation bar, click Build. 2. Click the Jobs tab, if necessary. 3. In the Jobs Overview page, click the job name. 4. In the Job Details page, click. About the SonarQube Analysis Summary Page The SonarQube analysis summary page displays the code quality report of the build. What You See on the SonarQube Analysis Summary page The following table describes the key information and elements shown on the SonarQube Analysis Summary page. SonarQube Server Summary Displays the SonarQube server URL of the job. Displays the SonarQube analysis summary. Quality Gate: Status of the SonarQube Quality Gate Bugs: Number of issues found in the code Vulnerabilities: Number of security related issues found in the code Code Smells: Number of maintainability-related issues found in the code Viewing a Project s Recent Build History You can use the Recent Build History page to view the builds of all jobs of the project. To view recent build history: 2-206

246 Managing Project Jobs, Builds, and Pipelines in Oracle Developer Cloud Service 1. In the navigation bar, click Build. 2. In the Build Queue box, click the View Recent Build History link. About the Recent Build History Page The Recent Build History page to view the builds of all jobs of the project. What You See on the Recent Build History Page The following table describes the key information and elements shown on the Recent Build History Page. Column Status Build Job Time Duration Build Log Indicates the build s status. Indicates the build number. Click the build number link to open the build details page. See About the Build Details Page. Indicates the job name. Click the job name link to open the job details page. See About the Job Details Page. Indicates the date-time stamp when the build ran. Indicates the build s duration. Click to open the build s console and view the console log output. Tip: To sort the table data by a column, right-click inside the build history table column and select the sort order from the Sort context menu. Monitoring Jobs and Builds from IDEs You can monitor jobs and builds from IDEs such as OEPE, NetBeans IDE, and JDeveloper. See following topics for more information: Monitoring Project Builds in the Eclipse IDE Monitoring Project Builds in NetBeans IDE Monitoring Project Builds in JDeveloper Using the WebLogic Maven Plugin The WebLogic server includes a Maven plugin that you can use to perform various deployment operations against the server, such as deploy, redeploy, and update. The plugin is available in the Oracle Developer Cloud Service build executor. To install and invoke the WebLogic Maven plugin from a project build job: 2-207

247 Deploying an Application in Oracle Developer Cloud Service 1. Install the WebLogic Maven plugin (weblogic-maven-plugin.jar) into the Maven repository. As the Maven repository is always empty when a jobs starts, configure the job to install the plugin. a. Open the Configure Build Job page of the job. See Configuring a Job. b. Add a Unix Shell Builder. See Adding an Unix Shell Builder. c. Enter the following command in Script: mvn install:install-file -Dfile=$WLS_HOME/server/lib/weblogic-mavenplugin.jar -DpomFile=$WLS_HOME/server/lib/pom.xml d. Click Save. 2. Invoke the WebLogic Maven plugin from your application s pom.xml file. For example, add the following command in the pom.xml file to invoke the deploy operation: mvn com.oracle.weblogic:weblogic-maven-plugin:deploy For more information about how to use the WebLogic Maven plugin, see Fusion Middleware Deploying Applications to Oracle WebLogic Server in Oracle Fusion Middleware Online Documentation Library. Deploying an Application in Oracle Developer Cloud Service You can deploy your project s application to the Oracle Java Cloud Service - SaaS Extension instance of your current identity domain, an Oracle Java Cloud Service - SaaS Extension instance of another data center or identity domain, to a publicly available Oracle Java Cloud Service instance VM, or to an Oracle Application Container Cloud Service instance. The Oracle Java Cloud Service - SaaS Extension instance of your current identity domain is available by default. To deploy to an Oracle Java Cloud Service - SaaS Extension instance of another data center or identity domain, or to a publicly available Oracle Java Cloud Service instance VM, you would need to add it as a deployment target to the deployment configuration. To learn the difference between Oracle Java Cloud Service - SaaS Extension and Oracle Java Cloud Service, see Frequently Asked Questions for Oracle Java Cloud Service - SaaS Extension in Using Oracle Java Cloud Service - SaaS Extension and the Oracle Cloud FAQ at Topics About the Deploy Page Creating a Deployment Configuration About the Deployment Configuration Page Editing a Deployment Configuration Deploying an Application to Oracle Java Cloud Service - SaaS Extension 2-208

248 Deploying an Application in Oracle Developer Cloud Service Deploying an Application to Oracle Java Cloud Service - SaaS Extension of Another Data Center or Identity Domain Deploying an Application to Oracle Java Cloud Service Deploying an Application to Oracle Application Container Cloud Service Viewing Deployment Logs About the Deploy Page Accessing the Deployed Application The Deploy page displays all deployment configurations of the project in the masterdetail format. The master pane on the left lists deployment configurations, and the details and history of each configuration appear on the right. Also see Deploying an Application in Oracle Developer Cloud Service About Deployment Configurations A Deployment Configuration in Oracle Developer Cloud Service defines to which build artifacts to deploy to a target Oracle Cloud service. You can deploy and manage your deployments to Oracle Java Cloud Service - SaaS Extension instance of your current identity domain, an Oracle Java Cloud Service - SaaS Extension instance of another data center or identity domain, to a publicly available Oracle Java Cloud Service instance VM, or to an Oracle Application Container Cloud Service instance. What You See on the Deploy Page The following table describes the key information and elements shown on the Deploy page. + New Configuration Create a deployment configuration. See About the Deployment Configuration Page

249 Deploying an Application in Oracle Developer Cloud Service Deployments Displays all deployment configurations and their status. For each deployment configuration, the following information is displayed. Deployment status icon Application name The application name appears as the title. If the application name is a link, click it to navigate to the deployed application in your browser. For more information about accessing the deployed application, see Accessing the Deployed Application. Deploy to JCS-SaaS / Deploy to JCS / Deploy to ACCS Name or the host details of the target server where the application is deployed. Click the name link to open the service console. Configuration Displays the name of the configuration, Click the configuration name link to edit the deployment configuration. Job/Build Displays the job name as link and the deploy type as On Demand or Latest Successful Build. Artifact Displays the build artifact name. Last deployment status icon, status, and date-time stamp : Click to open a menu with the following options: Start / Stop: Start or stop the application Redeploy: Redeploy the application Undeploy: Undeploy the application Edit Configuration: Edit the deployment configuration Delete Configuration: Delete the deployment configuration When a configuration is selected, its deployment history is displayed on the right with the following information: Last deployment date, time stamp, and deployer Deployment status Deployed artifact name and path Links to all logs produced by the deployment action What You Can Do from the Deploy Page See Actions You Can Perform on the Deploy page. For frequently asked questions, see Questions about the Deploy Page and Project Deployment. Creating a Deployment Configuration You must create a deployment configuration to deploy your application artifacts to Oracle Java Cloud Service - SaaS Extension, Oracle Java Cloud Service, or Oracle Application Container Cloud Service. You must be assigned the Admin Role (Java_Administrators) of the target service to create and manage deployment configurations. To create a deployment configuration: 2-210

250 Deploying an Application in Oracle Developer Cloud Service 1. In the navigation bar, click Deploy. 2. Click New Configuration. 3. Complete the fields of the New Deployment Configuration page. 4. If you chose On Demand as the Type, click Save and Deploy. If you chose Automatic as the Type, click Save. After the deployment configuration has been created, other members of the project can redeploy or undeploy the application, or they can start or stop the application on the target Java Service. To start or stop the application on the target Java Service, click the icon and select Start or Stop. To redeploy the selected configuration, select Redeploy. To undeploy the deployment configuration, select Undeploy, and to delete the deployment configuration, select Delete Configuration. You can create multiple deployment configurations for your project. Generally, but not necessarily, each deployment configuration should deploy a different project artifact. About the Deployment Configuration Page You must create a deployment configuration to deploy your application artifacts to Oracle Java Cloud Service - SaaS Extension, Oracle Java Cloud Service, or Oracle Application Container Cloud Service. You would need Oracle Cloud credentials of the user with the Java Administrators (Java_Administrators) identity domain role of the target service to create and manage deployment configurations. What You See on the Deployment Configuration Page The following table describes the key information and elements shown on the Deployment Configuration page. Configuration Name Application Name Enter a unique name for the deployment configuration. Enter the name of the application that you want to deploy. By default, it is the same as Configuration Name. If a context root is not specified within the selected build artifact, the application name may be used as the deployed application's context root. If you are editing a deployment configuration, the field is read-only and displays the application name

251 Deploying an Application in Oracle Developer Cloud Service Deployment Target Type Deploy Stable Builds only Job Build Artifact Deploy as shared library Include ACCS Manifest Select the target Java Service where you want the application to deploy to. To deploy to the Oracle Java Cloud Service - SaaS Extension of your current identity domain, open the drop-down list and select the service name under Java Cloud Service - SaaS Extension. For more information, see Deploying an Application to Oracle Java Cloud Service - SaaS Extension. To deploy the application to the Oracle Java Cloud Service - SaaS Extension of another identity domain, add the Oracle Java Cloud Service - SaaS Extension deployment target. See Deploying an Application to Oracle Java Cloud Service - SaaS Extension of Another Data Center or Identity Domain. To deploy to a Oracle Java Cloud Service instance, open the drop-down list and select the service name under Java Cloud Service. To add an Oracle Java Cloud Service deployment target, see Deploying an Application to Oracle Java Cloud Service. To deploy to the Oracle Application Container Cloud Service instance of the current identity domain, open the drop-down list and select the service name under Application Container Cloud. To add an Oracle Application Container Cloud Service deployment target, see Deploying an Application to Oracle Application Container Cloud Service. If you are editing a deployment configuration, the field is read-only and displays the deployment target. Select the deployment type as On Demand or Automatic. If you select On Demand, a deployment is triggered when you save the deployment configuration, or select the Redeploy menu option. If you select Automatic, a deployment is triggered when a build is successful. If you selected Automatic as the Type, select the check box to deploy stable builds only. If the check box is not selected, unstable builds will also be deployed. From the list, select the job that you want to deploy. If you chose On Demand as the Type, select the build that you want to deploy. The last successful build is selected by default. From the list, select the build artifact that you want to deploy. The artifact of the chosen build is selected by default. Select the check box to deploy the Artifact as a shared library. The check box is available only if you are deploying the artifact to an Oracle Java Cloud Service VM. If not selected, the artifact is deployed as an application. If you want to deploy to Oracle Application Container Cloud Service, select and enter the contents of the manifest file in ACCS Manifest. The commands override the commands of the manifest file in the artifact zip. You can also insert contents of a snippet file. The field is a code editor component and you can use all code editor features

252 Deploying an Application in Oracle Developer Cloud Service Include ACCS Deployment If you want to deploy to Oracle Application Container Cloud Service, select and enter the contents of the deployment descriptor in ACCS Deployment. You can also insert contents of a snippet file. The field is a code editor component and you can use all code editor features. Editing a Deployment Configuration After creating a deployment configuration, you can edit the deployment configuration properties. To edit a deployment configuration: 1. In the navigation bar, click Deploy. 2. Mouse over the icon of the deployment configuration you want to edit and select Edit Configuration. 3. In the Edit Deployment page, edit the deployment configuration's properties. Application Name Deployment Target Type Deploy Stable Builds only Job Build Artifact Deploy as shared library Displays the name of the application Displays the target Java Service where the application is deployed. Select the deployment type as On Demand or Automatic. If you select On Demand, a deployment is triggered when you save the deployment configuration, or select the Redeploy menu option. If you select Automatic, a deployment is triggered when a build is successful. If you selected Automatic as the Type, select the check box to deploy stable builds only. If the check box is not selected, unstable builds will also be deployed. From the list, select the job that you want to deploy. If you chose On Demand as the Type, select the build that you want to deploy. From the list, select the build artifact that you want to deploy. Select the check box to deploy the Artifact as a shared library. The check box is available only if you are deploying the artifact to an Oracle Java Cloud Service VM. 4. If you chose On Demand as the Type, click Save and Deploy. If you chose Automatic as the Type, click Save

253 Deploying an Application in Oracle Developer Cloud Service Deploying an Application to Oracle Java Cloud Service - SaaS Extension When you create a deployment configuration, the Oracle Java Cloud Service - SaaS Extension service of the current identity domain is available by default. To prepare your application to deploy to Oracle Java Cloud Service - SaaS Extension, see Preparing Applications for Oracle Java Cloud Service - SaaS Extension Deployment in Using Oracle Java Cloud Service - SaaS Extension. To deploy an application artifact to Oracle Java Cloud Service - SaaS Extension: 1. In the navigation bar, click Deploy. 2. Click New Configuration. 3. Enter the Configuration Name and the Application Name. See About the Deployment Configuration Page. 4. In Deployment Target, open the menu and select the service instance name under Java Cloud Service - SaaS Extension. 5. Specify the build, job, artifact name, and other details as described in About the Deployment Configuration Page. 6. If you chose On Demand as the Type, click Save and Deploy. If you chose Automatic as the Type, click Save. See the deployment logs for the status of the deployment. Deploying an Application to Oracle Java Cloud Service - SaaS Extension of Another Data Center or Identity Domain When you create a deployment configuration in Oracle Developer Cloud Service, you can deploy your application to the subscribed Oracle Java Cloud Service - SaaS Extension of your current identity domain. To deploy the application to Oracle Java Cloud Service - SaaS Extension of another data center or identity domain, you should add the external Oracle Java Cloud Service - SaaS Extension as a deployment target. For more information about deploying applications to Oracle Java Cloud Service - SaaS Extension, see Preparing Applications for Oracle Java Cloud Service - SaaS Extension Deployment in Using Oracle Java Cloud Service - SaaS Extension. To add Oracle Java Cloud Service - SaaS Extension as a deployment target: 1. In the navigation bar, click Deploy. 2. Click New Configuration. 3. Enter the Configuration Name and the Application Name. For more information, see About the Deployment Configuration Page. 4. In Deployment Target, open the drop-down list and select the service name under Java Cloud Service - SaaS Extension.The service name is available in the <data_center>/<identity_domain>/<username>/<service_instance_name> format. To create a new remote deployment target, click New and select Java Cloud Service - SaaS Extension

254 Deploying an Application in Oracle Developer Cloud Service In the Connection Details page of the Deploy to Remote Java Cloud Service - SaaS Extension wizard, complete the elements described in the following table: Data Center Select the data center of the target Oracle Java Cloud Service - SaaS Extension instance. Identity Domain Enter the identity domain of the target Oracle Java Cloud Service - SaaS Extension instance. Username Password Click Find Targets. Enter the user name of the target identity domain user who is assigned the Java Administrators (Java_Administrators) role. Enter the password of the target identity domain user. 5. In the Available Targets page of the wizard, click the Oracle Java Cloud Service - SaaS Extension service instance name to use it as the deployment target. The selected target service name is added to the Deployment Target list in <data_center>/<identity_domain>/<username>/<service_instance_name> format. Example: us1/myiddomain/alex.admin/jcs Specify the build, job, artifact name, and other details as described in About the Deployment Configuration Page. 7. If you chose On Demand as the Type, click Save and Deploy and the application will be deployed immediately. If you chose Automatic as the Type, click Save and the application will be deployed on the next successful build. Deploying an Application to Oracle Java Cloud Service You can deploy your application to a publicly available Oracle Java Cloud Service instance and make it publicly accessible. Tutorial You can deploy your application from Oracle Developer Cloud Service to Oracle Java Cloud Service using the Oracle WebLogic RESTFul Management Interface or the SSH Tunnel. You can use either the RESTful interface or the SHH Tunnel to deploy to the Oracle WebLogic Server 12c of Oracle Java Cloud Service, but you can only use the SSH Tunnel to deploy to Oracle WebLogic Server 11g (10.3.x) of Oracle Java Cloud Service. To use the SSH Tunnel, you must first authenticate Oracle Developer Cloud Service connection with the Oracle Java Cloud Service instance Virtual Machine (VM) and upload the Oracle Developer Cloud Service SSH public key to the Oracle Java Cloud Service instance VM. After the SSH public key is uploaded, you can deploy to Oracle Java Cloud Service. To use the Oracle WebLogic RESTful interface, no authentication or additional configuration is required. Simply create a deployment configuration and deploy the application. Topics Deploying to Oracle Java Cloud Service Using the Oracle WebLogic RESTFul Management Interface 2-215

255 Deploying an Application in Oracle Developer Cloud Service Deploying to Oracle Java Cloud Service Using the SSH Tunnel Note: Before creating a deployment configuration, enable the HTTPS or the SSH access rule in the Oracle Java Cloud Service console. See Enabling Console Access in an Oracle Java Cloud Service in Administering Oracle Java Cloud Service. If you want to deploy to Oracle Java SE Cloud Service, you must first create a cluster and add the single managed server to the cluster. For more information about creating a cluster, see the Create a cluster topic in Oracle Fusion Middleware Oracle WebLogic Server Administration Console Online Help. Deploying to Oracle Java Cloud Service Using the Oracle WebLogic RESTFul Management Interface Deploying to Oracle Java Cloud Service using the OracleWebLogic RESTFul Management Interface is easy and does not require any additional configuration. To deploy to Oracle Java Cloud Service using the Oracle WebLogic RESTFul Management Interface: 1. In the navigation bar, click Deploy. 2. Click New Configuration. 3. Enter the Configuration Name and the Application Name. See About the Deployment Configuration Page. 4. In Java Service, click New, and select Java Cloud Service. 5. In the Connection Details page of the Deploy to Java Cloud Service wizard, complete the elements described in the following table: Version Protocol Host Select the version of the Oracle Java Cloud Service WebLogic instance. You can select Oracle Weblogic Server 12c (12.2.x or higher) or Oracle Weblogic Server 12c (12.1.x). You cannot deploy to Oracle Weblogic Server 11g (10.3.x) using the Oracle WebLogic RESTFul Management Interface. Select the Oracle WebLogic RESTFul Management Interface option. Enter the Oracle Java Cloud Service instance VM s Public IP address. You can get the Public IP address from the Overview page of the Oracle Java Cloud Service instance. See Exploring the Oracle Java Cloud Service Instance Overview Page in Administering Oracle Java Cloud Service

256 Deploying an Application in Oracle Developer Cloud Service HTTPS Port Username Password Enter the HTTPS port number of the WebLogic Server that runs on the Oracle Java Cloud Service instance. By default, it is For more information about ports, see Understanding the Default Access Ports in Administering Oracle Java Cloud Service. Enter the user name of the Oracle Java Cloud Service WebLogic Administration console. Enter the password of the Oracle Java Cloud Service WebLogic Administration console. 6. Click Find Targets. 7. In the Available Targets page of the wizard, select the Oracle Java Cloud Service servers or clusters you want to deploy the application to. You can select more than one option. To know more about servers and clusters, see the Targeting Deployments to Servers, Clusters, and Virtual Hosts topic in Fusion Middleware Deploying Applications to Oracle WebLogic Server. 8. Click OK. 9. In the New Deployment Configuration page, specify the build, job, artifact name, and other details as described in About the Deployment Configuration Page. 10. If you chose On Demand as the Type, click Save and Deploy and the application will be deployed immediately. If you chose Automatic as the Type, click Save and the application will be deployed on the next successful build. Deploying to Oracle Java Cloud Service Using the SSH Tunnel If you are using the SSH Tunnel to connect and deploy to the Oracle Java Cloud Service instance VM, you would need access to the Oracle Java Cloud Service Console and set up an authenticated connection between Oracle Developer Cloud Service and Oracle Java Cloud Service VM. To set up the connection, you would need to get the Oracle Developer Cloud Service generated SSH public key and append it to the authorized_keys file of the Oracle Java Cloud Service VM. To upload the Oracle Developer Cloud Service public key to the Oracle Java Cloud Service instance VM: 1. Get the Oracle Developer Cloud Service SSH public key through the REST API. Use the following URL syntax to get the key: If the base URL of your Oracle Developer Cloud Service environment is developer.us2.oraclecloud.com/my-org/, then your host name is developer.us2.oraclecloud.com and the organization name is my-org. Do not enter the URL in the web browser address bar. Instead, use curl or a browser REST plugin to get the SSH key. curl example: curl -u alex.admin:mypassword

257 Deploying an Application in Oracle Developer Cloud Service Use the same user name and the password that you use to access Oracle Developer Cloud Service. For more information about curl, see When you have the key, copy the key string value and save it in a.pub file (for example, odcskey.pub). 2. In the Oracle Java Cloud Service web user interface, open the Overview page of the service instance. To know more about the Overview page, see Exploring the Oracle Java Cloud Service Instance Overview Page in Administering Oracle Java Cloud Service. 3. In the header of the Overview page, click the icon next to the Oracle Java Cloud Service link and select SSH Access. 4. In the Add New Key dialog, with Upload a new SSH Public Key value from file selected, click Browse, and select the Oracle Developer Cloud Service SSH public key file that you saved in Step 1. You can also copy the key value to the Key Value text box. For more information about managing SSH access, see Managing SSH Access for an Oracle Java Cloud Service Instance in Administering Oracle Java Cloud Service. 5. Click Add New Key. 6. In the Add New Key dialog, click Submit. The Oracle Developer Cloud Service SSH public key is added to the authorized_keys file of the Oracle Java Cloud Service VM. After adding the public key, the VM will restart automatically. This will take some time. The icon in the header section will also change. You can track the restart activity in the Activity Summary section of the Overview page. When the instance has restarted and the activity is complete, you will see the Add SSH Key is Completed in Activity Summary 7. Open the Oracle Developer Cloud Service web interface. 8. In the navigation bar, click Deploy. 9. Click New Configuration. 10. Enter the Configuration Name and the Application Name. See About the Deployment Configuration Page. 11. In Java Service, click New, and select Java Cloud Service. 12. In the Connection Details page of the Deploy to Java Cloud Service wizard, complete the elements described in the following table: Version Protocol Select the version of the Oracle Java Cloud Service WebLogic instance. You can select Oracle Weblogic Server 12c (12.2.x or higher), Oracle Weblogic Server 12c (12.1.x), or Oracle Weblogic Server 11g (10.3.x). Select the SSH Tunnel

258 Deploying an Application in Oracle Developer Cloud Service Host HTTPS Port Adminstration Port Username Password Enter the Oracle Java Cloud Service instance VM s Public IP address. You can get the Public IP address from the Overview page of the Oracle Java Cloud Service instance. See Exploring the Oracle Java Cloud Service Instance Overview Page in Administering Oracle Java Cloud Service. Enter the HTTPS port number of the WebLogic Server that runs on the Oracle Java Cloud Service instance. By default, it is For more information about ports, see Understanding the Default Access Ports in Administering Oracle Java Cloud Service. Enter the admin port number of the WebLogic Admin Server that runs on the Oracle Java Cloud Service instance. Enter the user name of the Oracle Java Cloud Service WebLogic Administration console. Enter the password of the Oracle Java Cloud Service WebLogic Administration console. 13. Click Find Targets. 14. In the Available Targets page of the wizard, select the Oracle Java Cloud Service servers or clusters you want to deploy the application to. You can select more than one option. To know more about servers and clusters, see the Targeting Deployments to Servers, Clusters, and Virtual Hosts topic in Fusion Middleware Deploying Applications to Oracle WebLogic Server. 15. Click OK. 16. In the New Deployment Configuration page, specify the build, job, artifact name, and other details as described in About the Deployment Configuration Page. 17. If you chose On Demand as the Type, click Save and Deploy and the application will be deployed immediately. If you chose Automatic as the Type, click Save and the application will be deployed on the next successful build. Deploying an Application to Oracle Application Container Cloud Service Oracle Developer Cloud Service provides tools to build and deploy your Java SE, PHP, and Node.js applications to Oracle Application Container Cloud Service (or ACCS, in short). Create an archive of the application that includes the application, any dependent libraries, and the manifest.json file. See Packaging Your Application in Developing for Oracle Application Container Cloud Service. You can deploy the application, undeploy it, and start and stop the application on the target Oracle Application Container Cloud Service. Other operations, such as scaling up and down of applications, can be managed from the Oracle Application Container Cloud Service Console. See About Your Application and Oracle Application Container Cloud Service in Developing for Oracle Application Container Cloud Service. You can deploy the application to the Oracle Application Container Cloud Service instance associated with the current Oracle Developer Cloud Service data center 2-219

259 Deploying an Application in Oracle Developer Cloud Service identity domain or the Oracle Application Container Cloud Service instance associated with another identity domain in another data center. To deploy an application to Oracle Application Container Cloud Service: 1. In the navigation bar, click Deploy. 2. Click New Configuration. 3. Enter the Configuration Name and the Application Name. See About the Deployment Configuration Page. 4. To deploy the application to the Oracle Application Container Cloud Service instance of the current data center identity domain, open the Deployment Target drop-down list and select the identity domain name under Application Container Cloud. To deploy the application to an Oracle Application Container Cloud Service instance of another identity domain in another data center, create a deployment target. Click New and select Application Container Cloud from the drop-down menu. In the Deploy to Application Container Cloud dialog, complete the elements described in the following table: Data Center Identity Domain Username Password Select the data center of the target Oracle Application Container Cloud Service instance. Enter the identity domain or the IDCS Identity domain of the target Oracle Application Container Cloud Service instance. Enter the user name of the target Oracle Application Container Cloud Service identity domain user who is assigned the administration role. Enter the password of the target identity domain user. 5. Click Test Connection. 6. After the connection is successful, click Use Connection to use the Oracle Application Container Cloud Service instance as the deployment target. 7. In the ACCS Properties box, select the desired Runtime option. Runtime Java Java EE Node PHP Select to deploy Java applications. Select to deploy Java EE (version 7 or later) applications. Select to deploy Node.js applications. Select to deploy PHP applications. In the ACCS Properties box, select the desired Subscription option of the service. Runtime Option Hourly Monthly Select for hourly subscription. Select for monthly subscriptions. 8. In Type, select the deployment type

260 Deploying an Application in Oracle Developer Cloud Service Deploy Type On Demand Automatically Deploy when the deploy option is chosen manually or thorough the build system. Deploy when the build is successful. 9. Specify the build, job, artifact name, and other details as described in About the Deployment Configuration Page. 10. If necessary, select the following check boxes: ACCS Deploy Configuration Check Box Include ACCS Manifest Include ACCS Deployment Select and enter the contents of the manifest file in ACCS Manifest. The commands override the commands of the manifest file in the artifact zip. You can also insert contents of a snippet file. The field is a code editor component and you can use all code editor features. Select and enter the contents of the deployment descriptor in ACCS Deployment. You can also insert contents of a snippet file. The field is a code editor component and you can use all code editor features. For more information about the ACCS metadata files, see Creating Metadata Files in Developing for Oracle Application Container Cloud Service. 11. If you chose On Demand as the Type, click Save and Deploy and the application will be deployed immediately. If you chose Automatic as the Type, click Save and the application will be deployed on the next successful build. Tip: In the ACCS Manifest field, you can override the deployed application's version number at the time of deployment. In the ACCS Deploymeny field, you can override the deployed application's container's configuration (such as RAM) at the time of deployment. Viewing Deployment Logs For each deployment to an Oracle Java Cloud Service - SaaS Extension instance, Oracle Java Cloud Service instance VM, or Oracle Application Container Cloud Service instance, you can view and download the logs produced by the deployment action. To view deployment logs: 1. In the navigation bar, click Deploy. 2. Click the deployment configuration box on the left. 3. In the Details pane on the right, click the log name link

261 Deploying an Application in Oracle Developer Cloud Service 4. In the Log Viewer dialog, click the Download this log file link to download the log as a text file. 5. Click the icon in the top-right corner of the Log Viewer dialog to close the dialog. You can also view the Oracle Java Cloud Service - SaaS Extension deployment logs from the Oracle Java Cloud Service - SaaS Extension Control. Accessing the Deployed Application After successfully deploying the application, you can access its URL from the Application name link, and the Oracle Java Cloud Service - SaaS Extension Control, the Oracle Java Cloud Service WebLogic Console, or the Oracle Application Container Cloud console. To access the Oracle Java Cloud Service - SaaS Extension or the Oracle Application Container Cloud deployed application from Oracle Developer Cloud Service: 1. In the navigation bar, click Deploy. 2. In the deployment configuration that was used to deploy the application, click the application name link. If required, enter the identity domain name and your credentials. To access the deployed application from Oracle Java Cloud Service - SaaS Extension Control: 1. In the navigation bar, click Deploy. 2. In the deployment configuration that was used to deploy the application, click the Java Service name link. 3. In the Oracle Java Cloud Service - SaaS Extension Control, click the application name link under Applications. 4. Click the application URL under Application URLs to access the deployed application. To learn more about the Oracle Java Cloud Service - Saas Extension Control, see Accessing Oracle Java Cloud Service - SaaS Extension in Using Oracle Java Cloud Service - SaaS Extension. To create the access URL of an application deployed to Oracle Java Cloud Service: 1. Using the Oracle Java Cloud Service View a Service Instance API, get the Content URL of the Oracle Java Cloud Service. Use the response body output to find the content_url. Example: curl -i -X GET -u jdoe@example.com:mypassword -H "X-ID-TENANT- NAME:exampleidentitydomain" instances/exampleidentitydomain/exampleservice For more information about the REST API, see REST API for Oracle Java Cloud Service in Using Oracle Java Cloud Service. The REST API must be called with basic authentication. You can choose to use curl or a browser REST add-on such as Postman for Google Chrome

262 Browsing External Docker Registries in Oracle Developer Cloud Service 2. Get the context root of the application from the application.xml deployment descriptor for EAR deployments and from the web.xml deployment descriptor for WAR deployments. If there is no such descriptor, get the context root from the WebLogic Console. a. Open the WebLogic Console of the Oracle Java Cloud Service server. You can access the console from the Java Service link of the Oracle Java Cloud Service deployment configuration. b. Click Deployments in the Domain Structure pane. c. Click the deployed application name in the Deployments table. d. In the Overview tab, copy the value displayed by Context Root. Note: As the <host>:<port> referenced in the WebLogic Console is local to the Oracle Java Cloud Service instance, you need the externally available IP address or the host name of the Oracle Java Cloud Service instance VM to access the deployed application. 3. Join the content URL and the context root of the application to construct the application URL. For example, if the content URL is and the context root is / deploy , the application s URL would be /deploy For more information, see Accessing an Application Deployed to an Oracle Java Cloud Service Instance in Using Oracle Java Cloud Service. Browsing External Docker Registries in Oracle Developer Cloud Service You can view and browse the linked external Docker registries, their repositories, and the images of the repositories in the Docker Registry page. Topics: About the Docker Registry Page Browsing a Docker Registry Repository About the Docker Registry Repository Page Deleting a Docker Registry Repository Image Tag Downloading the Image Manifest of a Docker Registry Repository Copying Pull and Push Commands for a Docker Registry Repository 2-223

263 Browsing External Docker Registries in Oracle Developer Cloud Service About the Docker Registry Page Using the Docker Registry page, you can browse the linked external Docker registries. About Docker Registry A Docker Registry is a server side application that stores and enables you to distribute Docker images. For more information, see In Oracle Developer Cloud Service, you can link external Docker registries to the project and browse their repositories and images. Contact the project Owner to link an external Docker registry to the project. What You See on the Docker Registry Page From the Docker Registry page, you can choose the linked Docker registry whose contents you want to browse. The following table lists the elements of the Docker Registry page. Registry list Repositories Page Size Page Lists all external Docker registries linked to the project. To link a Docker registry, you must be assigned the project Owner role. See Adding a Link to an External Docker Registry. Lists all repositories of the selected Docker registry. Click the link to view its contents. Specify how many repositories of the selected registry you want to be displayed on the page. The default number is 25. Enter the page number that you want to go to. The repositories list is updated automatically. You can also use the navigation controls or click the page number link to go to a page. What You Can Do from the Docker Registry Page See Actions You Can Perform on the Docker Registry page to know more about you can do on the Docker Registry page. For frequently asked questions, see Questions About the Docker Registry Page and Docker Images. Browsing a Docker Registry Repository You can view all images of a Docker registry repository from the Docker Registry page. To open a registry repository: 1. In the navigation bar, click Docker Registry. 2. From the Registry list, select the Docker registry. The repositories of the selected registry are listed in the Repositories tab. 3. In the Repositories tab, click the desired repository link. All images of the selected repository are listed in the Image Tags tab

264 Browsing External Docker Registries in Oracle Developer Cloud Service About the Docker Registry Repository Page The Docker Registry page displays the contents of the selected Docker registry.. What You See on the Docker Registry Repository Page The following table describes the key information and elements shown on the Docker Registry Repository page. Registry list Repository path Image Tags list Tag Details Page Size Page Lists all external Docker registries linked to the project. Click to go back to the Docker Registry page. Displays the path of the Docker registry repository. Lists all image tags of the repository. Click an image tag name to view its details in the Tag Details section on the right side of the page. To delete an image from the repository, click or mouse over the image name and click Delete. In the Confirm Delete dialog, select the I understand that my selected tag will be permanently deleted check box, and click Yes. Displays details of the selected image tag. The Info section displays the tag name, image manifest, and the repository name. icon to download the The Docker Command section displays the Pull and Push commands in the respective tabs. Click the clipboard. icon to copy the commands to the Specify how many images of the selected repository you want to be displayed on the page. The default number is 10. Enter the page number that you want to go to. The images list is updated automatically. You can also use the navigation controls or click the page number link to go to a page. Deleting a Docker Registry Repository Image Tag You can delete an image tag of a Docker registry repository from the Docker Registry Repository page. To delete an image tag of a Docker registry repository: 1. Open the Docker registry repository. See Browsing a Docker Registry Repository. 2. In the Image Tags list, mouse over the tag you want to delete, and click Delete. 3. In the Confirm Delete dialog, select the I understand that my selected tag will be permanently deleted check box, and click Yes. The image tag is permanently deleted from the Docker registry repository

265 Using Wiki Pages in Oracle Developer Cloud Service Downloading the Image Manifest of a Docker Registry Repository You can download an image manifest of a Docker registry repository from the Docker Registry Repository page. To download an image manifest of a Docker registry repository: 1. Open the Docker registry repository. See Browsing a Docker Registry Repository. 2. In Image Tags, click to select the image tag. 3. On the right side, in the Info section of Tag Details, click. 4. In the Browser Save dialog that opens, browse and save the manifest file. Copying Pull and Push Commands for a Docker Registry Repository You can copy the Docker push and pull image commands of an image from the Docker Registry Repository page. To copy the Push and Pull commands of a Docker registry image: 1. Open the Docker registry repository. See Browsing a Docker Registry Repository. 2. In Image Tags, click to select the image tag. 3. On the right side, in the Docker Command section of Tag Details, Push and Pull commands are displayed.. In the Pull tab, click Push tab, click to copy the docker pull commands to the clipboard. In the to copy the docker push commands to the clipboard. Using Wiki Pages in Oracle Developer Cloud Service Using wikis, you can collaborate on documentation for your projects. Open the Wiki page to create, view, and edit wiki pages. Topics About the Wiki Page Creating a Wiki Page Viewing a Wiki Page Editing a Wiki Page Creating a Child Wiki Page Managing Attachments of a Wiki Page Managing Edit and Delete Access Rights of a Wiki Page Viewing the History of a Wiki Page Deleting a Wiki Page 2-226

266 Using Wiki Pages in Oracle Developer Cloud Service About the Wiki Page Oracle Developer Cloud Service provides a Wiki instance for document authoring and collaboration. You can create wiki pages and share information with your team. About Wiki Oracle Developer Cloud Service supports the following Wiki markup languages: Confluence See Textile See Markdown See The markup language of a project is defined when the project is created. A project Owner can change the wiki markup language any time. What You See on the Wiki Page No Wiki Pages If there are no wiki pages in the project, click + New Page to create a wiki page. Wiki Pages If there are wiki pages in the project, the following table describes the key information and elements shown on the Wiki page. + New Page Create wiki pages. See Creating a Wiki Page. Wiki List Creating a Wiki Page Click the wiki name link to open it. See Viewing a Wiki Page. Click What You Can Do from the Wiki Page to view child pages of the wiki. See Actions You Can Perform on the Wiki page. For frequently asked questions, see Questions about the Wiki Page and Wiki Pages. When you create a wiki page, you can specify who can edit or delete the wiki page. Project Owners can always edit or delete a wiki page. To create a wiki page: 1. In the navigation bar, click Wiki. 2. Click New Page. 3. Enter the title of the wiki page in Page Title

267 Using Wiki Pages in Oracle Developer Cloud Service The first character of the title must be a letter, a number, or a special character except /. Special characters +, -, ;, /, and \ are not allowed. Spaces and other special characters are allowed. 4. In the Page Text tab, enter wiki content. If you are using the Markdown wiki markup language, you can also add emoticons in the content. See for the complete list of supported emoticons and text patterns. Click the wiki Reference link to open the cheat sheet of the project s chosen markup language. 5. To preview the wiki page, click the Preview tab. 6. Click Save. Viewing a Wiki Page You can view the contents of a wiki page in the Wiki page. To open or view a Wiki page: 1. In the navigation bar, click Wiki. 2. Click the wiki name link to open it. If a wiki page has child wiki pages, click the select the child wiki page name to open it. icon next to the wiki page title and About the View Wiki Page The View Wiki page displays the contents of the open wiki page. What You See on the View Wiki Page The following table describes the key information and elements shown on the View Wiki page. Wiki Wiki Title Refresh wiki title Path of the wiki page. Click Wiki to return to the Wiki home page. Title of the Wiki page. Information about the creator of the wiki page, last edit s date-time stamp and author is displayed below the wiki title. Refresh the wiki page contents, attachments, and comments. The button is useful if you are editing a wiki page and want to check if the page was edited by another user before you save it. + New Page Create a wiki page. See Creating a Wiki Page. + New Child Create a child wiki page. See Creating a Child Wiki Page. Delete Edit Page Delete the wiki page. See Deleting a Wiki Page. Edit the wiki page. See Editing a Wiki Page. Displays the contents of the wiki page

268 Using Wiki Pages in Oracle Developer Cloud Service Attachments Page History Comments Displays the attachments of the wiki page. See Managing Attachments of a Wiki Page. Displays the update history of the wiki page. See Viewing the History of a Wiki Page. Add or view the comments of the wiki page. See Adding Comments to a Wiki Page. Editing a Wiki Page When you edit a wiki page, you can also add child wiki pages, edit access rights, or attach files to the wiki page. To edit a wiki page: 1. In the navigation bar, click Wiki. 2. Click the wiki page title link. 3. Click Edit. To add a child wiki page, click New Child. For more information, see Creating a Child Wiki Page. 4. In the Page Text tab, enter or update the content. Click the Reference link in the upper-right corner above the text area to open the cheat sheet of the chosen markup language. If you are using the Markdown wiki markup language, you can also add emoticons in the content. See for the complete list of supported emoticons and text patterns. 5. To attach a file to the wiki page, click the Attachments tab. See Managing Attachments of a Wiki Page. 6. To modify the edit or delete access of the wiki page, click the Access Rights tab. See Managing Edit and Delete Access Rights of a Wiki Page. 7. To preview the wiki page, click the Preview tab. 8. Click Save. About the Edit Wiki Page The Edit Wiki page displays when you create a wiki page or edit a wiki page. What You See on the Edit Wiki Page The following table describes the key information and elements shown on the Edit Wiki page. Wiki wiki title Path of the wiki page. Click Wiki to return to the Wiki home page

269 Using Wiki Pages in Oracle Developer Cloud Service Page Title Save Cancel Page Text Preview Attachments Access Rights Wiki Reference Enter or edit the title of the Wiki page. The first character of the title must be a letter, a number, or a special character except /. Special characters +, -,, /, and \ are not allowed. Spaces and other special characters are allowed. Save the wiki page. Discard the wiki page updates. Enter the contents of the wiki page in the editor area. Preview the wiki contents and its formatting before saving. Attach files to the wiki page. See Managing Attachments of a Wiki Page. Configure access rights of the wiki page. See Managing Edit and Delete Access Rights of a Wiki Page. Click the link to open the cheat sheet of the project s markup language. Adding Comments to a Wiki Page You can add comments to a wiki in the Wiki page. You must be a project member to add comments. For a shared project, any user can add comments. To add comments to a wiki : 1. In the navigation bar, click Wiki. 2. Click the wiki name link to open it. To open a child wiki page, expand the parent page to access the child wiki page. 3. In the Write tab of the Comments section, enter your comment. You can use the project s wiki markup language to format your comment. Click the Preview tab to preview the format and then click Comment. Click Clear to remove the comment, if required. The comment is added in a conversation box. The conversation box displays the name of the comment s user and the date-time stamp when the comment was entered. It displays icons to reply, edit, and delete your comment. To reply to a comment, click, enter your comment, and click Reply. To hide a comment and its replies, click the icon. To view comments, click. To edit your comment, click. Update your comment in the Write tab, and click Update. The comment header shows Edited along with the date-time stamp of the last edit. You cannot edit comments entered by other users. To delete your comment, click. You cannot delete a parent comment if there are any child comments, or delete comments entered by other users. For all actions related to comments, an activity with a link to the comment is added to the Recent Activities feed of the Project page

270 Using Wiki Pages in Oracle Developer Cloud Service Formatting Comments using the Wiki Markup Language You can use the project's current Wiki markup language to format the comment. In the Write tab of the Comment box, click the Reference link above the text area to open the cheat sheet of the chosen markup language in another browser window or tab. For an existing comment, the Reference link opens the cheat sheet of the Wiki markup language that was used to format the comment when it was entered. If the project is using the Markdown wiki markup language: Use # followed by the issue ID to add a reference to the issue. Example: #12 creates a link the issue ID 12. Use! followed by the merge request ID to add a reference to the merge request. Example:!34 creates a link to the merge request ID 34. See for the complete list of supported emoticons and text patterns. Creating a Child Wiki Page You can create child wiki pages to a parent wiki page from the Wiki page. To create a child wiki page: 1. In the navigation bar, click Wiki. 2. Click the parent wiki page title link. 3. Click New Child. 4. In the Page Title path, rename childpagename to the new title of the child wiki page. The first character of the title must be a letter, a number, or a special character except /. Special characters +, -,, /, and \ are not allowed. Spaces and other special characters are allowed 5. In the Page Text tab, enter the wiki content. Click the wiki Reference link to open the cheat sheet of the project s chosen markup language. 6. To attach a file to the wiki page, click the Attachments tab. For more information, see Managing Attachments of a Wiki Page. 7. To modify the edit or delete access of the wiki page, click the Access Rights tab. For more information, see Managing Edit and Delete Access Rights of a Wiki Page. 8. To preview the wiki page, click the Preview tab. 9. Click Save. You can also create a child wiki page without opening or creating its parent wiki. Create a wiki page and in the Page Title, enter the path of the child wiki page. For example, to create a HelloWorld child wiki page of the Welcome parent wiki, enter Welcome/HelloWorld as the title. If the Welcome wiki page exists, HelloWorld wiki page is created as its child. If the Welcome wiki page does not exist, an empty wiki page is 2-231

271 Using Wiki Pages in Oracle Developer Cloud Service created. When you open the empty Welcome wiki page, click the Create button to create the wiki page. Managing Attachments of a Wiki Page You can add and remove attachments to a wiki page from the Edit mode of the wiki page. Topics Adding an Attachment to a Wiki Page Removing an Attachment from a Wiki Page Adding an Attachment to a Wiki Page You can attach files of any type to a wiki page. The attachments may include images, videos, docs, spreadsheets, or archived files. To add an attachment to a wiki page: 1. Open the wiki page where you want to attach the file. See Viewing a Wiki Page. 2. Click Edit. 3. Click the Attachments tab. 4. In the Files to Attach or Update section, click Select. Browse and select files that you want to attach. You may also drag and drop files to the drop area. 5. Click Attach. The attached file is displayed in the Attached Files section. While uploading, if there are any errors, they are displayed the same section. Click Clear and select Errors to clear the error messages. Click Clear and select Done to clear all successful attachment messages. Click Clear and select All to clear all messages. Note: If you select All before clicking Attach, the attached files are removed. 6. Click Save to save the wiki page. An activity with a link to attachment is added to the Recent Activities feed of the Project page. Removing an Attachment from a Wiki Page You can remove an attachment from a wiki page. To remove an attachment from a wiki page: 2-232

272 Using Wiki Pages in Oracle Developer Cloud Service 1. Open the wiki page from where you want to remove the attachment. See Viewing a Wiki Page. 2. Click Edit. 3. Click the Attachments tab. 4. In the Attached Files section, click the icon next to the attachment name. 5. Select the I understand that the attachment will be permanently deleted check box and click Delete. 6. Click Save to save the wiki page. An activity with a link to the Attachments tab is added to the Recent Activities feed of the Project page. Managing Edit and Delete Access Rights of a Wiki Page For each wiki page, you can assign the Edit and Delete access rights to project users based on their roles, or all users of the current organization if the project is a shared project. You cannot restrict or assign the edit and delete access to a particular user. Project Owners can always edit or delete a wiki page. You can also assign the edit and delete access to users with Member role. If a project is shared, you can assign the edit and delete privileges to all users of the organization. You must be a project Owner or the creator of the wiki page to specify the edit and the delete access. To restrict Edit and Delete access rights of a wiki page: 1. In the navigation bar, click Wiki. 2. Click the wiki page name link whose access rights you want to restrict. 3. Click Edit. 4. Click the Access Rights tab. 5. From the Edit Access list, select the project role whom you want to assign the edit access right of the wiki page. By default, it is set to Members and Owners. Select All to assign the edit access to all users of the organization. This option is useful if you have a shared project and want all users to edit wiki pages of the project. Select Members and Owners to assign the edit access to all users of the current project. If the project is shared, external users can view the wiki pages, but will not be able to edit the wiki page unless they join the project. Select Owners to assign the edit access to project Owners only. Members of the project can view the pages, but cannot edit (or delete) the wiki page. If the project is shared, external users can view the wiki pages, but will not be able to edit the wiki page unless they join the project and are assigned the Owner role. The Edit access enables the user to edit the wiki content, create its child pages, or restore to a version. 6. From the Delete Access list, select the project role whom you want to assign the delete access right of the wiki page. By default, it is set to Members and Owners

273 Using Wiki Pages in Oracle Developer Cloud Service Select All to assign the delete access to all users of the organization. This option is useful if you have a shared project and want all users to delete wiki pages of the project. Select Members and Owners to assign the delete access to all users of the current project. If the project is shared, external users can view the wiki pages, but will not be able to delete the wiki page unless they join the project. Select Owners to assign the delete access to project Owners only. Members of the project can view the pages, but cannot delete the wiki page. If the project is shared, external users can view the wiki pages, but will not be able to delete the wiki page unless they join the project and are assigned the Owner role. The Delete access enables the user to delete a wiki page, or delete a version from the Page History tab. 7. Click Save. Note: As the wiki page s creator, you can change its edit and delete access rights. If you are not a project Owner, you may lose the edit (or delete) access right of the wiki page if you, another project Member, or a project Owner changes the edit (or delete) access right to Owners only. Viewing the History of a Wiki Page You can view a wiki page s history in the Page History tab. Each time you save a wiki page, Oracle Developer Cloud Service creates a version of it. From the Page History tab, you can view the contents of the wiki page of a previous version, compare any two versions, restore the wiki page to a particular version, or delete a particular version. The Page History tab shows the following information for each page update: Version: Version number of each update Changed By: Project member name who made the update Date: Date-time stamp of the update Operations: Actions you can perform for the version. You can perform actions: View: View the contents of the selected version Restore this version: Remove the contents of the current version and restore the wiki page to the selected version. The button is not visible if you do not have the edit access of the wiki page. Delete: Delete the version. The button is not visible if you do not have the delete access of the wiki page. Compare selected versions: Select the check boxes of any two versions and click the button to compare the content of both versions

274 Using Wiki Pages in Oracle Developer Cloud Service Comparing Two Versions of a Wiki Page You can compare two versions of a wiki page from the Page History tab. To compare two versions: 1. In the navigation bar, click Wiki. 2. Click the wiki page name to open it. 3. Click the Page History tab. 4. Select the check boxes of the two versions that you want to compare. 5. Click Compare selected versions. The wiki compare page opens that highlights the differences between the two versions. Restoring an Old Version of a Wiki Page Use the Page History tab to restore a wiki page to a particular version. You need the Edit access right of the wiki page to restore it to another version. For more information about the Edit access rights, see Managing Edit and Delete Access Rights of a Wiki Page. To restore a wiki page: 1. In the navigation bar, click Wiki. 2. Click the wiki page name to open it. 3. Click the Page History tab. 4. For the version that you want to restore, click the Restore this version button. 5. In the Revert Wiki Page dialog, select the I understand that my wiki page will be updated to this revisions' content check box and click Yes. The wiki page along with comments is restored to the selected version. Deleting a Version of the Wiki Page Use the Page History tab to delete a wiki page version. You need the Delete access right of the wiki page to delete a version. For more information about the Delete access rights, see Managing Edit and Delete Access Rights of a Wiki Page. To delete a wiki page version: 1. In the navigation bar, click Wiki. 2. Click the wiki page title link. 3. Click the Page History tab. 4. For the version that you want to delete, click the Delete button. 5. In the Delete Wiki Revision dialog, select the I understand that I will be unable to recover this revision history. check box and click Yes. The selected wiki page version is deleted

275 Using Wiki Pages in Oracle Developer Cloud Service Deleting a Wiki Page Open the wiki page to find the delete option. You need the Delete access right of the wiki page to delete it. For more information about the Delete access rights, see Managing Edit and Delete Access Rights of a Wiki Page. To delete a Wiki page: 1. In the navigation bar, click Wiki. 2. Click the wiki page title link. 3. Click Delete. 4. In the Delete Wiki Page dialog, select the I understand that my wiki page will be permanently deleted check box and click Delete. The wiki page along with comments is deleted. An activity with a link to restore the wiki page is added to the Recent Activities feed of the Project page. Note: If you delete a parent wiki page, the child wiki page is not deleted. The parent wiki page name continues to appear in the breadcrumb path. If you click the deleted parent wiki name link, you get a message stating that the wiki page has been deleted and you can restore it. Click the Restore button to restore the last version of the deleted wiki page. Restoring a Wiki Page You can restore a deleted wiki page along with its comments and attachments. To restore a deleted wiki page 1. Click the deleted wiki name link in the Recent Activity feed or any other wiki page where it was referenced. 2. In the page that opens, click Restore. The wiki page along with comments and attachments is restored to its original path. An activity with a link to the wiki page is added to the Recent Activities feed of the Project page

276 3 Administering a Project in Oracle Developer Cloud Service This section provides documentation about administrative tasks for an Oracle Developer Cloud Service project. Topics: Typical Workflow for Oracle Developer Cloud Service Project Owners About the Administration Page Managing an Oracle Developer Cloud Service Project Managing Project Users in Oracle Developer Cloud Service Managing Project Announcements in Oracle Developer Cloud Service Viewing Usage Metrics of Oracle Developer Cloud Service Components Configuring Oracle Developer Cloud Service Issue Components Managing Repositories in Oracle Developer Cloud Service Managing Branches of Git Repositories in Oracle Developer Cloud Service Configuring Webhooks in Oracle Developer Cloud Service Managing ATOM/RSS Feeds in Oracle Developer Cloud Service Exporting and Importing Project Data in Oracle Developer Cloud Service Importing External Hudson Jobs to Oracle Developer Cloud Service Configuring Link Rules in Oracle Developer Cloud Service Verifying Organization s Storage Configuration Typical Workflow for Oracle Developer Cloud Service Project Owners If you are a project owner, refer to the typical management workflow, as described in the following table. Task More Information Access Oracle Developer Cloud Service Manage an Oracle Developer Cloud Service project Access the Oracle Developer Cloud Service web interface. Update project properties, privacy setting, and the default wiki markup language. Accessing Oracle Developer Cloud Service Working with Oracle Developer Cloud Service Projects Add and manage users Add users to a project. Managing Project Users in Oracle Developer Cloud Service 3-1

277 Chapter 3 About the Administration Page Task More Information Manage issue components Manage merge requests Add Git repositories Add and manage Webhooks Add and manage ATOM/RSS Feed Handlers Configure link rules View storage usage metrics Import external Hudson jobs Export and import project data Create and manage issue components such as product release numbers and product components. Assign default reviewers to Git repository branches. Add additional project Git repositories or external repositories Add and manage Webhooks to send notifications to registered remote services. Add ATOM/RSS Feed handlers and then monitor the feeds in the Recent Activity Feed on the Project page. Define rules to convert plain text to URL links automatically when the text is entered in commit comments and merge request comments View usage metrics of the build executor, Git, Maven, Issues, and Wiki. Import jobs available on external Hudson installation to your Oracle Developer Cloud Service project Export project data to Oracle Cloud Infrastructure Object Storage Classic and import data to another or same project later About the Administration Page Configuring Oracle Developer Cloud Service Issue Components Managing Branches of Git Repositories in Oracle Developer Cloud Service Managing Repositories in Oracle Developer Cloud Service Configuring Webhooks in Oracle Developer Cloud Service Managing ATOM/RSS Feeds in Oracle Developer Cloud Service Configuring Link Rules in Oracle Developer Cloud Service Viewing Usage Metrics of Oracle Developer Cloud Service Components Importing External Hudson Jobs to Oracle Developer Cloud Service Exporting and Importing Project Data in Oracle Developer Cloud Service The Administration page displays the administrative options available for the opened project. The Administration page is available to project Owners only. About the Administration Page The Administration page is available to project Owners only. From the Administration page, you can manage various project administration actions such as add or remove users, create and manage Git repositories, manage Webhooks, manage ATOM/RSS Feeds, and view the usage metric. What You Can Do from the Administration Page See the Owner column in the tables of About the Actions You Can Perform as Project Owner or Project Member to know more about you can do as the project Owner. For frequently asked questions, see Questions about the Administration Page and Project Ownership. 3-2

278 Chapter 3 Managing an Oracle Developer Cloud Service Project What You See on the Administration Page The following table describes the key information shown on the Administration page. Properties Announcements Usage Metrics Issue Tracking Repositories Branches Webhooks ATOM/RSS Feeds Job Import Links Data Export/Import Storage Manage the project. Update project properties, change the wiki markup language, and delete the project. See Managing an Oracle Developer Cloud Service Project. Manage the project announcements. See Managing Project Announcements in Oracle Developer Cloud Service. View project s usage metrics. View the storage space used by Git, Maven, Hudson build executor, Issues, and Wiki. See Viewing Usage Metrics of Oracle Developer Cloud Service Components. Create and configure issue components such as product, release, tags, and sprints. See Configuring Oracle Developer Cloud Service Issue Components. Create and manage hosted and external Git repositories. See Managing Repositories in Oracle Developer Cloud Service. Manage branches of the Git repositories. Assign default reviewers to a branch and restrict push and merge actions to reviewers only. See Managing Branches of Git Repositories in Oracle Developer Cloud Service. Configure Webhooks to send notifications to registered remote services. See Configuring Webhooks in Oracle Developer Cloud Service. Subscribe to RSS/ATOM Feeds and monitor them in the Home page. See Managing ATOM/RSS Feeds in Oracle Developer Cloud Service. Import Hudson jobs from an external Hudson installation. See Importing External Hudson Jobs to Oracle Developer Cloud Service. Create and configure link rules to convert plain text to links. See Configuring Link Rules in Oracle Developer Cloud Service. Export and import project data. See Importing External Hudson Jobs to Oracle Developer Cloud Service. View storage configuration. See Verifying Organization s Storage Configuration. Managing an Oracle Developer Cloud Service Project After creating a project, you can manage it from the Administration page. 3-3

279 Chapter 3 Managing an Oracle Developer Cloud Service Project Note: To manage your project, you must be assigned the Owner role of the project. Topics Editing Project Properties Deleting a Project Changing the Wiki Markup Language of a Project About the Properties Page You can change a project s properties such as its name, description, security level, and the wiki markup language. What You See on the Properties Page The following table describes the key information and elements shown on the Properties page. Name Security Preferred Language Markup Language Delete Project Displays the project name. To update, enter a new name. The project name must be unique in the organization, must be two or more characters long, and must begin with a letter or a number and continue with letters, numbers,.(period), _(underscore), - (hyphen), or space. Displays the project description. to update, enter a new description. Displays the project s selected security setting. To change, select a different option. Private projects are accessible to invited members only. Shared projects are accessible to all members of the organization. Any member of the organization can view the source code, create or update issues, edit wiki pages, and interact with project builds. However, only project members and owners can push changes to the Git repository and perform deployment operations on the deployment configurations. Displays the preferred language for your notifications. To update, select a different language. Displays the project s selected wiki markup language. To update, select a different wiki markup language. See Changing the Wiki Markup Language of a Project. Delete the project. See Deleting a Project. Editing Project Properties After creating a project, you can edit a project's properties from the Administration page. To edit project properties: 1. In the navigation bar, click Administration. 3-4

280 Chapter 3 Managing an Oracle Developer Cloud Service Project 2. Click Properties. 3. In the Properties page, complete the elements using the descriptions in the table. Name Deleting a Project Security Edit the project name. Edit the project description. Change the project's privacy level. Preferred Language Specify the preferred language for your notifications. Markup Language To configure notifications, see Setting Notifications. Change the wiki markup language to Textile, Confluence, or Markdown. See Changing the Wiki Markup Language of a Project. When you are done, use the project navigation bar to switch to another page. You can delete a project from the Administration Properties page. To delete a project: 1. Open the project. 2. In the navigation bar, click Administration. 3. Click Properties. 4. In the Properties page, click Delete Project. 5. In the Delete Project dialog, select the I understand that my project will be permanently deleted check box. 6. Click Delete. Changing the Wiki Markup Language of a Project Oracle Developer Cloud Service supports wiki markup languages for document authoring, collaboration, and formatting comments. The wiki markup language is specified in the New Project wizard and in the Properties page of the Administration page. The project uses the specified wiki markup language at the following places: Wiki pages in the Wiki page Comments field of an issue in the Issues page Comments field in the Conversation tab of the Merge Request page Comments field in the Add Comment dialog of the source code while a merge request is in progress. Comments field in the Approve Merge Request dialog, Reject Merge Request dialog, and Merge dialog of the Merge Request For more information about the supported wiki markup languages, see About the Wiki Page. 3-5

281 Chapter 3 Managing Project Users in Oracle Developer Cloud Service To change the wiki markup language of the project: 1. In the navigation bar, click Administration. 2. Click Properties. 3. In the Properties page, select the Wiki markup language from the Markup Language options. Note: The changed wiki markup language will be used by new wiki pages and new comments in the Issues and Merge Request pages. Existing wiki pages and comments will continue to use the old wiki markup language. Managing Project Users in Oracle Developer Cloud Service Oracle Developer Cloud Service project user roles can be categorized into Owners and Members. The Team tab on the Project page displays all users and their project roles. For each user, the Team tab displays the user s name and the user s address. An Owner label is also displayed next to the user s name if the user is assigned the project Owner role. Topics About Oracle Developer Cloud Service Project Roles Adding Users to a Project Changing a User s Role in a Project Exporting List of Project Members Removing a User from a Project About Oracle Developer Cloud Service Project Roles A user in a project can be assigned the Owner role or the Member role. The following table lists the Oracle Developer Oracle Developer Cloud Service project roles. Role More Information Owner Can access all components of the Oracle Developer Cloud Service project. Can perform project management and administrative tasks such as add or remove Git repositories, manage project users, assign default reviewers, configure Webhooks, and manage ATOM/RSS Feeds handlers. Administering a Project in Oracle Developer Cloud Service 3-6

282 Chapter 3 Managing Project Users in Oracle Developer Cloud Service Role More Information Member Can use Oracle Developer Cloud Service to develop applications. Cannot perform project management or administrative actions. Developing Applications with Oracle Developer Cloud Service See the As a project Owner or a project Member, what can I do after I create or open a project? FAQ to know more about the actions a user can perform on a project. About the Actions You Can Perform as Project Owner or Project Member Depending upon the project role assigned to you, you can perform various actions. Actions You Can Perform on the Project page On the Project page, you can perform various actions, such as view and filter recent activities feed, manage project users, copy repository URLs, and view team statistics. The following table describes the actions of project Owners and project Members on the Project page. Non-members can perform actions in a shared project only. Action Ow ner Me mbe r Non- Memb er More Information View recent activity feed Using the Recent Activities Feed Filter recent activity feed Search activities Repositories tab Action Create a Git repository View Git repositories Mark Git repositories as favorite Copy Git repository URL Ow ner Me mbe r Non- Memb er More Information See the table in Creating a Hosted Git Repository to know what to enter in the fields of the dialog. Using the Repository Tab and Browsing Source Code in Oracle Developer Cloud Service Copying the URL of a Git Repository 3-7

283 Chapter 3 Managing Project Users in Oracle Developer Cloud Service Action Browse Maven repository and copy the Maven repository URL Browse the Docker registry and copy the Docker registry URL Ow ner Me mbe r Non- Memb er More Information Using the Repository Tab About the Docker Registry Repository Page Graphs and Statistics tab Action Ow ner Me mbe r Non- Memb er More Information View graphs and statistics Using the Graphs and Statistics Tab Team tab Action Ow ner Me mbe r Non- Memb er More Information View users Using the Team Tab Export user list Exporting List of Project Members Add or remove users Change a user s project role Adding Users to a Project and Removing a User from a Project Changing a User s Role in a Project Actions You Can Perform on the Code page and Git Repositories Various actions, such as clone a Git repository, view Git repository contents, create and remove branches and tags, and compare revisions can be performed on the Code page. Action Ow ner Me mbe r Non- Memb er More Information Create a hosted Git repository, add an external Git repository, or import a Git repository Creating a Hosted Git Repository, Adding an External Git Repository, and Importing a Git Repository Clone the Git repository Cloning the Oracle Developer Cloud Service Project Git Repository 3-8

284 Chapter 3 Managing Project Users in Oracle Developer Cloud Service Action Push commits to the Git repository Set the default branch of a Git repository Set Git repository branch restrictions View file contents and commits Create or delete branches and tags Compare files and revisions Download archive of a branch or a tag Add comments to commits View graphical history of commits Index a Git repository Delete a Git repository Ow ner Me mbe r Non- Memb er More Information If you are using the Git command line interface, use the Git push command. If you are using an IDE, use the Git Push action. See Using Git Commands, Using Git in Eclipse IDE, Using Git in NetBeans IDE, and Using Git in Oracle JDeveloper. Note: As a non-member, you can commit updates the cloned repository, but you cannot push the commits to the Git repository. Setting the Default Branch of a Git Repository Setting Branch Restrictions Viewing File Contents in the File View and About the Commit History List View About the Branches View and About the Tags View About the Compare View Downloading the Archive of a Git Repository Branch and Downloading the Archive of a Git Repository Branch Adding Comments to Files About the Commit History Graph View Indexing a Git Repository Deleting a Git Repository Actions You Can Perform on the Maven page On the Maven page, you can perform various actions, such as browse Maven repository, download and upload artifacts, and search for artifacts. The following table describes the actions of project Owners and project Members on the Maven page. Non-members can perform actions in a shared project only. Action Ow ner Me mbe r Non- Memb er More Information Browse the Maven repository About the Browse View Download artifacts from the Maven repository Downloading Artifacts from the Project Maven Repository Upload artifacts to the Maven repository About the Upload View 3-9

285 Chapter 3 Managing Project Users in Oracle Developer Cloud Service Action Ow ner Me mbe r Non- Memb er More Information Search artifacts in the Maven repository About the Artifact Search View Configure auto-cleanup of Maven repository Configuring Auto-Cleanup of the Project Maven Repository Snapshots Actions You Can Perform on the Releases page On the Releases page, you can perform various actions, such as create a release, download artifacts of a release, clone or edit a release, and delete a release. The following table describes the actions of project Owners and project Members on the Releases page. Non-members can perform actions in a shared project only. Action Ow ner Me mbe r Non- Memb er More Information Create a Release About the New Release Page Clone or Edit a Release About the Edit Release Page Delete a Release Deleting a Release Actions You Can Perform on the Snippets page On the Snippets page, you can perform various actions, such as create a snippet, view snippets, add files to a snippet, insert a snippet file, and clone a snippet s Git repository. The following table describes the actions of project Owners and project Members on the Snippets page. Non-members can perform actions in a shared project only. Action Ow ner Me mbe r Non- Memb er More Information Create a snippet Creating a Snippet View snippet files About the Snippet Details Page Insert a snippet file or copy a snippet file s text Inserting a Snippet File and Copying a Snippet File s Contents Clone the snippet Git repository Using Git with Snippets 3-10

286 Chapter 3 Managing Project Users in Oracle Developer Cloud Service Action Ow ner Me mbe r Non- Memb er More Information Push the commits to the snippet Git repository If you are using the Git command line interface, use the git push command. If you are using an IDE, use the Git Push action. See Using Git Commands, Using Git in Eclipse IDE, Using Git in NetBeans IDE, and Using Git in Oracle JDeveloper. Note: As a non-member, you can commit updates the cloned repository, but you cannot push the commits to the Git repository. Download the archive of the snippet Git repository Downloading an Archive of the Snippet Like a snippet Sharing and Liking a Snippet Add comments Adding Comments to a Snippet The following table lists additional actions a snippet owner can perform. Action Add, update, or remove snippet files Create snippet from selection Delete a snippet Sni ppe t Ow ner Oth er Proj ect Me mbe rs Non- Memb er More Information Managing Files of a Snippet Creating a Snippet from Selection Deleting a Snippet Actions You Can Perform on the Merge Requests page On the Merge Requests page, you can perform various actions, such as create a merge request, review code files, add comments, approve or reject a merge request, and merge and close merge requests. The following table describes the actions of project Owners and project Members on the MErge Requests page. Non-members can perform actions in a shared project only. Action Create a merge request Add comments or reply to a comment Ow ner Me mbe r Non- Memb er More Information Creating a Merge Request Adding Comments and Reviewing the Source Code 3-11

287 Chapter 3 Managing Project Users in Oracle Developer Cloud Service Action Ow ner Me mbe r Non- Memb er More Information Subscribe to merge request notifications All reviewers are automatically subscribed to merge request notifications. To know about what notifications you would receive, see About Merge Request Notifications. Non-Members can also subscribe to notifications. Open the merge request and click the CC Me button to subscribe. When a merge request is created, all reviewers are assigned the REVIEWER role. The submitter of the request is assigned the REQUESTOR role. The following table lists additional actions a REVIEWER or a REQUESTOR can perform.. Action REQU ESTO R REVI EWE R Other Users More Information Add or remove reviewers Add or Remove Reviewers Approve or Reject a merge request Approving or Rejecting a Merge Request Note: A project Owner can always approve or reject a merge request, even if he or she is not assigned the REVIEWER role. Merge branches or close a merge request Merging Branches and Closing a Merge Request Note: A project Owner can always merge branches or close a merge request, even if he or she is not assigned the REVIEWER role. Actions You Can Perform on the Issues page On the Issues page, you can perform various actions, such as create an issue, edit an issue, change its resolution, add comments and attachments, and update time spent. The following table describes the actions of project Owners and project Members on the Issues page. Non-members can perform actions in a shared project only. Action Ow ner Me mbe r Non- Memb er More Information Create an issue About the New Issue Page Update an issue About the Issue Details Page Create and configure issue products Managing and Configuring Issue Products Create and configure issue tags Managing and Configuring Issue Tags 3-12

288 Chapter 3 Managing Project Users in Oracle Developer Cloud Service Action Ow ner Me mbe r Non- Memb er More Information Create and configure issue custom fields Managing and Configuring Issue Custom Fields Actions You Can Perform on the Agile page On the Project page, you can perform various actions, such as crate boards, manage issues, and view reports. The following table describes the actions of project Owners and project Members on the Agile page. Non-members can perform actions in a shared project only. Action Ow ner Me mbe r Non- Memb er More Information Create a board Creating a Board Use Scrum board Using a Scrum Board Use Kanban board Using a Kanban Board View burndown charts and sprint reports About the Reports View When you create a board, you become the owner of the board. As the owner, you can perform various board and sprint related actions. Action Bo ard Ow ner Oth er Proj ect Me mbe rs Non- Memb er More Information Add issues to a sprint About the Backlog View Start a sprint Starting a Sprint Delete a sprint Deleting a Sprint Configure the board Configuring the Board Actions You Can Perform on the Build page On the Build page, you can perform various actions, such as creating a job, run a build, download artifacts, and view logs. The following table describes the actions of project Owners and project Members on the Build page. Non-members can perform actions in a shared project only. 3-13

289 Chapter 3 Managing Project Users in Oracle Developer Cloud Service Action Ow ner Me mbe r Non- Memb er More Information Create a job Creating a Job View job details About the Job Details Page View or edit the job configuration Configuring a Job Run a build Running a Build Download artifacts Downloading Build Artifacts View logs, such as build console, audit logs, and Git polling log About the Build Log Page, About the SCM Poll Logs Page, About the SCM Changes Page, About the Test Results Page, About the Audit Page Disable or delete a job Disabling or Enabling a Job and Deleting a Job Create a pipeline Creating a Pipeline Configure a pipeline About the Configure Pipeline Page View a pipeline s instances About the Pipeline Instances Page Delete a pipeline Deleting a Pipeline Actions You Can Perform on the Deploy page On the Project page, you can perform various actions, such as crate deployment configurations, deploy artifacts, and view logs. The following table describes the actions of project Owners and project Members on the Deploy page. Non-members can perform actions in a shared project only. Action Ow ner Me mbe r Non- Memb er More Information Create a deployment configuration About the Deployment Configuration Page Note: You must be assigned the Admin Role for Oracle Java Cloud Service (Java_Administrators) identity domain role to create a deployment configuration. Deploy or redeploy a configuration After the deployment configuration is created, project members can deploy or redeploy the application. View deploy logs Viewing Deployment Logs Actions You Can Perform on the Docker Registry page On the Docker Registry page, you can perform various actions, such as link external docker registries, view their repositories and images, and download image manifests. 3-14

290 Chapter 3 Managing Project Users in Oracle Developer Cloud Service The following table describes the actions of project Owners and project Members on the Docker Registry page. Non-members can perform actions in a shared project only. Action Ow ner Me mbe r Non- Memb er More Information Link an external Docker registry Adding a Link to an External Docker Registry View external Docker registries, their repositories, and images About the Docker Registry Repository Page Download an image manifest of an external Docker registry repository Delete an image manifest of an external Docker registry repository Actions You Can Perform on the Wiki page On the Wiki page, you can perform various actions, such as create and view wiki pages, create child wiki pages, add attachments, and add and view comments. Action Ow ner Me mbe r Non- Memb er More Information Create a wiki Creating a Wiki Page View a wiki page Viewing a Wiki Page Edit a wiki page By defa ult By default Editing a Wiki Page Note: The project Owner (or Member, if allowed) can grant the edit rights of a wiki page to all users; or restrict the edit access to Members or Owners only. See Managing Edit and Delete Access Rights of a Wiki Page. Delete a wiki page By defa ult By default Deleting a Wiki Page Note: The project Owner (or Member, if allowed) can grant the delete rights of a wiki page to all users; or restrict the delete access to Members or Owners only. See Managing Edit and Delete Access Rights of a Wiki Page. Adding Users to a Project You can add users who are already a member of the identity domain and are assigned the Developer Service User (DEVELOPER_USER) role. You must also be assigned the Owner role of the project to add a user. Tutorial 3-15

291 Chapter 3 Managing Project Users in Oracle Developer Cloud Service To add a user to a project: 1. In the navigation bar, click Project. 2. Click the tab on the right. 3. Click + New Team Member. 4. In the New Member dialog, complete the elements using the descriptions in the table. Role Username Multiple Users Select the role that you want to assign to the new member. See About Oracle Developer Cloud Service Project Roles. Start typing the user name and then select the user from the list. If you do not find the user name in the list, contact the Identity Domain Administrator to add the user to the Identity Domain. Click to add multiple users. Start typing the user name in Username, select the user from the list, and click the selected user is added to the Username List text box. icon. The In the Username List text box, you can also enter the user names separated by a space, a comma, a semicolon, or a new line. If there is a typo in the username or the user does not exist, an Invalid User error message appears. 5. Click Add. An notification is sent to the added user. If the user name is not found in the organization, an error message appears on the screen. If you add a user who has not been added to any other project before, an is sent to the user to verify the address. As soon as the user verifies the address, a Welcome is sent with the URL of the subscribed Oracle Developer Cloud Service instance. To view or update the address, see Updating Profile Information. Note: To add a user to the Identity Domain, see Add Users and Assign Roles in Getting Started with Oracle Cloud. You must be assigned the Identity Domain Administrator (TenantAdminGroup) role to add a user to the Identity Domain. Changing a User s Role in a Project By default, a user is assigned the Member role of the project. You can set a user's role to Member or Owner. You must be assigned the Owner role of the project to change or assign a role. To change a user s role: 1. In the navigation bar, click Project. 2. Click the tab on the right. 3-16

292 Chapter 3 Managing Project Users in Oracle Developer Cloud Service 3. To change the user s role to Owner, mouse over the user name and click. If the user is already an Owner, click role. to remove the privileges of the Owner Note: If you are the creator of the project, you are assigned the Owner role by default. You cannot change your own role to Member. Exporting List of Project Members You can get a list of names of project members from the Team tab on the Project page. To export a list of project members: 1. In the navigation bar, click Project. 2. Click the tab on the right. 3. Click. 4. In the Members List Export dialog, copy the names of project members. 5. Click OK or to close the dialog. Exporting the list of project members is useful if you want to add the same members to another project. Instead of adding members one by one, you can copy their names from the export list and add them to another project after selecting the Multiple Users check box. See Adding Users to a Project. Removing a User from a Project You must be assigned the Owner role of the project to remove a user from the project. To remove a user from a project: 1. In the navigation bar, click Project. 2. Click the tab on the right. 3. Mouse over the user name you want to remove and click. 4. If the user is an owner of some issues and merge requests, a dialog appears listing the issues and merge requests owned by the user. You may want to change the ownership of the issues and merge requests after removing the user. 5. Click Yes to continue and remove the user. 3-17

293 Chapter 3 Managing Project Announcements in Oracle Developer Cloud Service Note: To remove a user's account from Oracle Cloud, see Managing Users, User Accounts, and Roles in Managing and Monitoring Oracle Cloud. You must be assigned the Identity Domain Administrator role to remove a user from the Identity Domain. Managing Project Announcements in Oracle Developer Cloud Service Project Announcements are messages that you want to be visible on the Project page above the Recent Activity feed. Topics About the Create Announcement Page Viewing or Editing an Announcement Deactivating or Activating an Announcement Copying an Announcement Deleting an Announcement About the Announcements Page You can view or edit an announcement from the Administration Announcements page. What You See on the Announcements Page The following table describes the key information and elements shown on the Announcements page. New Announcement Announcement list Activate / Deactivate Create an announcement. See About the Create Announcement Page. Displays all announcements of the project. Select an announcement to view its details or edit it. Click to activate or deactivate the announcement. See Deactivating or Activating an Announcement. Copy Announcement Click to create an announcement with details copied from the selected announcement. See Copying an Announcement. Delete Name Active Click to delete the selected announcement. See Deleting an Announcement. Enter or edit the announcement name. Indicates if the announcement is active and must be displayed on the Project page. Deselect the check box to deactivate the announcement. The check box and the Deactivate button work in the same manner. 3-18

294 Chapter 3 Managing Project Announcements in Oracle Developer Cloud Service Content Icon In the Write tab, edit or enter the content of the announcement. You can use the project s wiki markup language to format the content. Click the markup language name link in the right corner above the field to open a cheat sheet of the markup language. Click the Preview tab to preview the formatting of the content. Drag-and-drop the icon image that you want to use for the announcement. The icon image must of the 48x48 pixels dimension. You can also click Choose Image to open the File Upload dialog, browse, and select the file that you want to upload. The new uploaded image will replace any existing icon image. Creating an Announcement You can create an announcement from the Administration Announcements page. To create an Announcement: 1. In the navigation bar, click Administration. 2. Click Announcements. 3. In the Announcements page, click + New Announcement. 4. Enter details in the Create Announcement page. 5. Click Done. If the Active check box is selected, the announcement appears in the Announcements section above the Recent Activity Feed of the Project page in the order of their creation or updates, that is the last created or updated announcement appears at the top. About the Create Announcement Page You enter the announcement details on the Create Announcement page. What You See on the Create Announcement Page The following table describes the key information and elements shown on the Create Announcement page. Name Active Content Enter the project announcement name. Indicates if the announcement is active and must be displayed on the Project page. The check box is selected by default. In the Write tab, enter the content of the announcement. You can use the project s wiki markup language to format the content. Also see Formatting Comments using the Wiki Markup Language. Click the Preview tab to preview the formatting of the content. 3-19

295 Chapter 3 Managing Project Announcements in Oracle Developer Cloud Service Icon Drag-and-drop an image that you want to use as the icon for the announcement. The icon image must be of the 48x48 pixels dimension. You can also click Choose Image to open the File Upload dialog, browse, and select the file that you want to upload. Viewing or Editing an Announcement You can view or edit an announcement from the Administration Announcements page. To view or edit an announcement: 1. In the navigation bar, click Administration. 2. Click Announcements. 3. In the Announcements list, click to select the announcement that you want to view or edit. All announcements of the project are listed along with their icon. 4. In the Announcement section on the right side of the list, complete the elements. The changes made to the fields are saved immediately when the focus moves out of the field component. Deactivating or Activating an Announcement You can deactivate or activate an announcement from the Administration Announcements page. The deactivated announcement is not visible in the Announcements section of the Project page. To deactivate or activate an announcement: 1. In the navigation bar, click Administration. 2. Click Announcements. 3. In the Announcements list, click to select the announcement that you want to deactivate or activate. 4. Click Deactivate to deactivate the selected announcement. The announcement is not removed, but is also not visible in the Announcements section of the Project page. Copying an Announcement A deactivated announcement appears greyed in the Announcements list. To activate an announcement, select it from the list, click Activate, and make it visible in the Project page. You can copy an announcement and create another from the Administration Announcements page. To copy an announcement: 1. In the navigation bar, click Administration. 3-20

296 Chapter 3 Viewing Usage Metrics of Oracle Developer Cloud Service Components 2. Click Announcements. 3. In the Announcements list, click to select the announcement that you want to copy. 4. Click Copy Announcement to create another announcement with the content and icon of the selected announcement. 5. In the Create Announcement page, provide a name to the announcement, edit the content as required, update the icon image if required, and click Done. The copied announcement appears in the Announcements list. Deleting an Announcement You can delete an announcement from the Administration Announcements page. A deleted announcement can not be recovered. To delete an announcement: 1. In the navigation bar, click Administration. 2. Click Announcements. 3. In the Announcements list, click to select the announcement that you want to delete 4. Click Delete to delete the selected announcement. 5. In the Delete Announcement dialog, click Yes to confirm. Viewing Usage Metrics of Oracle Developer Cloud Service Components You can view the usage metrics of Git, Maven, Build system, Tasks, and Wikis in the Administration page. When you subscribe to Oracle Developer Cloud Service, you are entitled to some storage space on Oracle Cloud. To learn about your storage entitlement, see the Pricing tab on Note: To view usage metrics, you must be assigned the Owner role of the project. To view your usage metrics: 1. In the navigation bar, click Administration. 2. Click Usage Metrics. The Usage Metrics page displays the storage space used by Git, Maven, Issues, Wiki, and Build system. When you are done, use the project navigation bar to switch to another page. 3-21

297 Chapter 3 Configuring Oracle Developer Cloud Service Issue Components Configuring Oracle Developer Cloud Service Issue Components In a project, you can define products, components, owners of components, releases, and tags, of your project before creating and assigning issues to project members. You can define multiple product categories, components, and sub-components; customize the releases; provide custom tags; and add custom fields for your project. Topics Managing and Configuring Issue Products Managing and Configuring Issue Tags Managing and Configuring Issue Custom Fields Note: To define issue components, you must be assigned the Owner role of the project. Managing and Configuring Issue Products You can create and manage products for the issues of your project from the Products tab of the Issue tracking page. To open the Product page: 1. In the navigation bar, click Administration. 2. Click Issue Tracking. 3. Click the Products tab. All products for issues are listed in the list box on the left. Select the product to view details. See Viewing or Editing an Issue Product Details Click New Product to create a product. See About the Create Issue Product Page Click the icon on the right side of the name on the list to remove the product. See Deleting an Issue Product. When you are done, use the project navigation bar to switch to another page. About the Issue Tracking Products Tab You can create and manage issue products from the Products tab. What You See on the Issue Tracking Products Tab The following table describes the key information and elements shown on the Issue Tracking Products Tab. 3-22

298 Chapter 3 Configuring Oracle Developer Cloud Service Issue Components New Product Product list Name Releases Click to create a product. Lists all products of the project. Select a product tro view its details. View or enter the name of the selected product. Lists releases of the product. To add a release, click New Release. Enter the release name in the Release Name text box and press Enter. To make the release the default release of the product, click. Components To remove a release, click. To reorder a release, mouse over the release name and use the dragand-drop action to move the release up or down. Lists components of the product. A Component is a subsection of a Product. Each Product must contain at least one component. To add a component, click New Component. Enter the component name in Component Name and select the owner of the component from the Initial Owner list. To remove a component, click. To make a component the default component of the product, click. Found In Tags Manage tags added to the Found In field while creating or updating an issue. For more information, see the Found In field description in About the New Issue Page. To edit a tag, click the tag name and edit it. The edited name will automatically appear in the Found In list. To remove a tag, click. Viewing or Editing an Issue Product Details In the Products tab, select the product in the left list to view details. To view or edit an issue product: 1. In the navigation bar, click Administration. 2. Click Issue Tracking. 3. Click the Products tab. Creating an Issue Product 4. In the Products list, select a product to view or edit its details. A product is a category that represents an entity. You can create multiple products for a project. To create an issue product: 1. In the navigation bar, click Administration. 2. Click Issue Tracking. 3. Click the Products tab. 3-23

299 Chapter 3 Configuring Oracle Developer Cloud Service Issue Components 4. In the Product List administration page, click New Product. 5. Enter product details. 6. Click Done. About the Create Issue Product Page On the Create Issue Product page, you create an issue product and enter its details such as releases, components, and tags. What You See on the Create Issue Product Page The following table describes the key information and elements shown on the Create Issue Product page. Name Releases Enter the product name. Lists releases of the product. To add a release, click New Release. Enter the release name in the Release Name text box and press Enter. To make the release the default release of the product, click. Components To remove a release, click. To reorder a release, mouse over the release name and use the dragand-drop action to move the release up or down. Lists components of the product. A Component is a subsection of a Product. Each Product must contain at least one component. To add a component, click New Component. Enter the component name in Component Name and select the owner of the component from the Initial Owner list. To remove a component, click. To make a component the default component of the product, click. Found In Tags Manage tags added to the Found In field while creating or updating an issue. For more information, see the Found In field description in About the New Issue Page. To edit a tag, click the tag name and edit it. The edited name will automatically appear in the Found In list. To remove a tag, click. Deleting an Issue Product You can delete an issue product from the product list of the Product tab. You cannot delete a product until issues or reviews refer to it. First remove all issues and merge requests that refer to the product, and then remove the product. To remove an issue product: 1. In the navigation bar, click Administration. 2. Click Issue Tracking. 3-24

300 Chapter 3 Configuring Oracle Developer Cloud Service Issue Components 3. Click the Products tab. 4. In the product list of the Products tab, click the icon on the right side of the name. 5. In the Delete Product dialog, click Yes to confirm. After confirmation, the product is removed. Managing and Configuring Issue Tags You can create and manage tags for the issues of your project from the Tags tab of the Issue tracking administration page. To open the Tags page: 1. In the navigation bar, click Administration. 2. Click Issue Tracking. 3. Click the Tags tab. All tags for issues are listed in the Tags page. Click New Tag to create an issue tag. See About the Issue Tracking Tags Tab Select the tag to rename it. See Renaming an Issue Tag Click the icon on the right side of the name on the list to delete the tag. See Removing an Issue Tag Note: When you are done, use the project navigation bar to switch to another page. About the Issue Tracking Tags Tab You can create and manage issue tags from the Tags tab. What You See on the Issue Tracking Tags Tab The following table describes the key information and elements shown on the Issue Tracking Tags Tab. Filter Tags New Tag Tag list Enter text to search for an issue tag. Click to create an issue tag. Lists all issue tags of the project. 3-25

301 Chapter 3 Configuring Oracle Developer Cloud Service Issue Components Creating an Issue Tag A tag is a keyword that can be used to categorize an issue. You can add multiple tags for a product. By default, three issue tags (Plan, Release, and Epic) are available when a project is created. To create a tag: 1. In the navigation bar, click Administration. 2. Click Issue Tracking. 3. Click the Tags tab. 4. Click New Tag. Renaming an Issue Tag Enter a name and description of the tag in the last row of the Tags table and press Enter. Note that the tag name must contain only letters and numbers. In the Tags tab, select the tag and rename it. To rename a tag: 1. In the navigation bar, click Administration. 2. Click Issue Tracking. 3. Click the Tags tab. 4. Select the tag. Removing an Issue Tag 5. Enter a new name and move the cursor out of the text box to save it. Tags is issues that refer to it are renamed automatically. You can delete an issue tag from the Tags tab. You cannot delete a tag until issues refer to it. First remove all issues that refer to the tag, and then remove the tag. To remove an issue tag: 1. In the navigation bar, click Administration. 2. Click Issue Tracking. 3. Click the Tags tab. 4. In the tag name, click the icon on the right side of the name. After confirmation, the tag is removed. Managing and Configuring Issue Custom Fields You can create and manage custom fields for the issues of your project from the Custom Fields tab of the Issue tracking page To open the Custom Fields tab: 3-26

302 Chapter 3 Configuring Oracle Developer Cloud Service Issue Components 1. In the navigation bar, click Administration. 2. Click Issue Tracking. 3. Click the Custom Fields tab. All custom fields for the issues of the project are listed in the list box on the left. Select the custom field to view details. Click New Custom Field to create a custom field. See About the Issue Tracking Create Custom Field Page. Click the icon on the right side of the custom fields name on the list to remove the custom field. See Deleting an Issue Custom Field. When you are done, use the project navigation bar to switch to another page. About the Issue Tracking Custom Fields Tab The Custom Fields tab displays the issue custom fields and enables you to view and edit their properties. What You See on the Issue Tracking Custom Fields Tab The following table describes the key information and elements shown on the Issue Tracking Custom Fields Tab. New Custom Field Name Label Available for New Issues Obsolete (Hidden) Type Click to create a custom field. View the name of the custom field. The name cannot be edited. View or enter the label (display text) of the custom field. Select the check box if you want the custom field to appear as a parameter when new issues are created. Select the check box if you want to hide the custom field. View the field's input type. Creating a Custom Field You can create your own custom fields for an issue. The custom fields are available in the Details section of the New Issue page when an issue is created. To create a custom field: 1. In the navigation bar, click Administration. 2. Click Issue Tracking. 3. Click the Custom Fields tab. 4. Click New Custom Field. 5. Complete the elements. 6. Click Done. 3-27

303 Chapter 3 Configuring Oracle Developer Cloud Service Issue Components Note: You cannot change a custom field's Name or Type after it has been created. To edit the value of Name or Type, remove the custom field and create the custom field again. To remove a custom field, mouse over the field name in the Custom Field list, and click the field.. Click Yes in the Remove Custom Field dialog to remove When you are done, use the project navigation bar to switch to another page. About the Issue Tracking Create Custom Field Page You can create your own custom fields for an issue. The custom fields are available in the Details section of the New Issue page when an issue is created. What You See on the Issue Tracking Create Custom Field Page The following table describes the key information and elements shown on the Issue Tracking Create Custom Field Page. Name Label Available for New Issues Obsolete (hidden) Type Values Enter the name of the custom field. The name must be unique in the project. Enter the label (display text) of the custom field. Select the check box if you want the custom field to appear as a parameter when new issues are created. Select the check box if you want to hide the custom field. Select the field's input type. You can select any of the following input types: Single line input text Single selection Multi selection Long text input Time and Date Check box If you selected Single Selection or Multi Selection as Type, add values for the list. Click New Value, enter the new value in Value text box, and press Enter. Viewing and Editing a Custom Field s Details To view details of a custom field s details, select the field in the list and view or edit its details on the right, This table describes the elements in the Create Custom Field page. 3-28

304 Chapter 3 Managing Repositories in Oracle Developer Cloud Service Name Label Available for New Issues Obsolete (hidden) Type View the name of the custom field. The name cannot be edited. View or enter the label (display text) of the custom field. Select the check box if you want the custom field to appear as a parameter when new issues are created. Select the check box if you want to hide the custom field. View the field's input type. Deleting an Issue Custom Field You can delete a custom issue from the issues list of the Custom Issue tab. To remove a custom issue: 1. In the navigation bar, click Administration. 2. Click Issue Tracking. 3. Click the Custom Issues tab. 4. In the issues list, click the icon on the right side of the name. 5. In the Delete Custom Field dialog, click Yes to confirm. After confirmation, the custom field is removed. All existing issues are automatically updated to remove the custom fields. Managing Repositories in Oracle Developer Cloud Service When a project is created, you can choose to initialize the project with one project Git repository for the project. A Maven repository is also created. If required, you can add more project Git repositories, add external Git repositories, import Git repositories, configure auto-cleanup of the to the project Maven repository, and add Docker registry links. Note: To perform any of the above actions, you must be assigned the Owner role of the project. Topics Creating a Hosted Git Repository Adding an External Git Repository Importing a Git Repository Editing a Git Repository Setting the Default Branch of a Git Repository Indexing a Git Repository Deleting a Git Repository 3-29

305 Chapter 3 Managing Repositories in Oracle Developer Cloud Service Adding a Link to an External Docker Registry Configuring Auto-Cleanup of the Project Maven Repository Snapshots About the Repositories Page From the Repositories page, you can manage Git repositories, link external Docker registries, and configure auto cleanup of Maven repository. What You See on the Repositories Page The following table describes the key information and elements shown on the Repositories page. Hosted Repositories External Repositories Lists all hosted Git repositories. Click the repository name link to open it in the Code page. Click HTTP/SSH list to copy the HTTP or the SSH URL of the Git repository. Select the desired option in the list and then click copy the URL to the clipboard. From the menu, select Edit to edit the Git repository description and the default branch; select Index to index the Git repository; and select Delete to delete the Git repository. Click New Hosted Repository to create a Git repository. See Creating a Hosted Git Repository. Lists all linked external Git repositories. Click the repository name link to open it in the Code page. to In HTTP, click to copy the Git repository URL to the clipboard. Docker Registries From the menu, select Edit to edit the Git repository description and the default branch; select Index to index the Git repository; and select Remove to remove the external Git repository from the project. Click New External Repository to link an external Git repository to the project. See Adding an External Git Repository. Lists all linked external Docker registries. Click the registry name link to open it in the Docker Registry page. In HTTP, click to copy the Docker registry URL to the clipboard. Maven Repository From the menu, select Edit to edit the Docker registry details, and select Remove to remove the external Docker registry from the project. Click Link External Registry to link an external Docker registry. See Adding a Link to an External Docker Registry. Configure auto-cleanup of Maven repository snapshots. See Configuring Auto-Cleanup of the Project Maven Repository Snapshots. Creating a Hosted Git Repository You can add multiple hosted Git repositories to your project. A hosted Git repository is also called as a project Git repository. To add a hosted Git repository to a project: 3-30

306 Chapter 3 Managing Repositories in Oracle Developer Cloud Service 1. In the navigation bar, click Administration. 2. Click Repositories. 3. Under Hosted Repositories, click + New Hosted Repository. 4. In the New Repository dialog, complete the elements using the descriptions in the table. Name Initialize repository with README file Initial Content Enter a unique name of the repository. Ensure that the repository name begins with a letter or a number, and does not contain special characters or spaces. Enter a description of the repository. Select the check box initialize the repository with areadme.md file created in the master branch. If you do not select the check box, the repository will be empty. Specify how to initialize the new repository. Select Empty Repository if you do not want to initialize the repository. Select Initialize repository with README file to initialize the repository with areadme.md file created in the master branch. Select Import existing repository to import a Git repository. See Importing a Git Repository. 5. Click Create. The new repository URL is now available on the Code page, the Recent Activity feed, and the section of the Project page. Note: You can also add a hosted repository from the Project page. On the Project page, click the tab on the right, and click New Repository. Adding an External Git Repository Oracle Developer Cloud Service also supports external Git repositories. You can add the URL of the external Git repository in your project and continue to use the external Git repository. Oracle Developer Cloud Service will track all commits and push operations to the external remote repository as it tracks the project Git repositories. Watch a short video to learn more about using an external Git repository in Oracle Developer Cloud Service. Video To add an external Git repository in your project: 1. In the navigation bar, click Administration. 2. Click Repositories. 3-31

307 Chapter 3 Managing Repositories in Oracle Developer Cloud Service 3. Under External Repositories, click New Repository. 4. In the New Repository dialog, enter the URL of the external Git repository in URL and the repository description in. 5. Expand the Credentials for non-public repos section and provide the credentials to access the external Git repository. You should create an authentication token such as GitHub's personal access token or BitBucket's App Password and use it to provide access to the external Git repository. Do not provide the password of your account. In Username, enter the username of the external repository account. In Token, enter the authentication token. 6. Click Create. The external repository is now available in the Code page and the section of the Project page. An activity feed is also displayed in the Recent Activity feed. You can now clone the external Git repository and push the updates. Importing a Git Repository When you create an empty project Git repository, you can import files from another existing Git repository to it. You can import an external Git repository, a Git repository from a shared project, or make a copy of a Git repository of your own project. To import a Git repository: 1. Create a project Git repository. See Creating a Hosted Git Repository. 2. In the New Repository dialog, in Initial content, select Import existing repository. 3. Enter the source Git repository URL in the text box. If the imported Git repository is password protected, enter the repository credentials in Username and Password. Note that Oracle Developer Cloud Service does not store the credentials. 4. Click Create. You can also import an existing Git repository to an empty project Git repository from the Code page. If the added hosted Git repository is empty, enter the Git repository s URL in the Import existing repository section of the Code page. Enter repository credentials, if required, and click Import. After you import a Git repository, any changes saved to the source Git repository will not be available in the imported Git repository. Editing a Git Repository You can update a Git repository s description from the Administration page and the Code page. You cannot change the name of the Git repository. To update the Git repository description: 1. In the navigation bar, click Administration. 2. Click Repositories. 3. Mouse over the Git repository name. 3-32

308 Chapter 3 Managing Repositories in Oracle Developer Cloud Service 4. Click the menu and select Edit. 5. In the field of the Edit Repository dialog, enter or edit the repository description. 6. In the Default branch, specify the default branch of the repository.. 7. Click Update You can also update a Git repository s description from the Code page. In the Code page, select from the list and edit the repository description. Setting the Default Branch of a Git Repository By default, the master branch of a Git repository is the default branch. However, you can set any branch as the default branch of a Git repository. When you open a Git repository in the Code page, the contents of the default branch will be displayed. To set the default branch of a Git repository: 1. In the navigation bar, click Administration. 2. Click Repositories. 3. Mouse over the repository name. 4. Click the menu and select Edit. 5. In the Default Branch drop-down list of the Edit Repository dialog, select the branch that you want to set as the default branch. 6. Click Update. Indexing a Git Repository Indexing a Git repository creates or updates the Git repository index file with the latest changes. A Git index file is a binary file that serves as a virtual staging area for the next commit and contains a sorted list of object path names, along with permissions and the SHA-1 of a blob object. To index a Git repository: 1. In the navigation bar, click Administration. 2. Click Repositories. 3. Mouse over the repository name you want to index. 4. Click the menu and select Index. Deleting a Git Repository You can delete a Git repository from the Administration page. To delete a Git repository: 1. In the navigation bar, click Administration. 3-33

309 Chapter 3 Managing Repositories in Oracle Developer Cloud Service 2. Click Repositories. 3. Mouse over the repository name you want to delete. 4. Click the menu and select Delete. 5. In the Remove Repository dialog, click Yes. Adding a Link to an External Docker Registry You can link external docker registries to a project and view the contents of the Docker registry in the Docker Registry page of the project. After linking an external Docker registry, you need not leave the project to view its contents. To add a link to an external Docker registry: 1. In the navigation bar, click Administration. 2. Click Repositories. 3. In Docker Registries, click + Link External Registry. To view all linked Docker registries, expand Linked External Docker Registries. 4. In the Link External Docker Registry dialog, complete the elements using the descriptions in the table. Registry Name Registry URL Short Authentication Enter a unique Docker registry name. The name must be unique in the Linked External Docker Registries section. Enter the URL of the Docker registry. For example: registry-1.docker.io. Enter a short description of the registry. Select the authentication method to connect to the registry. By default, Basic is selected. Basic: Enter the basic username and password details in Username and Password. OAuth2: Enter the long-lived access token as the authentication in Auth Token. Do not enter a short-lived access token. For more information about OAuth2 in Docker, see docs.docker.com/registry/spec/auth/oauth/. Anonymous: Use this option if the registry can be accessed anonymously and does not require any authentication. 5. Click Create. The dialog tests the access to the registry and adds it to the Linked External Docker Registries section after the access is successful. You can access the registry and other linked registries from the Docker Registry page. To edit the registry, mouse over the registry name, click on the right, and click Edit. Edit the details in the Edit External Docker Registry dialog and click Update. To remove the registry, mouse over the registry name, click on the right, and click Remove. In the Remove docker Registry dialog, click Remove. After linking a Docker registry, you can configure a job to use it while running a build. See Adding a Docker Builder. 3-34

310 Chapter 3 Managing Repositories in Oracle Developer Cloud Service Configuring Auto-Cleanup of the Project Maven Repository Snapshots You can configure the project Maven repository to clean-up and purge old versions of artifact snapshots when a new version is uploaded to the repository. By default, when you upload a new snapshot of an artifact to the project Maven repository manually or via job builds, the repository retains the old versions of the snapshots. You can configure the project to remove the old versions when a new version is uploaded. To remove older versions of snapshots automatically when a new version is uploaded: 1. In the navigation bar, click Administration. 2. Click Repositories. 3. In Maven Repository, if necessary, expand Configure auto cleanup for Snapshot versions. 4. Select the Purge check box. 5. In Default Max Snapshots, enter a number between 2 and 500 to specify the maximum versions to retain. By default, 2 versions of the snapshots are retained. All changes are saved automatically when you navigate to another field. After the rule is enabled, any new upload of a snapshot will remove its older versions if the number of snapshots exceed the value in Default Max Snapshots. You can also add exceptions to the auto-cleanup and Default Max Snapshots rule and customize the snapshot counts. The project Maven repository will retain the snapshot counts of group IDs and artifacts defined in the Customized Snapshot Counts section and will use the default value specified in Default Max Snapshots for artifacts that do not have exceptions defined. To define exceptions and customize snapshot count: 1. In the Maven Repository section of the Repositories page, select the Purge check box and configure the default auto-cleanup as described above. 2. To add an artifact group or an artifact name as an exception, click + Add in the Customized Snapshot Counts section. 3. Specify the following details: Group Id (Required): Enter or select the Group ID of the artifact. You can select the ID from the list or start typing and then select the ID from the list of suggestions. The auto-suggest list is based on the Maven indexes. If no index data is available, the auto-suggest list will not appear. Artifact Id (Optional): Enter or select the Artifact ID of the artifact. You can select the ID from the list or start typing and then select the ID from the list of suggestions. The auto-suggest list is based on the Maven indexes. If no index data is available, the auto-suggest list will not appear. Snapshot Count: Select the number of snapshots to retain in the project Maven repository. By default, 2 snapshots are retained. To remove an exception, click on the right. For a long list of exceptions, you can use the Filter field and enter a search coordinates criteria to see the exceptions matching the criteria. 3-35

311 Chapter 3 Managing Branches of Git Repositories in Oracle Developer Cloud Service Note: If you enter an exception with duplicate coordinates, an error message Unable to save. Coordinates already exists. Enter unique coordinates appears. Managing Branches of Git Repositories in Oracle Developer Cloud Service You can set restrictions on a Git repository branch and assign project members as default reviewers. You can assign multiple project members as default reviewers of a branch. When a merge request is created for a particular branch, the default reviewers are automatically added to the Reviewers list. You can set rename, delete, push and merge restrictions on a branch and can also lock a branch if you do not want anyone to push commits or merge another branch to it. Topics Assigning Default Reviewers to a Repository Branch Assigning Repository Branches to a Project Member Setting Branch Restrictions About the Branches Page From the Branches page, you can manage default reviewers and set restrictions. What You See on the Branches Page The following table describes the key information and elements shown on the Branches page. By Branch By User Select a Git repository and a branch and then set its default reviewers and restrictions. See Assigning Default Reviewers to a Repository Branch and Setting Branch Restrictions. Select a project user and a Git repository and then specify the default reviewers of the Git repository branches. See Assigning Repository Branches to a Project Member. Assigning Default Reviewers to a Repository Branch A default reviewer is a project member who will be added as a reviewer when a merge request is created on a specified target branch. You can assign default reviewers to any Git repository branch of your project. The user interface makes it easy for you to assign multiple members of your project to a branch or assign multiple branches to a single project member. To assign default reviewers to a branch: 3-36

312 Chapter 3 Managing Branches of Git Repositories in Oracle Developer Cloud Service 1. In the navigation bar, click Administration. 2. Click Branches. 3. Click the By Branch toggle button. 4. Complete the elements using the descriptions in the table. Repository Branches Default Reviewers Select the Git repository name from the list. Select the branch name from the list. Enter the member name or select members from the list whom you want to assign the default reviewer role of the Git repository branch. To add more users to a project, see Adding Users to a Project. Branch Restrictions Restrict the branch rename and delete privilege to project owners only. For more information, see Setting Branch Restrictions. When you are done, use the project navigation bar to switch to another page. Setting Branch Restrictions By default, any project member can rename or delete a repository branch, and push and merge into it. As a project Owner, you can protect a repository branch and restrict rename, delete, push and merge to project owners, default reviewers and the creator of a merge request. You can also lock a branch if you do not want anyone (including project owners and reviewers) to push commits or merge another branch to it. Watch a short video to see how to set restrictions on a branch. Video To protect or lock a branch: 1. In the navigation bar, click Administration. 2. Click Branches. 3. If required, click the By Branch toggle button. 4. Complete the elements using the descriptions in the following tables. Branches Repository Branches Select the Git repository from the list. Select the branch where you want to set restrictions. A Lock icon appears if any restrictions are set on the branch. Branch Options 3-37

313 Chapter 3 Managing Branches of Git Repositories in Oracle Developer Cloud Service Protect <branch_name> branch Push and Merge Reject 'force push' option Default Reviewers Project Owners Select the check box to restrict rename and delete actions on the selected branch. After the check box is selected, a RESTRICTED label appears next to the check box. Select the check box to restrict the push and merge actions. Denied: Select the check box to lock the branch and deny changes to the branch by anyone. Restricted to Project Owners only: Select the option to restrict the push and merge actions to project owners only. Restricted to Project Owners and Default Reviewers only: Select the option to restrict the push and merge actions to project owners and default reviewers only. You can see the list of default reviewers in the Default Reviewers field. Restricted to Project Owners, Default Reviewers, Reviewers and submitter of approved merge request: Select the option to restrict the push and merge to project owners, default reviewers, reviewers, and submitter of the merge request. Project owners can always push and merge into the review branch. Reviewers and submitter can also merge but only if a merge request has been approved by a branch administrator and only from the merge request review page. Select the check box to disable the ability to force pushes into that branch from the command line. For more information about force pushes, refer to the - force parameter of the git push command in the Git documentation. Enter or select the user name of default reviewers. See Assigning Default Reviewers to a Repository Branch. Displays names of all project owners. When you are done, use the project navigation bar to switch to another page. Assigning Repository Branches to a Project Member You can assign multiple repository branches to a project member. When a merge request is created for the specified branch, the default reviewers are automatically added to the Reviewers list. To assign repository branches to a project member: 1. In the navigation bar, click Administration. 2. Click Branches. 3. Click the By User toggle button on the right. 4. Complete the elements using the descriptions in the table. User Repository Branches Select the member name from the list. Select the Git repository name from the list. Select the branches that you want to assign to the member. 3-38

314 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service When you are done, use the project navigation bar to switch to another page. Configuring Webhooks in Oracle Developer Cloud Service You can create Webhooks in Oracle Developer Cloud Service that send notifications to registered remote services about internal events such as a Git push, an issue update, a merge request update, or a build completion. You must be assigned the Owner role of the project to create a Webhook. Topics About Webhooks About Webhooks Creating a Generic Webhook Creating a GitHub Compatible Webhook Creating a HipChat Webhook Creating a Hudson/Jenkins Build Trigger Webhook Creating a Hudson/Jenkins Git Plugin Webhook Creating a Jenkins Merge Request Webhook Creating a Jenkins Notification Plugin Webhook Creating an Oracle Social Network Webhook Creating a Slack Webhook Editing a Webhook Data Structure of a Generic Webhook Using Webhooks you can send information to other applications immediately when an event occurs. You can trigger a Webhook for an event such as a Git push, an issue update, or a project build. When you create a Webhook, you specify a Webhook provider. The Webhook provider, when triggered, processes the event, sets the properties that are used to generate the HTTP request, and dispatches the HTTP request to the target service. Webhooks in Oracle Developer Cloud Service support only HTTP/HTTPS communication. You can create the following types of Webhooks in Oracle Developer Cloud Service: Generic Webhook GitHub compatible Webhook HipChat Webhook Hudson/Jenkins Webhook Hudson/Jenkins Build Trigger Webhooks Jenkins Build Notification Webhook Oracle Social Network Webhook 3-39

315 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service Slack Webhook About the Webhooks Page From the Webhooks page, you can create and manage webhooks that send information to other applications. What You See on the Webhooks Page The following table describes the key information and elements shown on the Webhooks page. New Webhook Webhook list Test Logs Activate / Deactivate Delete Create a webhook. Displays all existing webhooks of the project. Select a webhook to view or edit its details. Click Click to test the selected webhook. to delete the webhook. Click to view logs of the request and response logs of the selected webhook. Click to activate or deactivate the selected webhook. Click to delete the selected webhook. Creating a Generic Webhook A generic Webhook sends a POST request to the remote service in JSON format with details of the subscribed internal events. The generic Webhook supports all possible events of Oracle Developer Cloud Service, including Git pushes, issue updates, merge request updates, and project builds. To create a generic Webhook: 1. In the navigation bar, click Administration. 2. Click Webhooks. 3. Click New Webhook. 4. Complete the elements using the descriptions in the table. Type Name Active URL Secret Ignore SSL Errors Select Generic as the Webhook provider type. Enter a unique name of the Webhook. Deselect the check box to disable the Webhook. Enter the URL of the remote service where you want to deliver the HTTP request. Enter a secret phrase that is passed as a string with the HTTP request as a signature header. Select the check box if you want to ignore the host s SSL certificate verification when delivering the HTTP request. 3-40

316 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service Event Groups Events Select the desired option button that determines what events trigger the Webhook. Just the Git push event: The Webhook is triggered for Git push events only. Monitor all events: The Webhook is triggered for all events. Select specific events: Enables you to specify events in Events that will trigger the Webhook. If you have chosen the Select specific events option button in Event Groups, select or deselect the check boxes of the desired events that will trigger the Webhook. You can trigger the Webhook for the following events: Activity added The event is triggered when a new Activity is added to the list of project activities. The Activity List is displayed on the Project page. You can use theactivity added event to create the Activity List in the Home page in your desired software. Activity added events do not contain all information describing the actual event, but have enough data required to create a user readable message. Build Finished The event is triggered when a build of the specified job is successful. Git Push The event is triggered when changes are pushed to the remote branch of the Git repository. Issue Updated The event is triggered when an issue is updated. Merge Request Created/Updated The event is triggered when a merge request is created or updated. 5. Click Done. The newly created Webhook appears in the Webhooks table. To learn more about the data structure of a generic Webhook, see Data Structure of a Generic Webhook. When you are done, use the project navigation bar to switch to another page. Creating a GitHub Compatible Webhook The GitHub compatible Webhook sends a POST request to the remote service with details of the subscribed events. The POST payload mimics the data format of a GitHub Webhook and may not contain information on all Oracle Developer Cloud Service events. For more information about GitHub Webhooks, see To create a GitHub Compatible Webhook: 1. In the navigation bar, click Administration. 2. Click Webhooks. 3. Click New Webhook. 3-41

317 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service 4. Complete the elements using the descriptions in the table. Type Name Active URL Secret Payload Type Ignore SSL Errors Event Groups Events Select GitHub Compatible as the Webhook provider type. Enter a unique name of the Webhook. Deselect the check box to disable the Webhook. Enter the URL of the remote service where you want to deliver the HTTP request. Enter a secret phrase that is passed as a string with the HTTP request as a signature header. Select the media type for the payload. You can choose either form urlencoded (default) or json. Select the check box if you want to ignore the host s SSL certificate verification when delivering the HTTP request. Select the desired option button that determines what events trigger the Webhook. Just the Git push event: The Webhook is triggered for Git push events only. Monitor all events: The Webhook is triggered for all events. Select specific events: Enables you to specify events in Events that will trigger the Webhook. If you have chosen the Select specific events option button in Event Groups, select or deselect the check box of the desired events that will trigger the Webhook. You can trigger the Webhook for the following events: Git Push The event is triggered when changes are pushed to the remote branch of the Git repository. Issue Commented The event is triggered when a comment is added to an issue. Issue Updated The event is triggered when an issue is updated. 5. Click Done. When you are done, use the project navigation bar to switch to another page. Creating a HipChat Webhook HipChat is a web service for internal and private chat for teams. You can create a HipChat Webhook to send the Oracle Developer Cloud Service events and activities to HipChat rooms. For more information about HipChat, see To create a HipChat Webhook: 1. In the navigation bar, click Administration. 2. Click Webhooks. 3. Click New Webhook. 4. Complete the elements using the descriptions in the table. 3-42

318 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service Type Name Active URL Room Id Auth Token Select HipChat as the Webhook provider type. Enter a unique Webhook name. Deselect the check box to disable the Webhook. Enter the HipChat URL of the Hipchat service. Enter the numeric ID of the target room. Set the generated authentication token for accessing the room by third party services. You can generate the token in the Tokens section of the HipChat Room configuration. The token must have Send Notifications scope enabled. Subscribe Select the desired option button that determines what events trigger the Webhook. Events 5. Click Done. Failed Builds: The Webhook is triggered for all failed builds only. All events: The Webhook is triggered for all events. Specific events: Enables you to specify events in Events that will trigger the Webhook. If you have chosen the Select specific events option button in Event Groups, select or deselect the check boxes of the desired events that will trigger the Webhook. You can trigger the Webhook for the following events: Build The event is triggered when a build starts or ends. Select the Failed Builds Only check box to trigger the Webhook if the build fails. Deployment The event is triggered when a deployment occurs. Git Push The event is triggered when changes are pushed to the Git repository. Issue Created/Updated The event is triggered when an issue is created or updated. Merge Request Created/Updated event The event is triggered when a merge request is created or updated. Project Membership Created/Updated event The event is triggered when a member is added or the member s role is updated. Repository Created/updated event The event is triggered when a repository is created or updated. Wiki Created/Updated event The event is triggered when a wiki page is created or updated. Creating a Hudson/Jenkins Build Trigger Webhook You can configure an Oracle Developer Cloud Service Webhook to trigger builds of a target job on a remote Hudson or Jenkins server. Tutorial Before you enable this Webhook, you must configure the job and enable the remote trigger option on target Hudson/Jenkins server. See the respective documentation to know more on how to do that. 3-43

319 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service To create a Hudson/Jenkins - Build Trigger Webhook: 1. In the navigation bar, click Administration. 2. Click Webhooks. 3. Click New Webhook. 4. Complete the elements using the descriptions in the table. Type Name Active Build Server URL Ignore SSL Errors Job Name Build Server Security Authentication User ID API Token Select Hudson/Jenkins - Build Trigger as the Webhook provider type. Enter a unique Webhook name. Deselect the check box to disable the Webhook. Enter the URL of the target build server (Hudson or Jenkins). If the target build job has address my_job, then enter in this field. Select the check box to ignore the SSL errors if the target build server uses self-signed (or otherwise invalid) certificate and you have provided an HTTPS URL in Build Server URL. Enter the case sensitive name of the job on the target build server. If the target job is my_job, then enter my_job in this field. If the target job contains spaces (example, my job), use the same name (example, my job) in this field. Set the job s security schema configured on the target server. No Security: Select if the security is completely disabled on the target build server. Jobs can be started without checking the Remote Build Trigger support in Build Trigger section. Anonymous Access: Select if an anonymous user is able to trigger a build on the target build server. API Token Access: Select if the build can be triggered using build server API as an user. Make sure the user has sufficient build permissions (as in Anonymous Access) to run the build. Build Token Root Plugin: Select if the Build Token Root Plugin is installed at the target Jenkins server.this is the preferred way of triggering secured builds. For more information about Jenkins Build Token Root Plugin, see +Token+Root+Plugin. Enter the user ID, password, or API token required by the Hudson or the Jenkins API. Enter the user ID of the target server to make authentication calls. The option is also available if API Token Access option is selected as Build Server Security. Enter the API token of the target server to make authentication calls. In Jenkins, you can find the API token after logging in, open the user menu, and select Configure. In the Configure page, in API Token section, if necessary click Show API Token. You can copy the token from the API Token field. The option is also available if API Token Access option is selected as Build Server Security. 3-44

320 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service Remote Build Token Enter the target server s authentication token from theauthentication Token field of the target job. Example: The option is also available if Anonymous Access, API Token Access, or Build Token Root Plugin option is selected as Build Server Security. Trigger Event: Git Push Repository Follow Parameterized Build Target URL Specify the Git repository that will trigger the Webhook. Select All branches (pushes to any branch) to trigger the Webhook on an update to any branch of the repository. Select Branch (pushes to one specific branch) to trigger the Webhook on a specific branch of the repository. Enter the branch name in Branch/Tag Name. Select Tag (forced updates of one specified tag) to trigger the Webhook on forced updates on a specific tag of the repository. Enter the tag name in Branch/Tag Name. Select the check box if the build job on target server is accepts parameters. The target URL differs for parametrized and nonparametrized builds. If the Parametrized Build is enabled, you can add build parameters using the Add Parameter button. For each parameter, set the name that must match the parameter name defined on build server side. Displays the URL which will be used use to trigger the build on the target server. You can use this value to check your configuration (for example using curl -X GET '<Test URL>). 5. Click Done. Tip: If you want to use API Token Access and do not want Oracle Developer Cloud Service Webhook to get full access to your server, then create a user dedicated to starting builds. Give the user Overall/Read, Job/Read and Job/ Build permissions, and then use this users s User ID/API Token (or username/password if you are using Hudson) in Webhook s Authentication section. When you are done, use the project navigation bar to switch to another page. 3-45

321 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service Creating a Hudson/Jenkins Git Plugin Webhook The Hudson/Jenkins - Git Plugin Webhook uses a GET request to notify the Hudson or the Jenkins server to start build jobs. Using the Hudson/Jenkins - Git Plugin Webhook, you can send notifications to an external Hudson or Jenkins server to automatically trigger build jobs when the specified project Git repository is updated. Before you create the Webhook, ensure that the Hudson or the Jenkins Git Plugin is installed and running on the server. You must also make sure the build jobs that you want to trigger have the SCM polling enabled. See Configuring Build Triggers. When the Git plugin of the Webhook receives a push notification, it goes through all jobs that have SCM polling enabled and match the provided notification parameters (such as Git repositories and branches). For all the matching jobs, the polling is triggered identifying the changes made to the Git repository and then starts a build. The build would not run if no changes were found by polling. For more information about the Jenkins Git plugin, see display/jenkins/git+plugin#gitplugin-pushnotificationfromrepository. For more information about the Hudson Git plugin, see HUDSON/Git+Plugin#GitPlugin-PostCommitHook. To create a Hudson/Jenkins - Git Plugin Webhook: 1. In the navigation bar, click Administration. 2. Click Webhooks. 3. Click New Webhook. 4. Complete the elements using the descriptions in the table. Type Name Active Notification URL Notification Parameters Select Hudson/Jenkins - Git Plugin as the Webhook provider type. Enter a unique Webhook name. Deselect the check box to disable the Webhook. Enter the URL of the target Hudson/Jenkins server with enabled Hudson/Jenkins Git plugin. The URL must be in the following format: In Repository URL Type, select HTTP Repository Address to send the HTTP URL of the selected Git repository in the Webhook notification. Select SSH Repository Address to send the SSH URL of the selected Git repository in the Webhook notification. You must specify the same protocol that is used in your Hudson/ Jenkins job configuration to access the Git repository. In Append, select the sha1 (Jenkins only) check box to append the SHA-1 Checksum hash of the last commit in the Webhook notification. Select the branches check box to append branch information of the last commit in the Webhook notification. This enables jobs to poll the specified branches only. 3-46

322 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service Repository Branch Specify the Git repository that will trigger the Webhook. Specify the branch of the Repository that will trigger the Webhook. 5. Click Done. When you are done, use the project navigation bar to switch to another page. Creating a Jenkins Merge Request Webhook You can create a Webhook to link a Jenkins job of an external Jenkins server as a linked build in a merge request. When a commit is pushed to the review branch of an active merge request, the Webhook sends a notification to the external Jenkins server to trigger a build of the linked job and then receives a notification when the build is complete or fails. Based on the build s status, the linked build approves or rejects the merge request. The Jenkins Merge Request is an outgoing as well as an incoming webhook. To trigger a build on an external Jenkins server and link the Jenkins job to as a linked build of a merge request, you need to do the following: 1. Create and configure a job on the external Jenkins server to accept parameters from the Oracle Developer Cloud Service webhook 2. Create and configure a Jenkins Merge Request Webhook in Oracle Developer Cloud Service 3. Add the Jenkins job as a linked build in the merge request The Jenkins Merge Request Webhook, Jenkins job, and the Merge Request must be configured to use the same Git repository. Configuring the Job on an External Jenkins Server Create and configure a Jenkins job to accept build parameters from the Webhook that will trigger the job. 1. Create a job on the external Jenkins server. 2. In the Job Notification section, select the This project is parameterized check box, add a String Parameter, enter the GIT_REPO_BRANCH build parameter in the Name field, and enter master in the Default Value field. 3. In the Source Code Management section, select Git as the repository type, in Repository URL enter the Oracle Developer Cloud Service project Git repository URL that contains the review branch of the Merge Request, and enter the $ {GIT_REPO_BRANCH} parameter name in the Branch Specifier field. 4. In the Build Triggers section, select the Trigger builds remotely (e.g., from scripts) check box, and specify a unique authentication token name in the Authentication Token field. 5. Continue to configure the job as desired. 6. Click Save. Configuring the Jenkins Merge Request Webhook in Oracle Developer Cloud Service 1. Open the project. 3-47

323 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service 2. In the navigation bar, click Administration. 3. Click Webhooks. 4. Click New Webhook. 5. Complete the elements using the descriptions in the table. Type Name Active Build Server URL Ignore SSL Errors Job Name Repository Build Server Security Authentication User ID API Token Select Jenkins - Merge Requests as the Webhook provider type. Enter a unique Webhook name. Deselect the check box to disable the Webhook, if required. Enter the URL of the target build server. If the target build job has address my_job, then enter in this field. Select the check box to ignore the SSL errors if the target build server uses self-signed (or otherwise invalid) certificate and you have provided an HTTPS URL in Build Server URL. Enter the case sensitive name of the job on the target build server. If the target job is my_job, then enter my_job in this field. If the target job contains spaces (example, my job), use the same name (example, my job) in this field. Select the project Git repository that contains the review branch. Set the job s security schema configured on the target server. No Security: Select if the security is completely disabled on the target build server. Jobs can be started without checking the Remote Build Trigger support in Build Trigger section. Anonymous Access: Select if an anonymous user is able to trigger a build on the target build server. API Token Access: Select if the build can be triggered using build server API as an user. Make sure the user has sufficient build permissions (as in Anonymous Access) to run the build. Build Token Root Plugin: Select if the Build Token Root Plugin is installed at the target Jenkins server. This is the preferred way of triggering secured builds. For more information about Jenkins Build Token Root Plugin, see +Token+Root+Plugin. Enter the user ID, password, or API token required by the Jenkins API if you selected API Token Access as the Build Server Security. Enter the user ID of the target server to make authentication calls. The option is also available if API Token Access option is selected as Build Server Security. Enter the API token of the target server to make authentication calls. In Jenkins, you can find the API token after logging in, open the user menu, and select Configure. In the Configure page, in API Token section, if necessary click Show API Token. You can copy the token from the API Token field. The option is also available if API Token Access option is selected as Build Server Security. 3-48

324 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service Remote Build Token Notification Auth Token URL Enter the target Jenkins server s authentication token from theauthentication Token field of the target job. The option is also available if Anonymous Access, API Token Access, or Build Token Root Plugin option is selected as Build Server Security. URL to be used for the Notification Endpoint URL in the Job Notifications section of the external Jenkins job. Displays the authentication token of the Webhook to be given to the Jenkins job for sending back notifications. The Auth Token is automatically appended at the end of the URL field s value. Displays the HTTP URL of the Webhook with the Auth Token value. You must provide the URL in the Notification Endpoint on the target Jenkins server to receive build notifications from the Jenkins server to Oracle Developer Cloud Service. Click to select the entire URL. The URL is available after you save the Webhook and can be copied after selecting the created Webhook in the Webhooks page. 6. Click Done. 7. On the Webhooks page, select the webhook, and click Test to test it. Click Logs to see the Request and Response logs. 8. On the external Jenkins server, open the job configuration page and add a notification endpoint. 9. In the URL field of the notification endpoint, copy the value of the URL field of the webhook. 10. Click Save. Linking the Jenkins Job with a Merge Request In Oracle Developer Cloud Service, open the merge request of the review branch, open the Linked Build tab, and select the Jenkins job name in the Search and Link Build jobs list. See Linking Builds to a Merge Request. When a commit is pushed to the review branch of the merge request, the webhook will trigger a build of the specified job on the remote Jenkins server and notification is posted on the Recent Activity Feed of the project. If the build succeeds, it is added to the Approve section of the Review Status list in the Merge Request page. If the build fails, it is added to the Reject section of the Review Status list. Creating a Jenkins Notification Plugin Webhook The Jenkins - Notification Plugin Webhook accepts build notifications from the remote Jenkins build server and shows the build notification in Oracle Developer Cloud Service. Note that this is an incoming Webhook and accept build notifications only. Do not use this Webhook to pass information to any external server or accept information of any other type. To create a Jenkins - Notification Plugin Webhook: 1. In the navigation bar, click Administration. 3-49

325 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service 2. Click Webhooks. 3. Click New Webhook. 4. Complete the elements using the descriptions in the table. Type Name Active Auth Token URL Select Jenkins - Notification Plugin as the Webhook provider type. Enter a unique Webhook name. Deselect the check box to disable the Webhook. Displays the authentication token of the Webhook to be given to the Jenkins job for sending back notifications. The Auth Token is automatically appended at the end of the URL field s value. Displays the HTTP URL of the Webhook with the Auth Token value. You must provide the URL in the Notification Endpoint on the target Jenkins server to receive build notifications from the Jenkins server to Oracle Developer Cloud Service. Click to select the entire URL. The URL is available after you save the Webhook and can be copied after selecting the created Webhook in the Webhooks page. Example: Create Activity Stream Record Base URL Track Enter the base URL of the target Jenkins build server. If the target build job has address path/job/my_job then enter in this field. Configure which build job actions are shown in the Recent Activity Feed of the Project page. Select the Build Results check box to create an activity feed in the Recent Activity Feed of the Project page after the build server job is finished. The action is followed by Job Finalized event. Select the Ongoing Builds check box to create an activity feed of ongoing builds and stay there until the build server job is finished. The action is followed by the Job Started event or the Job Finalized event. 3-50

326 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service 5. Click Done. To receive notifications from the remote Jenkins server: 1. In the remote Jenkins Build server, install and configure the Notification Plugin. For more information about the notification mechanism, see 2. In Oracle Developer Cloud Service, create the Jenkins Notification Webhook. 3. In the remote Jenkins server, create a job. 4. In the remote Jenkins server job configuration, create a notification end point. 5. Configure the remote Jenkins Build job notification endpoint. Note the notification endpoints of the remote server: Format: JSON Protocol: HTTP URL: generated URL address from the Oracle Developer Cloud Service Webhook URL field Event: All events Log: 0 - log field is ignored by the Webhook 6. Save the job configuration in the remote server. Next time, you run the job build in the remote Jenkins server, you will receive a notification in the Oracle Developer Cloud Service project. When you are done, use the project navigation bar to switch to another page. Creating an Oracle Social Network Webhook You can create an Oracle Social Network (OSN) Webhook to send the Oracle Developer Cloud Service events and activities to the OSN conversations. Before you create an OSN Webhook, you must first set up an Oracle Developer Cloud Service Incoming Webhook in OSN and associate it with an OSN Conversation. If you do not have access to the OSN Administration, contact the OSN Administrator to set up the Incoming Webhook in OSN. When set up, the Incoming Webhook will provide a URL with an authentication token that you will use in the OSN Webhook of your project. See You can also set up the OSN functionality for Oracle Public Cloud from Oracle Content and Experience Cloud. The Oracle Content and Experience Cloud Administrator can create an incoming Webhook integration, associate it with an OSN conversation, and get the URL with an authentication token that you will use in the OSN Webhook of your project. See Configuring Webhooks in Administering Oracle Content and Experience Cloud. To create an OSN Webhook: 1. In the navigation bar, click Administration. 2. Click Webhooks. 3. Click New Webhook. 4. Complete the elements using the descriptions in the table. 3-51

327 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service Type Name Active OSN URL Auth Token Event Groups Events Select Oracle Social Network as the Webhook provider type. Enter a unique Webhook name. Deselect the check box to disable the Webhook. Enter the OSN Webhook URL (without the authentication token) where the Webhook receiver is registered. Set the generated authentication token for accessing the OSN Webhook receiver. Select the desired option button that determines what events trigger the Webhook. Failed Builds: The Webhook is triggered for all failed builds only. All events: The Webhook is triggered for all events. Specific events: Enables you to specify events in Events that will trigger the Webhook. If you have chosen the Select specific events option button in Event Groups, select or deselect the check boxes of the desired events that will trigger the Webhook. You can trigger the Webhook for the following events: Build The event is triggered when a build starts or ends. Select the Failed Builds Only check box to trigger the Webhook if the build fails. Deployment The event is triggered when a deployment occurs. Git Push The event is triggered when changes are pushed to the Git repository. Issue Created/Updated The event is triggered when an issue is created or updated. Merge Request Created/Updated event The event is triggered when a merge request is created or updated. Project Membership Created/Updated event The event is triggered when a member is added or the member s role is updated. Repository Created/updated event The event is triggered when a repository is created or updated. Wiki Created/Updated event The event is triggered when a wiki page is created or updated. 5. Click Done. Creating a PagerDuty Webhook Using the PagerDuty webhook, you can send notifications to your PagerDuty service about events in Oracle Developer Cloud Service. PagerDuty is an incident 3-52

328 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service management platform that enables you to send notifications via , push, SMS, and phone. When your PagerDuty service receives notifications from Oracle Developer Cloud Service, it can redirect those notifications via , push, SMS, and phone. For more information, see Before you create the webhook, create an API key, add a service, and add users in your PagerDuty service. See the PagerDuty documentation for more information. To create a PagerDuty webhook: 1. In the navigation bar, click Administration. 2. Click Webhooks. 3. Click New Webhook. 4. Complete the elements using the descriptions in the table. Type Name Active API Key Service Sender Subscribe Events Select PagerDuty as the Webhook provider type. Enter a unique Webhook name. Deselect the check box to disable the Webhook. Enter the API key of the PagerDuty service. You can create or view the API Key in the API Access Keys page of the PagerDuty service. See the PagerDuty documentation for more information. Select the desired PagerDuty service from the list. The webhook will send event notifications to the selected service. Select the PagerDuty registered user whose name will be attached to the events sent by the webhook. Select the desired option button that determines what events trigger the Webhook. Failed Builds: The Webhook is triggered for all failed builds only. All events: The Webhook is triggered for all events. Specific events: Enables you to specify events in Events that will trigger the Webhook. If you have chosen the Select specific events option button in Event Groups, select or deselect the check boxes of the desired events that will trigger the Webhook. You can trigger the Webhook for the following events: Build The event is triggered when a build starts or ends. Select the Failed Builds Only check box to trigger the Webhook if the build fails. Deployment The event is triggered when a deployment occurs. The event includes the Start and Stop commands to start and stop the application. 5. Click Done. 3-53

329 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service Creating a Slack Webhook Slack is a Cloud based team collaboration software. You can create a Slack Webhook to send the Oracle Developer Cloud Service events and activities to a Slack channel. For more information about Slack, see 1. In the navigation bar, click Administration. 2. Click Webhooks. 3. Click New Webhook. 4. Complete the elements using the descriptions in the table. Type Name Active URL Select Slack as the Webhook provider type. Enter a unique Webhook name. Deselect the check box to disable the Webhook. Enter the Slack incoming Webhook URL in the hooks.slack.com/services/... format. To request the Slack incoming Webhook URL: a. Open to the Slack Apps and Integrations page. b. Search for Incoming Webhooks c. Add a Slack Custom Incoming Webhook configuration and select the Slack channel you would like the Webhook to post to. d. Open the Configuration page and copy the URL associated with the Webhook. Later, if required, you can change the channel used by the Webhook from the Configuration page. It is not necessary to change any other Webhook configuration properties. The current Webhook properties will be set by the notifications sent from Oracle Developer Cloud Service. Subscribe Select the desired option button that determines what events trigger the Webhook. Failed Builds: The Webhook is triggered for all failed builds only. All events: The Webhook is triggered for all events. Specific events: Enables you to specify events in Events that will trigger the Webhook. 3-54

330 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service Events If you have chosen the Select specific events option button in Event Groups, select or deselect the check boxes of the desired events that will trigger the Webhook. You can trigger the Webhook for the following events: Build The event is triggered when a build starts or ends. Select the Failed Builds Only check box to trigger the Webhook if the build fails. Deployment The event is triggered when a deployment occurs. Git Push The event is triggered when changes are pushed to the Git repository. Issue Created/Updated The event is triggered when an issue is created or updated. Merge Request Created/Updated event The event is triggered when a merge request is created or updated. Project Membership Created/Updated event The event is triggered when a member is added or the member s role is updated. Repository Created/updated event The event is triggered when a repository is created or updated. Wiki Created/Updated event The event is triggered when a wiki page is created or updated. 5. Click Done. Editing a Webhook After creating a Webhook, you can edit its properties and view its logs. To edit a Webhook: 1. In the navigation bar, click Administration. 2. Click Webhooks. 3. Select the Webhook in the Webhooks table. 4. Edit the properties of the selected Webhook on the right. 5. To view the logs, click Show Logs. Click Test to test the connection with the remote server and see the Request and Response logs. Click Refresh to view the latest log. To delete a Webhook, mouse over the Webhook in the Webhook table, and click. When you are done, use the project navigation bar to switch to another page. Data Structure of a Generic Webhook The information sent by a generic Webhook is delivered using a POST request with the application/json content-type, with the UTF-8 character set, in a Message object. The following table describes the fields of the Message object. 3-55

331 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service Field apiversion messageid timestamp testevent projectid events Version of the API. It changes when the payload format of the request changes. Unique identifier of the message Timestamp of the message when it was generated Set to true if this event is generated by the Test button Unique identifier of the project List of events delivered by the message Each event delivered by the message follows a common structure. There are three types of events (ISSUE/PUSH/BUILD/REVIEW/ACTIVITY). Field eventid projectid timestamp data Type of the event (ISSUE/PUSH/BUILD/REVIEW/ACTIVITY) Unique identifier of the project Timestamp of the event Data specific to the type of the event The structure of data of each event type is described in the following sections. ISSUE Event The ISSUE event contains the fields described in the following table. Field type date description task id version url title type resolution reporter asignee comment fieldupdates Type of the activity (CREATED - issue is created, COMMENTED - comment added, UPDATED - fields changed) Timestamp of the activity of the change of the issue after the change Issue ID Change version URL of the issue Title of the issue Type of the issue (Defect, Feature, or Task) Resolution of the issue. The value is null if the issue is not resolved, otherwise, it is set to one of the issue resolution values such as FIXED, DUPLICATE, and WORKSFORME. User who reported the issue User to whom the issue is assigned Content of the added comment, available if the activity type is COMMENTED List of changed fields, available if the activity type is UPDATED 3-56

332 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service Field name oldvalue newvalue Field name Value before the change Value after the change Here is a JSON payload example of an issue create event. { "apiversion": "1.0", "messageid": "04abc282-a44e-4c23-ba53-15b519d30066", "projectid": "qa-dev_example-project", "testevent": false, "timestamp": , "events": [ { "eventid": "ISSUE", "projectid": "example-project", "timestamp": , "data": { "activities": [ { "type": "CREATED", "date": , "description": "", "author": { "gravatarhash": " abebbc5d8d84e37af7161fd31", "loginname": "alex.admin", "realname": "Alex Admin" }, "issue": { "id": 2, "resolution": null, "title": "Test Issue", "type": "Feature", "url": " task/2", "version": " ", "reporter": { "gravatarhash": " abebbc5d8d84e37af7161fd31", "loginname": "alex.admin", "realname": "Alex Admin" } } } ] } } ] } Here is a JSON payload example of an issue update event. { "apiversion": "1.0", "messageid": "ccce183e-097d-4668-a07b-cf e", "projectid": "qa-dev_example-project", "testevent": false, "timestamp": , 3-57

333 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service "events": [ { "eventid": "ISSUE", "projectid": "example-project", "timestamp": "data": { "activities": [ { "type": "UPDATED" "date": , "description": "Assign to alex.admin\nset Resolution to FIXED \nset Status to RESOLVED\n", "author": { "gravatarhash": " abebbc5d8d84e37af7161fd31", "loginname": "alex.admin", "realname": "Alex Admin" }, "issue": { "id": 2, "resolution": "FIXED", "title": "Test Issue", "type": "Feature", "url": " task/2", "version": " ", "asignee": { "gravatarhash": " abebbc5d8d84e37af7161fd31", "loginname": "alex.admin", "realname": "Alex Admin" }, "reporter": { "gravatarhash": " abebbc5d8d84e37af7161fd31", "loginname": "alex.admin", "realname": "Alex Admin" } }, "fieldupdates": [ { "name": "assigned_to", "newvalue": "alex.admin", "oldvalue": "" }, { "name": "resolution", "newvalue": "FIXED", "oldvalue": "" }, { "name": "bug_status", "newvalue": "RESOLVED", "oldvalue": "UNCONFIRMED" } ] }, { "type": "COMMENTED" "date": , "description": "Feature is implemented", "author": { "gravatarhash": " abebbc5d8d84e37af7161fd31", "loginname": "alex.admin", 3-58

334 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service "realname": "Alex Admin" }, "comment": { "author": { "gravatarhash": " abebbc5d8d84e37af7161fd31", "loginname": "alex.admin", "realname": "Alex Admin" }, "date": , "text": "Feature is implemented", "type": "UNKNOWN" }, "task": { "id": 2, "resolution": "FIXED", "title": "Test Issue", "type": "Feature", "url": " ] } } ] } PUSH Event } } "version": " ", "asignee": { "gravatarhash": " abebbc5d8d84e37af7161fd31", "loginname": "alex.admin", "realname": "Alex Alex Admin" }, "reporter": { "gravatarhash": " abebbc5d8d84e37af7161fd31", "loginname": "alex.admin", "realname": "Alex Admin" } The PUSH event contains the fields described in the following table. Field refname commits sha comment author date parents repository Updated references Commits of the Push event Commit identifier Comment in the commit Author of the commit Timestamp of the commit List of commit parent identifiers Name of the repository to which the commit was pushed Here is a JSON payload example of a Git Push event. { "apiversion": "1.0", 3-59

335 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service "messageid": "c3378be6-6be b20-1fb5d429bfce", "projectid": "example-project", "testevent": false, "timestamp": , "events": [ { "eventid": "GIT_PUSH", "projectid": "example-project", "timestamp": , "data": { "refname": "refs/heads/master", "commits": [ { "sha": "32e03bc46a3a42eeab5dd25144a90c5b4f0b2e11", "repository": "example-project.git", "date": , "comment": "file1.txt deleted, file3.txt created\n", "author": { " ": "alex.admin@example.com", "firstname": "Alex", "lastname": "Admin", "username": "alex.admin" }, "parents": [ "1106e8c81cb49e71024e f89dc3983d4ee" ] }, { "sha": "1106e8c81cb49e71024e f89dc3983d4ee", "repository": "example-project.git", "date": , "comment": "file2.txt updated\n", "author": { " ": "alex.admin@example.com", "firstname": "Alex", "lastname": "Admin", "username": "alex.admin" }, "parents": [ "8dab56fb6ba6dd0fc0d0aa8c7ce4f01d77fa0835" ] } ] } } ] } BUILD Event The BUILD event contains the fields described in the following table. Field jobname timestamp number url Name of the job Build timestamp Build number Build URL 3-60

336 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service Field result duration filename relativepath url Build result (SUCCESS/UNSTABLE/FAILURE/NOT_BUILT/ABORTED) Build duration Name of the artifact Path relative to the job workspace URL of the artifact Here is a JSON payload example of a Build event. { "apiversion":"1.0", "messageid":"4a a4b5-aac30d0b9710", "timestamp": , "testevent":true, "projectid":"test-project", "events":[ { "eventid":"build", "projectid":"test-project", "timestamp": , "data":{ "jobname":"example-job", "details":{ "timestamp": , "number":16, "url":" "result":"success", "duration":36905, "artifacts":[ { "filename":"sample-1.0-snapshot.jar", "relativepath":"sample-project/target/sample-1.0-snapshot.jar", "url":" } ] } } } ] } REVIEW Event The REVIEW event represents changes in Merge Requests and contains the fields described in the following table. Field review id title created of the merge request Unique ID of the merge request Title of the merge request Timestamp of the merge request creation 3-61

337 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service Field modified reporter repository reviewbranch targetbranch user action commits text comment result status Timestamp of the merge request last modification Profile of the user who created the merge request Name of the Git repository Name of the review branch Name of the target branch Profile of the user who performed the action Merge request action Here is the list of merge request actions: CREATED: Merge request is created COMMIT: New commits are pushed to the review branch MERGED: Review branch is merged into the target branch The MERGED action is created if the review branch is merged via the Merge button in the web user interface. If the review branch is merged from a Git client (such as the Git command line interface), no action is generated. REVIEWED: Reviewer approves or rejects a merge request COMMENTED: A comment is added to the merge request CLOSED: Merge request is closed List of commits added to the merge request The commits field is generated for the COMMIT action. The following fields are also generated for the commits action: author: Author of the commit message: Commit message sha: SHA-1 checksum hash of the commit Text of the comment The text field is generated for the COMMENTED action. Comment of the rejected or approved review action The comment field is generated for the REVIEWED action. Result of the merge (FAST_FORWARD, FAST_FORWARD_SQUASHED, ALREADY_UP_TO_DATE, FAILED, MERGED, MERGED_SQUASHED, MERGED_SQUASHED_NOT_COMMITTED, CONFLICTING, ABORTED, MERGED_NOT_COMMITTED, NOT_SUPPORTED, CHECKOUT_CONFLICT) The result field is generated for the MERGED action. Status of the merge request (APPROVED, REJECTED, COMPLETED, CANCELLED) The status field is generated for the REVIEWED and the CLOSED action. Here is a JSON payload example of a REVIEW event. { "apiversion": "1.0", "events": [ { "data": { "action": "CREATED", "review": { "created": , "id": 6, 3-62

338 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service } "modified": , "reporter": { " ": "alex.admin@example.com", "firstname": "Alex", "lastname": "Alex Admin", "username": "alex.admin" }, "repository": "example-project.git", "reviewbranch": "bug_branch", "targetbranch": "master", "title": "Bug Fix" }, "user": { " ": "alex.admin@example.com", "firstname": "Alex", "lastname": "Alex Admin", "username": "alex.admin" } }, "eventid": "REVIEW", "projectid": "example-project", "timestamp": } ], "messageid": " e4e7-4c8f-b9fe-7b74f715803f", "projectid": "example-project", "testevent": false, "timestamp": { "apiversion": "1.0", "events": [ { "data": { "action": "COMMIT", "commits": [ { "author": "alex.admin", "message": "fix version #3\n", "sha": "8fd1d2a53a181aa7015e7535b6f64295c432eca7" }, { "author": "alex.admin", "message": "fix version #2\n", "sha": "ff2bdf91d0fb6fb ec38acc0931beeb6" } ], "review": { "created": , "id": 6, "modified": , "reporter": { " ": "alex.admin@example.com", "firstname": "Alex", "lastname": "Alex Admin", "username": "alex.admin" }, "repository": "example-project.git", "reviewbranch": "bug_branch", 3-63

339 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service } { } "targetbranch": "master", "title": "Bug Fix" }, "user": { " ": "alex.admin@example.com", "firstname": "Alex", "lastname": "Alex Admin", "username": "alex.admin" } }, "eventid": "REVIEW", "projectid": "example-project", "timestamp": } ], "messageid": "5de98d08-49cd-4a19-86b5-d89757f75a1d", "projectid": "example-project", "testevent": false, "timestamp": "apiversion": "1.0", "events": [ { "data": { "user": { " ": "clara.coder@example.com", "firstname": "Clara", "lastname": "Coder", "username": "clara" }, "review": { "created": , "id": 23, "modified": , "reporter": { " ": "alex.admin@example.com", "firstname": "Alex", "lastname": "Admin", "username": "alex" }, "repository": "example-project.git", "reviewbranch": "bug_branch", "targetbranch": "master", "title": "Some Review" }, "action": "REVIEWED", "status": "REJECTED", "comment": "rejected the request because...", }, "eventid": "REVIEW", "projectid": "example-project", "timestamp": } ], "messageid": "f0a dc4-be ed3", "projectid": "example-project", "testevent": false, "timestamp":

340 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service { } { "apiversion": "1.0", "events": [ { "data": { "action": "COMMENTED", "review": { "created": , "id": 6, "modified": , "reporter": { " ": "alex.admin@example.com", "firstname": "Alex", "lastname": "Alex Admin", "username": "alex.admin" }, "repository": "example-project.git", "reviewbranch": "bug_branch", "targetbranch": "master", "title": "Bug Fix" }, "text": "General comment", "user": { " ": "alex.admin@example.com", "firstname": "Alex", "lastname": "Alex Admin", "username": "alex.admin" } }, "eventid": "REVIEW", "projectid": "example-project", "timestamp": } ], "messageid": "d2a36692-dae6-44d4-a112-7a615b524cc3", "projectid": "example-project", "testevent": false, "timestamp": "apiversion": "1.0", "events": [ { "data": { "action": "MERGED", "result": "FAST_FORWARD", "review": { "created": , "id": 6, "modified": , "reporter": { " ": "alex.admin@example.com", "firstname": "Alex", "lastname": "Alex Admin", "username": "alex.admin" }, "repository": "example-project.git", "reviewbranch": "bug_branch", "targetbranch": "master", 3-65

341 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service } { } "title": "Bug Fix" }, "user": { " ": "alex.admin@example.com", "firstname": "Alex", "lastname": "Alex Admin", "username": "alex.admin" } }, "eventid": "REVIEW", "projectid": "example-project", "timestamp": } ], "messageid": "b06d5581-d38a c80-dc ", "projectid": "example-project", "testevent": false, "timestamp": "apiversion": "1.0", "events": [ { "data": { "action": "CLOSED", "review": { "created": , "id": 6, "modified": , "reporter": { " ": "alex.admin@example.com", "firstname": "Alex", "lastname": "Alex Admin", "username": "alex.admin" }, "repository": "example-project.git", "reviewbranch": "bug_branch", "targetbranch": "master", "title": "Bug Fix" }, "status": "COMPLETED", "user": { " ": "alex.admin@example.com", "firstname": "Alex", "lastname": "Alex Admin", "username": "alex.admin" } }, "eventid": "REVIEW", "projectid": "example-project", "timestamp": } ], "messageid": "b434f6d2-b5c7-4c0a-bab2-3e ", "projectid": "example-project", "testevent": false, "timestamp":

342 Chapter 3 Configuring Webhooks in Oracle Developer Cloud Service ACTIVITY Event The ACTIVITY event contains the fields described in the following table. Field author name properties Profile of the user whose action produced the activity The value is null for system activities. Name of the activity of the activity, or the object whose fields depends on the name field. Here is the list of supported activities: BUILD: Triggered when a build in the integrated Hudson server ends. DEPLOYMENT: Triggered when the application is deployed, undeployed, started, or stopped using Deploy page in the web user interface. MEMBER: Triggered when a user is added, removed, or role is updated. REVIEW: Triggered when a merge request is created, closed, or updated. RSS: Triggered when a new article is acquired from a registered feed. SCM_COMMIT: Triggered when a commit is pushed to a project repository. SCM_REPO: Triggered when a project repository is added or removed. TASK: Triggered when an issue is created or updated. WIKI: Triggered when a wiki page is created or updated. Here is a JSON payload example of an Activity event. { "apiversion": "1.0", "events": [ { "data": { "author": { " ": "alex.admin@example.com", "firstname": "Alex", "lastname": "Alex Admin", "username": "alex.admin" }, "name": "WIKI", "properties": { "page": "New Page Title", "type": "CREATED" } }, "eventid": "ACTIVITY", "projectid": "example-project", "timestamp": } ], "messageid": "45066d85-5a5c a6c-43fc8e99481a", "projectid": "qa-dev_test-rss", 3-67

343 Chapter 3 Managing ATOM/RSS Feeds in Oracle Developer Cloud Service } "testevent": false, "timestamp": Managing ATOM/RSS Feeds in Oracle Developer Cloud Service Some websites use ATOM and RSS feeds to publish news feeds or frequently updated information. You can subscribe to such ATOM/RSS feeds and monitor them in the Recent Activity feed of the Project page. You can subscribe any ATOM/RSS feed including Oracle approved RSS Feeds, News, Site monitors, and Jenkins or Hudson servers. Topics Creating an ATOM/RSS Feeds Handler Editing, Testing, and Viewing Logs of an ATOM/RSS Feeds Handler Deactivating or Deleting an ATOM/RSS Feeds Handler About the RSS/ATOM Feeds Page From the RSS/ATOM Feeds page, you can subscribe to RSS/ATOM feeds and monitor them in the Recent Activity feed of the Project page. What You See on the RSS/ATOM Feeds Page The following table describes the key information and elements shown on the RSS/ ATOM Feeds page. New Handler Handler list Test Logs Deactivate / Activate Delete Name Active URL Display Type Click to create a RSS/ATOM Feeds handler. See Creating an ATOM/RSS Feeds Handler. Lists all RSS/ATOM Feed handlers of the project. Select a handler to view or edit its details. Click to test the selected handler. Click to view request and response logs of the selected handler. Click to deactivate or activate the selected handler. Click to delete the selected handler. View or update the name of the handler. Deselect or select the check box to disable or enable the handler. View or update the URL of the feed. View or update the feed s display type: ATOM/RSS or Jenkins. 3-68

344 Chapter 3 Managing ATOM/RSS Feeds in Oracle Developer Cloud Service Fetch Interval View or update the feed s fetch interval. For the fetch interval period, the feed results are cached. All requests during the interval period retrieve the cached results. When the time expires the cache is cleared. The next request would check for the cached results and not find them and proceed to fetch a new copy to be cached. By default, the interval is set to 1 day. Creating an ATOM/RSS Feeds Handler You can create an ATOM/RSS Feeds handler in the Administration page. Note: To create an ATOM/RSS Feeds handler, you must be assigned the Owner role of the project. To create an ATOM/RSS Feeds handler: 1. In the navigation bar, click Administration. 2. Click RSS/ATOM Feeds. 3. Click + New Handler. 4. Complete the elements using the descriptions in the table. Name Active URL Display Type Fetch Interval Enter the name of the handler. Deselect the check box to disable the handler. Enter the URL of the feed that you want to include in the Recent Activity feed of the Project page. Select the feed s display type: ATOM/RSS or Jenkins. Enter the feed s fetch interval. For the fetch interval period, the feed results are cached. All requests during the interval period retrieve the cached results. When the time expires the cache is cleared. The next request would check for the cached results and not find them and proceed to fetch a new copy to be cached. By default, the interval is set to 1 day. 5. Click Done. When you are done, use the project navigation bar to switch to another page. Editing, Testing, and Viewing Logs of an ATOM/RSS Feeds Handler You can edit, test, and view logs an ATOM/RSS Handler from the Administration page. To edit, test, and view logs of an ATOM/RSS Feeds handler: 3-69

345 Chapter 3 Managing ATOM/RSS Feeds in Oracle Developer Cloud Service 1. In the navigation bar, click Administration. 2. Click RSS/ATOM Feeds. All existing feed handlers are listed in the ATOM/RSS Handlers list. 3. Click a feed handler in the ATOM/RSS Handlers list. 4. To edit the feed handler, edit the fields displayed on the right. For more information about the description of each field, see Creating an ATOM/RSS Feeds Handler. 5. To test a feeds handler, select the handler in the ATOM/RSS Handlers list, and click the Test button. If the test is successful, the status icon changes from. If the test fails, the status icon changes to. 6. To view logs of a test, select the feeds handler in the ATOM/RSS Handlers list, and click the Logs button. In the Logs page, all Request and Response logs of each test are available. Select the date-time stamp in the left list of the test to view its logs. To test the feed, click the Test button above the logs list. To refresh the open log, click Refresh. 7. Click Done to return to the RSS/ATOM Feeds page. Deactivating or Deleting an ATOM/RSS Feeds Handler You can deactivate or delete an ATOM/RSS Handler from the Administration page. To deactivate or delete an ATOM/RSS Feeds handler: 1. In the navigation bar, click Administration. 2. Click RSS/ATOM Feeds. All existing feeds handlers are listed in the ATOM/RSS Handlers list. 3. Click a feeds handler in the ATOM/RSS Handlers list. 4. To deactivate a feeds handler, click the Deactivate button on the right side of the page. The icon of the feeds handler is greyed out and the Active check box is deselected. To activate the feeds handler, click Activate or select the Active check box. To delete a feeds handler, click the Remove button on the right side of the page. You can also click the icon in the ATOM/RSS Handlers list. In the Remove ATOM/RSS Handler dialog, click Yes to confirm. to 3-70

346 Chapter 3 Exporting and Importing Project Data in Oracle Developer Cloud Service Exporting and Importing Project Data in Oracle Developer Cloud Service You can export the project data to your Oracle Cloud Infrastructure Object Storage Classic container for backup. You can then import the data into a project in Oracle Developer Cloud Service of the same or a different data center when you want. Topics Connecting to Oracle Cloud Infrastructure Object Storage Classic Exporting Project Data from Oracle Developer Cloud Service Importing Project Data to Oracle Developer Cloud Service About the Data Export/Import Page From the Data Export/Import page, you can import and export project to data to Oracle Cloud Infrastructure Object Storage Classic containers. What You See on the Data Export/Import Page The following table describes the key information and elements shown on the Data Export/Import Page. Job tab History tab Configure the connection to Oracle Cloud Infrastructure Object Storage Classic. See Connecting to Oracle Cloud Infrastructure Object Storage Classic. After configuring the connection, export project or import data in the Create Job section. See Exporting Project Data from Oracle Developer Cloud Service and Importing Project Data to Oracle Developer Cloud Service. View project s export and import history. See Viewing Export and Import History of the Project. Connecting to Oracle Cloud Infrastructure Object Storage Classic To export to or import data from the Oracle Cloud Infrastructure Object Storage Classic container, you must first create a connection. To do that, you need the credentials of an Oracle Cloud Infrastructure Object Storage Classic active user. To connect to Oracle Cloud Infrastructure Object Storage Classic: 1. In the navigation bar, click Administration. 2. Click Data Export/Import. 3. In the Job tab, enter the following details: The following table highlights the elements of the Storage Account Connection fields. 3-71

347 Chapter 3 Exporting and Importing Project Data in Oracle Developer Cloud Service Storage Service URL Storage Service Name Identity Domain Storage Account Username Storage Account Password (Required) Enter the service URL of Oracle Cloud Infrastructure Object Storage Classic. (Required) Enter the name of the Oracle Cloud Infrastructure Object Storage Classic service. Usually, it is Storage. (Required) Enter the identity domain name of the Oracle Cloud Infrastructure Object Storage Classic service. (Required) Enter the username of the user who has access to Oracle Cloud Infrastructure Object Storage Classic service. (Required) Enter the password of the Oracle Cloud Infrastructure Object Storage Classic user. You can get the values for the above fields from the REST Endpoint URL field available in the Overview tab of the Oracle Cloud Infrastructure Object Storage Classic details page. The REST Endpoint URL uses the following syntax: <storage_service_url>/v1/<storage_service_name>-<identity_domain>. For example, if the REST Endpoint URL of your service is gse storage.oraclecloud.com/v1/storage-gse , then enter the following values in the Storage Account Connection fields: Storage Service URL: Storage Service Name: Storage Identity Domain: gse Click Connect. After validating the details provided, a connection is established. You can now export to or import project data from Oracle Cloud Infrastructure Object Storage Classic. Exporting Project Data from Oracle Developer Cloud Service You can export project data to an Oracle Cloud Infrastructure Object Storage Classic container from the Oracle Developer Cloud Service project Administration page. You must be a project Owner to export data. You can export data of multiple projects to one Oracle Cloud Infrastructure Object Storage Classic container. When you export project data, the data of all issues, Git repositories, and wiki pages are exported to an archive file in the specified container, which can be imported later. To export project data from Oracle Developer Cloud Service to Oracle Cloud Infrastructure Object Storage Classic: 1. If not already created, log into the Oracle Cloud Infrastructure Object Storage Classic service and create a storage container. 2. Open your Oracle Developer Cloud Service project that you want to export. 3. In the navigation bar, click Administration. 4. Click Data Export/Import. 5. Connect to your Oracle Cloud Infrastructure Object Storage Classic service. See Connecting to Oracle Cloud Infrastructure Object Storage Classic. 6. In the Create Job section, complete the elements using the descriptions in the table. 3-72

348 Chapter 3 Exporting and Importing Project Data in Oracle Developer Cloud Service Type Name Storage Container Storage Object Select Export in the list. (Required) Enter a unique name of the export job. Enter a description of the job. (Required) Select the Oracle Cloud Infrastructure Object Storage Classic container. (Required) Enter the name of the zip file that will be exported to the Oracle Cloud Infrastructure Object Storage Classic container. 7. Click Export. 8. In the Confirm Project Export dialog, select the Export project data check box, and click Yes. 9. In the Exporting Project page, expand Steps to see the status of each module. A notification of the export action is added to the Recent Activities feed of the Project page and to the History tab of the Data Export/Import page. Importing Project Data to Oracle Developer Cloud Service You can import project data from the Oracle Cloud Infrastructure Object Storage Classic container into the Oracle Developer Cloud Service project. You must be a project Owner to import data. When you import data from Oracle Cloud Infrastructure Object Storage Classic, it overwrites all the data in the project. All issues, Git repositories, and wiki pages of the project are replaced with the components of the imported project. To import project data from Oracle Cloud Infrastructure Object Storage Classic into Oracle Developer Cloud Service: 1. Open the Oracle Developer Cloud Service project where you want to import data. 2. In the navigation bar, click Administration. 3. Click Data Export/Import. 4. Connect to your Oracle Cloud Infrastructure Object Storage Classic service. See Connecting to Oracle Cloud Infrastructure Object Storage Classic. 5. In the Create Job section, complete the elements using the descriptions in the table. Type Name Storage Container Storage Object Select Import in the list. (Required) Enter a unique name of the import job. Enter a description of the job. (Required) Select the Oracle Cloud Infrastructure Object Storage Classic container where the data was exported. (Required) Select the archive file that will be imported. 6. Click Import. 7. In the Confirm Project Import dialog, read and verify the container and object details, select the Import project data check box, and click Yes. 3-73

349 Chapter 3 Importing External Hudson Jobs to Oracle Developer Cloud Service 8. In the Importing Project page, expand Steps to see the status of each module. If you want to cancel the import process, click Cancel. When an import job is in progress, the project is in the locked state. You cannot access other pages of the project until the import job is complete. After the import is complete, you are redirected to the Project page. A notification of the import action is added to the Recent Activities feed of the Project page and to the History tab of the Data Export/Import page. Viewing Export and Import History of the Project You can view the history of project s import and export actions in the History tab of the Data Export/Import page. To view the history: 1. In the navigation bar, click Administration. 2. Click Data Export/Import. 3. Click the History tab. The history of all export and import jobs is displayed. Select a job to view its details. In the case of a failure, expand Steps to view the modules that passed and failed. Importing External Hudson Jobs to Oracle Developer Cloud Service You can create a zip file of the jobs available on your external Hudson installation and then import the jobs to the Hudson instance of your Oracle Developer Cloud Service project. Note: To import external Hudson jobs, you must be assigned the Owner role of the project. Before you import your jobs, you might want to upgrade your current Hudson installation to version to resolve any warning messages during the import. To import Hudson jobs from the existing Hudson installation to Oracle Developer Cloud Service Hudson: 1. On your Hudson installation machine, open the command line and navigate to the HUDSON_HOME/jobs directory. 2. Run the jar -cvfm <jobname>.zip */config.xml command to create a <jobname>.zip file. For example, the jar -cvfm jobs.zip */config.xml command creates a jobs.zip file. If the zip file contains community Hudson jobs, the parent directory name of the config.xml file becomes the job name when the zip file is uploaded to Oracle Developer Cloud Service. 3-74

350 Chapter 3 Importing External Hudson Jobs to Oracle Developer Cloud Service 3. In the zip file, confirm the following: The job file name does not contain a period (.) character. Usually, old Hudson jobs contain a period in the file name if the teams feature is enabled. If the period character exists, rename the job to remove the period character. If your current Hudson installation is on a Windows machine, replace \ in the file paths with /. 4. In the Oracle Developer Cloud Service web user interface, open your project. 5. In the navigation bar, click Administration. 6. Click Job Import. 7. In the Job Import page, drag and drop the zip file of jobs to the Drag a zip file here drop area. You may also click select a zip file, browse, select the zip file, and click Open. 8. Click Upload File to upload the zip file. While uploading the zip file, it goes through various validation processes, such as: File format error or empty zip file error In case of a zip file error, create another zip file of the jobs and upload it again. Duplicate job names While uploading the zip file, name of each job is checked against the names of the existing jobs of the Builds page and with the other jobs' names in the zip file being uploaded. If a job name is found to be already in use, it is renamed to add a number suffix (for example, my-job, my-job1, my-job2). If required, you may rename the job in the Job Configuration page. Incompatible Hudson plugins By default, jobs with incompatible plugins are not included. While uploading, the incompatible jobs generate warnings that you should review after the upload is complete. Unknown job While uploading, job dependencies are checked against the existing jobs and the jobs found in the zip file. Missing dependencies report an error and are not imported. If required, click Cancel to abort the job. 9. Select the check boxes of the jobs that you want to import and click Import Jobs. If a job of the same name exists in Oracle Developer Cloud Service, you will be prompted to provide a new name to the imported job. If the Status of a job shows an error, fix the error in the zip file and then try again. After the import is successful, the result page shows a message indicating the number of imported jobs along with their names. Click Start Another Import to import another zip file. 10. Open the Builds page and configure the imported jobs, as required. By default, all imported jobs are disabled and must be enabled manually. To enable a job, open the Builds page, click the job name link to open it, and click the Enable button. See About the Job Details Page and Configuring a Job for information. 3-75

351 Chapter 3 Administering the Build System in Oracle Developer Cloud Service Administering the Build System in Oracle Developer Cloud Service Using the Build Administration page, you can configure a project to use build features such as accessing Oracle Maven Repository and using SonarQube Server to analyze build reports. Topics About the Build Page Managing Oracle Maven Repository Connections Managing SonarQube Server Connections From the Build page, you can configure pre-existing Oracle Maven Repository and SonarQube connections that project members can use while configuring jobs. What You See on the Build Page The following table describes the key information and elements shown on the Build page. Maven Connection SonarQube Server See Managing Oracle Maven Repository Connections. See Managing SonarQube Server Connections. Managing Oracle Maven Repository Connections You can create a connection and link an Oracle Maven Repository account with your project. You can then configure a job to use the connection to access the artifacts of the Oracle Maven Repository while running builds. You would need Oracle Technology Network (OTN) Single Sign-On (SSO) credentials of a user to create a Oracle Maven Repository connection. You can use the connection in the Build Environment tab of the job configuration. See Configuring the Build Environment to use the Oracle Maven Repository. Viewing Existing Oracle Maven Repository Connections 1. In the navigation bar, click Administration. 2. Click Build. 3. Expand Maven Connection. 4. Click the connection name to view its details on the right. Adding an Oracle Maven Repository Connection 1. In the navigation bar, click Administration. 2. Click Build. 3-76

352 Chapter 3 Administering the Build System in Oracle Developer Cloud Service 3. Expand Maven Connection. 4. Click Add Maven Connection. 5. In the Create Maven Connection dialog, enter the following information. Connection Name OTN Username OTN Password Server Id (Required) Enter a unique name of the connection. Project users will use the connection name to connect to the Oracle Maven Repository. (Required) Enter the user name of a user with a valid OTN SSO user name. (Required) Enter the password of the user with a valid OTN SSO user name. If required, enter the ID to use for the <server> element of the Maven settings.xml file. If not provided, the ID will default to maven.oracle.com. 6. Click Create. The Oracle Maven Repository connection is added to the connections list. Editing an Oracle Maven Repository Connection 1. In the navigation bar, click Administration. 2. Click Build. 3. Expand Maven Connection. 4. Click the connection name and then click the Edit icon. 5. In the Edit Maven Connection dialog, enter or update the following information. Connection Name OTN Username OTN Password Server Id Displays the name of the connection. (Required) Enter or update the user name of a user with a valid OTN SSO user name. (Required) Enter or update the password of the user with a valid OTN SSO user name. Enter or update the ID to use for the <server> element of the Maven settings.xml file. If not provided, the ID will default to maven.oracle.com. 6. Click Update. Deleting an Oracle Maven Repository Connection 1. In the navigation bar, click Administration. 2. Click Build. 3. Expand Maven Connection. 4. Click the connection name and then click. 5. In the Delete Maven Connection dialog, click Delete. 3-77

353 Chapter 3 Administering the Build System in Oracle Developer Cloud Service Managing SonarQube Server Connections You can create a connection and link an external SonarQube server with your project. You can then configure a job to use the connection to analyze build reports. The SonarQube Server must be available on the public internet. You can use the connection in the Build Environment tab of the job configuration. See Configuring the Build Environment to use SonarQube. Viewing Existing SonarQube Server Connections 1. In the navigation bar, click Administration. 2. Click Build. 3. Expand SonarQube Server. 4. Click the connection name to view its details on the right. Adding a SonarQube Server Connection 1. In the navigation bar, click Administration. 2. Click Build. 3. Expand SonarQube Server. 4. Click Add SonarQube Server Connection. 5. In the Create SonarQube Server dialog, enter the following information. Server Name SonarQube Server Url Username Password (Required) Enter a unique name of the connection. Project users will use the connection name to connect to the SonarQube Server. (Required) Enter the URL of the SonarQube Server. (Required) Enter the user name of the user who can access the SonarQube Server. (Required) Enter the password of the user who can access the SonarQube Server. 6. Click Create. The SonarQube Server connection is added to the connections list. Editing a SonarQube Server Connection 1. In the navigation bar, click Administration. 2. Click Build. 3. Expand SonarQube Server. 4. Click the connection name and then click the Edit icon. 5. In the Edit SonarQube Server dialog, enter or update the following information. 3-78

354 Chapter 3 Configuring Link Rules in Oracle Developer Cloud Service Server Name SonarQube Server Url Username Password Displays name of the connection. (Required) Enter or update the URL of the SonarQube Server. (Required) Enter tor update he user name of the user who can access the SonarQube Server. (Required) Enter or update the password of the user who can access the SonarQube Server. 6. Click Update. Deleting a SonarQube Server Connection 1. In the navigation bar, click Administration. 2. Click Build. 3. Expand SonarQube Server. 4. Click the connection name and then click. 5. In the Delete SonarQube Server dialog, click Delete. Configuring Link Rules in Oracle Developer Cloud Service About the Links Page In a project, you can define rules to convert plain text to URL links automatically when the text is entered in commit comments and merge request comments. For example, when you enter an address or a URL in a merge request comment, it will be automatically converted to a link. You will use Regular Expressions, also called as RegExp, to define the link rules. Some pre-defined built-in link rules are available in the Links page. To create a custom rule, you can either copy an existing link rule or create a blank rule. For more information bout RegExp, see From the Links page, you can create and manage link rules that convert plain text to URL links automatically. What You See on the Links Page The following table describes the key information and elements shown on the Links page. New Link Link Rules Name Active Create a link rule. See Creating a Link Rule. Lists all link rules of the project. Select a rule to view its details and edit it. You can also drag-and-drop a rule to change its order of priority. Enter or update the name of the link rule. You cannot change the value of a built-in rule. Deselect or select the check box to deactivate or activate the link rule. 3-79

355 Chapter 3 Configuring Link Rules in Oracle Developer Cloud Service Pattern Ignore Case URL Test Value Test Result Specify the link rule pattern using RegExp. You cannot change the value of a built-in rule. Deselect or select the check box to follow or ignore the case of the Pattern value. You cannot change the value of a built-in rule. View or update the URL of the link with parameters. You cannot change the value of a built-in rule. Enter a value and verify its result in Test Result. To enter multiple test values, enter them in separate lines. Displays the result of the test values. Creating a Link Rule To create a link rule, you would need to define the RegExp pattern of the link text and the URL where the link would point to. To create a link rule: 1. In the navigation bar, click Administration. 2. Click Links. 3. To create a blank rule, click + New Link. To copy an existing rule, select the rule in the left list, and click + Copy Link. 4. In the Custom Link section of the Create Link page, complete the elements using the descriptions in the table. Name Active Pattern Ignore Case URL Enter a unique name of the link rule. If you want to deactivate the link rule while its creation, deselect the check box. Specify the Link rule pattern using RegExp. If you have copied a link rule, edit the pattern of the copied rule. Select the check box to ignore the case of the Pattern value. Enter the URL of the link with parameters. If you have copied a link rule, edit the URL of the copied rule. You can also use placeholders in the URL: Use {project} to insert the project ID Use {organization} to insert the organization ID Use $& to insert the entire matching text, or use $1, $2, $3, and so on to insert text of matched groups. For more information, see 5. In the Test section, test the rule. In Test Value, enter a value and verify its result in Test Result. 6. After you are satisfied with the test result, click Done. 3-80

356 Chapter 3 Configuring Link Rules in Oracle Developer Cloud Service The link rule appears on the left list of the Links page. By default, the Links are listed in the priority order. You can use the drag-and-drop action to reorder them. The following illustration shows an example of a custom link rule. The following illustration shows an example of the link in a merge request comment. 3-81

357 Chapter 3 Verifying Organization s Storage Configuration Editing a Link Rule Click the link rule in the left list of the Links page to edit it. Note: You cannot edit a built-in link rule. You may create a copy of built-in rule and edit it, and if required, disable the original pre-configured rule. 1. In the navigation bar, click Administration. 2. Click Links. 3. In the link rule list on the left, click the rule to view its details on the right. 4. Edit the fields on the right. For more information about the fields, see Creating a Link Rule. 5. Open another link rule or navigate to a different page to save the rule. Activating or Deactivating a Link Rule Open the link rule in the edit mode to activate or deactivate it. If deactivated, the text that matches the rule is not converted to a link. To activate or deactivate a link rule: 1. In the navigation bar, click Administration. 2. Click Links. Deleting a Link Rule 3. In the link rule list on the left, click the rule to view its details on the right. 4. Click the Activate or the Deactivate button to activate or deactivate the rule. You can also select or deselect the Active check box. Open the link rule in the edit mode to delete it. You cannot delete a built-in link rule. To delete a link rule: 1. In the navigation bar, click Administration. 2. Click Links. 3. In the link rule list on the left, click the rule to view its details on the right. 4. On the right side of the page, click the Delete button. Verifying Organization s Storage Configuration You can verify the organization s storage configuration and test the connection if it is stable. In case of a failure, contact the Organization Administrator. To verify the storage configuration: 3-82

358 Chapter 3 Verifying Organization s Storage Configuration 1. In the navigation bar, click Administration. 2. Click Storage. The Oracle Storage Cloud Service connection details are displayed. Service ID Username Password Authorization URL Displays the Service ID of the Oracle Storage Cloud Service instance. Displays the user name of an authorized Oracle Storage Cloud Service instance user. Displays asterisks (*) as the password of the authorized Oracle Storage Cloud Service instance user. Displays the URL that is used to authorize access to the Oracle Storage Cloud Service instance. Example: storagetria usoracletria12345.storage.oraclecloud.com/auth/v To verify the connection, click Test Connection. A message is displayed if the connection is successful or fails. 3-83

359 4 Administering the Organization in Oracle Developer Cloud Service You can configure Oracle Developer Cloud Service web user interface to add and display your organization name. You can also set the default Wiki markup language of all new projects in your organization, and view the usage metrics of all projects, and configure the Virtual Machines and their templates. Topics Typical Workflow for Oracle Developer Cloud Service Organization Administrators About the Organization Administration Page Updating Organization Properties Managing Projects and Viewing Usage Metrics of an Organization Viewing and Managing Virtual Machines Managing Virtual Machine Templates Configuring the Oracle Cloud Infrastructure Object Storage Classic Connection Typical Workflow for Oracle Developer Cloud Service Organization Administrators If you are the organization administrator, refer to the typical administrative workflow, as described in the following table. Task More Information Access Oracle Developer Cloud Service Update the Organization name View usage metrics Create and configure Virtual Machines Create and configure Virtual Machine templates Configure storage Access the Oracle Developer Cloud Service web interface. Add or update the organization name, description, and the organization default wiki markup language. View usage metrics of all projects in the organization and manage them. View and manage the Virtual Machines (VMs) View and configure Virtual Machine (VM) templates that define the software installed on the VM. Configure connection to Oracle Cloud Infrastructure Object Storage Classic Accessing Oracle Developer Cloud Service Updating Organization Properties Managing Projects and Viewing Usage Metrics of an Organization Viewing and Managing Virtual Machines Managing Virtual Machine Templates Configuring the Oracle Cloud Infrastructure Object Storage Classic Connection 4-1

360 Chapter 4 About the Organization Administration Page About the Organization Administration Page The Organization page displays the administrative options available for the organization. About the Organization Administration Page The Organization Administration page enables you manage and set configuration for all projects of the organization. The page is available to users with the Developer Service Administrator (DEVELOPER_ADMINISTRATOR) identity domain role. You can open the Organization Administration page from the user menu in the branding bar. In the menu, click Organization. You can also open the Organization page from the Switch Project menu. In an open project, click the project name, and then click the icon. What You See on the Organization Administration Page The following table describes the key information shown on the Organization Administration page. Properties Update the organization name, description, and change the default wiki markup language of all new projects. See Updating Organization Properties. 4-2

361 Chapter 4 Updating Organization Properties Projects Virtual Machines VM Templates View and manage projects of the organization. See Managing Projects and Viewing Usage Metrics of an Organization. Create and configure virtual machines for the organization. See Viewing and Managing Virtual Machines. Create and manage templates for the virtual machines. See Managing Virtual Machine Templates. What You Can Do from the Organization Administration Page See Typical Workflow for Oracle Developer Cloud Service Organization Administrators. For frequently asked questions, see Questions about the Organization Administration Page. Updating Organization Properties You can configure your organization s properties to display the organization name above the project list. You can also set the default Wiki markup language for all projects in your organization. To update organization properties: 1. In the branding bar of the Oracle Developer Cloud Service web interface, click the user name. 2. In the menu, click Organization. 3. Click Properties. 4. Complete the elements using the descriptions in the table. Name Markup Language Enter, or edit, the organization name. In the Confirm Organization Name Change dialog, click Yes. Enter a brief description of the organization. Select the default wiki markup language for new projects. 5. Click Close. Managing Projects and Viewing Usage Metrics of an Organization The Projects page displays the usage metrics of all projects in the organization and enables you to manage them. Topics About the Projects Page 4-3

362 Chapter 4 Managing Projects and Viewing Usage Metrics of an Organization Viewing Usage Metrics of all Projects Managing Projects of the Organization About the Projects Page You can view the usage metrics of all projects, manage their ownership, delete and undelete them from the Projects page. To open the Projects page: 1. In the branding bar of the Oracle Developer Cloud Service web interface, click the user name. 2. In the menu, click Organization. 3. Click Projects. You can perform the following actions from the Projects page. Action View project usage metrics Assign a project s Owner role to yourself Delete a project Undelete a project Postpone removal of a deleted project Select multiple projects Reference Viewing Usage Metrics of all Projects Assigning a Project s Owner Role to Yourself Deleting a Project Undeleting a Project Postponing Removal of a Deleted Project Selecting Multiple Projects To close the organization Projects page and return to the last opened page, click Close above the header. Viewing Usage Metrics of all Projects The Projects page lists the metrics of all projects of the organization along with their status, disk usage, number of members, and owners, along with a summary of usage statistics on the right side of the page. Project Metrics Metrics of all projects in the organization is displayed on the right side of the page. Projects Disk Usage Members Displays the number of projects in the organization. Displays the disk space used by all projects. Displays the number of users in the organization 4-4

363 Chapter 4 Managing Projects and Viewing Usage Metrics of an Organization Projects All projects in the organization are listed on the left side of the page. For each project, the following information is displayed. Use the Filter By and the Sort By lists to filter and sort the displayed projects. Project name Owners Status Disk Usage Members Metrics Displays the name of the project. If the project is in the Active state, click the open link to open it. Displays the name of project owners. If necessary, click the more link to view all owners. Click the owner name to view the owner s details including address. Click the address to send an to the owner. Displays the current state of the project. Active: Indicates the project is in working condition. Deleted: Indicates the project is being deleted. Check the delete message to know when the project will be removed. Failure: Indicates the project provisioning failed during its creation. Displays the disk usage of the project in percentage and MBs. Click Show Details to see the usage metrics of Wiki, Maven, Build, Tasks, and SCM. Number of owners and members of the project Open the menu to perform actions on the project. See Managing Projects of the Organization. See the graphical representation of the Projects, Disk Usage, and Members of the Organization. Managing Projects of the Organization You can assign a project s Owner role to yourself, delete a project, revoke a deleted project, or postpone a deleted project by a few days. Assigning a Project s Owner Role to Yourself You can assign a project s Owner role to yourself. This is usually helpful in a case when all Owners of the project are removed or have left the organization. As the Organization Administrator, you can then take the ownership of such projects and then add new Owners to it. To assign a project s Owner role to yourself: 1. Open the organization Projects page. 2. For the project whose ownership you want to assign to yourself, click and select Assign Me as Owner. Deleting a Project As the Organization Administrator, you can delete any project. It is not necessary for you to be assigned the Owner role of that project. 4-5

364 Chapter 4 Managing Projects and Viewing Usage Metrics of an Organization To delete a project: 1. Open the organization Projects page. 2. For the project you want to delete, click and select Delete. 3. In the Delete Project dialog, click Delete. The project s State will be marked as Deleted - Project will be removed automatically in N days., but is not removed immediately. In the Delete Project dialog box, read the message before you click Delete. Also check the project s delete message to know when the project will be permanently removed. To permanently remove the project immediately, click Postponing Removal of a Deleted Project and select Remove Forever. At times, you may be unsure if you want to revoke a deleted project that is close to its permanent removal date. For such projects, you can choose to postpone their removal by a few days. To postpone removal of a project: 1. Open the organization Projects page. 2. For the deleted project you want to postpone, click and select Postpone Removal. The project s permanent removal date is rescheduled and the message is displayed at the top. In Status, check the project s delete message to know when the project will be permanently removed. Undeleting a Project When you undelete a project, you get an option to update the name and description of the project. When revoked, the project URLs will change if a different name of the deleted project is specified.. To undelete a project: 1. Open the organization Projects page. 2. For the deleted project you want to undelete, click and select Undelete. 3. In the Undelete Project dialog, if necessary, update the project name in Name and description in. You would have to change the project name if another project with the same name was created after this project was deleted. 4. Click Undelete. Selecting Multiple Projects You can select multiple projects and perform common action on them. To select multiple projects: 1. If necessary, filter and sort the projects as desired. 2. Select the check boxes of the desired projects. 4-6

365 Chapter 4 Viewing and Managing Virtual Machines Click the select all link to select all projects. Click none to remove selection of all projects. 3. In the table header, click Update Selected and select the desired action from the menu. The respective icon of a project is disabled when multiple projects are selected. Viewing and Managing Virtual Machines Oracle Developer Cloud Service enables you to view and manage Oracle Cloud Infrastructure Compute Classic Virtual Machines (VMs). You can view VMs, configure them, and delete them from the Oracle Developer Cloud Service web user interface. Topics About Virtual Machines in Oracle Developer Cloud Service About the Virtual Machines Page Configuring the Oracle Cloud Infrastructure Compute Classic Connection Compute_Operations Role: Terms of Use Adding a Build VM Changing a Build VM s Template Deleting a VM About Virtual Machines in Oracle Developer Cloud Service Virtual Machines (VMs) in Oracle Developer Cloud Service are VMs running on the linked Oracle Cloud Infrastructure Compute Classic service to perform processes, such as builds. About Build VMs and Build VM Templates Build VMs are Oracle Cloud Infrastructure Compute Classic VMs that run builds of Oracle Developer Cloud Service projects. Build VM Templates define the operating system and the software installed on the Build VM and are used by the build system when running builds. To configure Oracle Developer Cloud Service to use Build VMs, you must do the following: 1. Link Oracle Cloud Infrastructure Compute Classic service of your identity domain with Oracle Developer Cloud Service. See Configuring the Oracle Cloud Infrastructure Compute Classic Connection. This is a one-time process and must be done while setting up Oracle Developer Cloud Service. 2. Create Build VM templates and specify the platform along with the software. See Creating a Build VM Template. For example, to run builds of Node.js applications, you would need to create a Build VM template with the Node.js software. 3. Add Build VMs that use the template created in Step 2. See Adding a Build VM. 4-7

366 Chapter 4 Viewing and Managing Virtual Machines When you add a Build VM, you specify the number of Oracle Cloud Infrastructure Compute Classic VMs to be allocated for the specified Build VM Template. The VMs are reserved and are exclusively used to run builds. 4. Configure jobs to use the Build VM templates created in Step 2. See Configuring a Job. The builds of the job run on the VMs allocated for the template. Note the following points before using a Build VM: When a build of a job runs, Oracle Developer Cloud Service runs the build on any Build VM of the specified template. The limitation of the number of VMs you can add depends on the available quota of Oracle Cloud Infrastructure Compute Classic. Build VMs are started and stopped automatically by the build system, based on the build demand. However, you can set a sleep timeout, which determines how long VMs can be idle before they are stopped. The Build VM retains the cloned Git repository, Maven repository, and other software between builds. Before running subsequent builds, you must take this into account and manage the files accordingly. About the Virtual Machines Page From the Virtual Machines page, you can view and manage the Virtual Machines (VMs) of your organization. To open the Virtual Machines page of your organization: 1. In the branding bar of the Oracle Developer Cloud Service web interface, click the user name. 2. In the menu, click Organization. 3. Click Virtual Machines. The following table highlights the elements of the Virtual Machines page. Configure Compute Account Overview Open the Configure Compute Account dialog box that enables you to link Oracle Cloud Infrastructure Compute Classic service with Oracle Developer Cloud Service. This is required to create and manage VMs. See Configuring the Oracle Cloud Infrastructure Compute Classic Connection. Displays an overview of VMs running in Oracle Developer Cloud Service. Build VMs: Displays the number of running Build VMs. In the user interface, click the More link to see more information. Click Manage VM Templates to manage and configure the templates of the Build VM. See About Build VMs and Build VM Templates and Managing Virtual Machine Templates. VM Errors: Displays the number of VMs with errors. 4-8

367 Chapter 4 Viewing and Managing Virtual Machines Build VMs tab Lists all Build VMs running in Oracle Developer Cloud Service. A Build VM contains pre-installed software required by the continuous integration build system to run builds. Sort By: Use the list to sort the VMs by Template or Status. + New VM: Create a Build VM. See Adding a Build VM. Sleep Timeout: Configure the sleep timeout of all VMs. Update Selected: Select VMs, click the button to perform the action on selected VMs. For each VM, the following information is displayed: Template: Name of the Build VM template. To change the template, open the list and select another template. Note that this might affect the jobs in the Build page that use this VM. See Changing a Build VM s Template. Status: The current status of the VM. : Click the icon to open the menu and select the desired action. When you are done, use the project navigation bar to switch to another page. Configuring the Oracle Cloud Infrastructure Compute Classic Connection Before you can use Oracle Developer Cloud Service on Oracle Cloud Infrastructure or Oracle Cloud Infrastructure Classic, you must configure a connection to Oracle Cloud Infrastructure Compute Classic. Oracle Developer Cloud Service project builds run on Oracle Cloud Infrastructure Compute Classic virtual machines (VMs). Tutorial To create the connection, you need credentials of a user with the Compute.Compute_Operations (Service Administrator) identity domain role. The role enables you to create, update, and delete VMs on Oracle Cloud Infrastructure Compute Classic. Note: As a user with the Compute.Compute_Operations (Service Administrator) identity domain role can access all resources of the linked Oracle Cloud Infrastructure Compute Classic, it is recommended that you create a separate username in the identity domain and assign the Compute.Compute_Operations (Service Administrator) identity domain role to it. Use the new user s credentials to manage Oracle Developer Cloud Service VMs on Oracle Cloud Infrastructure Compute Classic. See Compute_Operations Role: Terms of Use. To connect to Oracle Cloud Infrastructure Compute Classic: 4-9

368 Chapter 4 Viewing and Managing Virtual Machines 1. In the branding bar of the Oracle Developer Cloud Service web interface, click the user name. 2. In the menu, click Organization. 3. Click Virtual Machines. 4. Click Configure Compute Account. 5. In the Configure Compute Account dialog, complete the elements using the descriptions in the table. Username Password Service Instance ID REST Endpoint (Required) Enter the name of the user who is assigned the Compute.Compute_Operations (Service Administrator) identity domain role. (Required) Enter the password of the user. (Required) Enter the Service Instance ID of Oracle Cloud Infrastructure Compute Classic. You can find the value for Service Instance ID on the Service Details page of Oracle Cloud Infrastructure Compute Classic. (Required) Enter the REST Endpoint URL that is used to authorize access to Oracle Cloud Infrastructure Compute Classic. You can find the value for REST Endpoint on the Service Details page of Oracle Cloud Infrastructure Compute Classic. 6. Click Save. After the credentials are validated, you can create and manage VMs in Oracle Developer Cloud Service. Compute_Operations Role: Terms of Use The following terms apply to the username and password that is created and that is provided Compute_Operations role privileges for the Oracle Developer Cloud Service. You must create a dedicated username and password for use by Oracle Developer Cloud Service. You should not use a personal name or personal information in the creation of the username but you should use a complex password. In addition to following the Oracle Developer Cloud Service terms, you should follow security best practices in maintaining the security of the username and password. You understand that a person having knowledge of the username and password will have access to Compute_Operations role privileges. You also understand that any user with access to Compute_Operations role privileges may, at a minimum, view, create, update and delete Oracle Cloud Infrastructure Compute Classic resources (which include but are not limited to VM instances, storage volumes, security rules, and security IP lists). Your failure to maintain security best practices to secure the username and password may create high risk for you and your organization. You should assign Compute_Operations role privileges only to the username created for Oracle Developer Cloud Service. 4-10

369 Chapter 4 Viewing and Managing Virtual Machines Adding a Build VM Notwithstanding any terms in the Oracle Developer Cloud Service terms, you acknowledge that Oracle has no responsibility or liability for any action you take in accessing or creating access to the Oracle Developer Cloud Service or Oracle Cloud Infrastructure Compute Classic. When you add a Build VM, you allocate a VM on the linked Oracle Cloud Infrastructure Compute Classic service to be used to run builds of jobs. To add a Build VM: 1. Open the Virtual Machines page of your organization. 2. Select the Build VMs tab. 3. Click + New VM. 4. In the Add Build VM dialog, complete the elements using the descriptions in the table. Quantity VM Template Specify the number of VMs you want to allocate. By default, one VM is allocated. Each build happens in one build executor, or one VM. You can build up to 99 builds in parallel using the same VM template. Select the Build VM template from the list. 5. Click Add. If the VM quota is available, the Build VM will be added to the Build VMs tab. After adding Build VMs, you can configure the jobs to use the VM templates. See Configuring a Job. You cannot edit a Build VM to increase or decrease the quantity of VMs. Note: If you have multiple jobs across projects using a common VM template, add multiple Build VMs to use that template. When builds of those jobs run, Oracle Developer Cloud Service picks a VM that is available without waiting for a busy VM to get free. Changing a Build VM s Template You can change a Build VM s template from the Virtual Machines page in Organization Administration. To change a Build VM s template: 1. Open the Virtual Machines page of your organization. 2. Select the Build VMs tab. 4-11

370 Chapter 4 Managing Virtual Machine Templates Deleting a VM 3. Select the VM whose template you want to change, open the Template list, and select another template. You can delete a VM from the Virtual Machines page in Organization Administration. To delete a VM: 1. Open the Virtual Machines page of your organization. 2. Select the Build VMs tab. 3. Select the VM that you want to delete, click, and select Delete. To delete multiple VMs, select them, click the Update Selected button, and select Delete Selected VMs. The selected VMs are deleted. Note: When a Build VM is deleted, it waits for all builds running on it to complete and won't accept new builds while it is waiting for the running builds to complete. After all the builds are complete, it is shut down and is deleted. Managing Virtual Machine Templates A Virtual Machine (VM) template defines the software that will be installed on the VM. You can manage VM Templates from the Virtual Machines page in Organization Administration. Topics About the VM Templates Page Creating a Build VM Template Configuring a VM Template s Software Deleting a VM Template About the VM Templates Page You can create, configure, and manage the Build VM templates from the VM Templates page under Organization Administration. The following table highlights the elements of the VM Templates page. Build VM Templates tab Lists all Build VM templates. Select a VM template on the left to see the software that will be installed on the VM on the right side of the page. + New Template Click to create a VM template. See Creating a Build VM Template. 4-12

371 Chapter 4 Managing Virtual Machine Templates Edit Configure Software Delete Click to edit the name and description of the selected VM template. Click to add or remove the software of the selected VM template. See Configuring a VM Template s Software. Delete the selected VM template. See Deleting a VM Template. When you are done, use the project navigation bar to switch to another page. Creating a Build VM Template You can create a Build VM template from the VM Templates page in Organization Administration. To create a Build VM template: 1. Open the VM Templates page of your organization. 2. In the Build VM Templates tab, click + New Template. 3. In the New VM Template dialog, complete the elements using the descriptions in the table. Name Platform Enter the template name. Enter the template description. Select the operating system that will run on the VM. You can choose between Oracle Linux 6 (default) and Oracle Linux Click Create. The template name is added to the VM tab s template list. Select the VM template to verify the operating system and the configured software packages displayed on the right. To configure software, see Configuring a VM Template s Software. Configuring a VM Template s Software You can add or remove a software of a VM from the Software Catalog page. To configure a VM s software: 1. Open the VM Templates page of your organization. 2. Select the Build VM Templates tab. 3. Select the VM in the left list and click Configure Software. The Software Catalog page opens. The following table describes the elements of the Software Catalog page. 4-13

372 Chapter 4 Managing Virtual Machine Templates Filter Software Packages Software tile Selected Software To search for a software, enter the search term and click the Search icon. Select the Show latest versions only check box to see the latest version of the software, in case multiple versions of the same software are available. Shows the software name, description, version, and the storage space it requires. Added software are highlighted for visual distinction. Lists all software added to the template. 4. In the Software Catalog, click the icon of the software to add it. If a software is dependent on another software, a message will appear informing you about the dependencies that must be added to use the software. To remove a software, click the The 5. Click Done. icon is disabled for the required software. About Software Versions icon in the tile or the Selected Softwarelist. Some software in the Software Catalog are available in multiple versions. For example, Gradle is available as Gradle 2, Gradle 3, and Gradle 4. These software are called as Software Packages. The version number in the title is their base version (or the major version) and the number shown in the Version field is the minor version. The minor version is the actual software version that will be installed on the VM. For example, in Gradle 4, 4 is the major version and 4.1 is the software version. When a new minor version of a software package is available in the Software Catalog, all VM templates using that software package are updated automatically. For example, when Gradle 4.2 is added to the Software Catalog, all VM templates using the Gradle 4 package are updated to use Gradle 4.2. If there is an incompatibility between the upgraded software and other installed software of the VM template, an error is reported with suggestions about the cause of the error. 4-14

373 Chapter 4 Configuring the Oracle Cloud Infrastructure Object Storage Classic Connection When a new major version of a software is available, the catalog is updated, but VM templates using the older versions of the software package are not updated automatically. The new major version of the software is added to the catalog as a separate package. For example, when Gradle 5 is added to the Software Catalog, all VM templates using Gradle 2, Gradle 3, or Gradle 4 are not updated automatically. You have to manually update the VM templates to use the new package. Deleting a VM Template You can delete a Build VM template from the VM Templates page in Organization Administration. To delete a VM template: 1. Open the VM Templates page of your organization. 2. Select the Build VM Templates tab. 3. In the left list, select the VM that you want to delete, and click the icon. You can also click the Delete button on the right. 4. In the Delete VM dialog, click Yes to confirm. When a Build VM template is deleted, all Build VMs using that template are marked for deletion. After the builds running on those VMs are complete, they are shut down and removed in a controlled manner. Configuring the Oracle Cloud Infrastructure Object Storage Classic Connection Before you can use Oracle Developer Cloud Service on Oracle Cloud Infrastructure or Oracle Cloud Infrastructure Classic, you must configure a connection to Oracle Cloud Infrastructure Object Storage Classic. Oracle Developer Cloud Service project build and Maven artifacts are stored in an Oracle Cloud Infrastructure Object Storage Classic container. Tutorial Configuring an Oracle Cloud Infrastructure Object Storage Classic Connection To create the connection, you need credentials of a user with the Storage.Storage_Administrator (Service Administrator) identity domain role. 1. In the branding bar of the Oracle Developer Cloud Service web interface, click the user name. 2. In the menu, click Organization. 3. Click Storage. 4. Click Add Storage Service Connection. 5. Complete the elements using the descriptions in the table. 4-15

374 Chapter 4 Configuring the Oracle Cloud Infrastructure Object Storage Classic Connection Service ID Username Password Authorization URL (Required) Enter the Service ID of the Oracle Cloud Infrastructure Object Storage Classic service. Example: storagetria usoracletria (Required) Enter the name of the user who is assigned the Storage.Storage_Administrator (Service Administrator) identity domain role. (Required) Enter the password of the user. (Required) Enter the URL that is used to authorize access to the Oracle Cloud Infrastructure Object Storage Classic service. Example: usoracletria12345.storage.oraclecloud.com/auth/v Click Create. The Oracle Storage Cloud Service instance is now linked to the Oracle Developer Cloud Service organization. 7. Click Close. Viewing or Editing an Oracle Cloud Infrastructure Object Storage Classic Connection 1. In the branding bar of the Oracle Developer Cloud Service web interface, click the user name. 2. In the menu, click Organization. 3. Click Storage. The Oracle Cloud Infrastructure Object Storage Classic connection details are displayed. 4. To verify the connection, click Test Connection. A message is displayed if the connection is successful or fails. 5. To edit the connection details, click Edit. In the Edit Storage dialog, enter the following information. Service ID Username Password Authorization URL Displays the Service ID of the Oracle Cloud Infrastructure Object Storage Classic service. (Required) Enter or update the name of the user who is assigned the Storage.Storage_Administrator (Service Administrator) identity domain role. (Required) Enter or update the password of the user. (Required) Enter or update the URL that is used to authorize access to the Oracle Cloud Infrastructure Object Storage Classic service. Example: usoracletria12345.storage.oraclecloud.com/auth/v1.0. Click Update. 6. Click Close. 4-16

375 Chapter 4 Configuring the Oracle Cloud Infrastructure Object Storage Classic Connection Using the Oracle Cloud Infrastructure Object Storage Classic Connection After an Oracle Cloud Infrastructure Object Storage Classic service is linked with the Oracle Developer Cloud Service organization, all projects of the organization use the storage instance to store artifacts. You can use the Oracle Cloud Infrastructure Object Storage Classic service to store the following: Maven artifacts of projects All Maven artifacts of all projects are stored on Oracle Cloud Infrastructure Object Storage Classic. Archived build artifacts of project jobs All archived artifacts of jobs of all projects of the organization are stored on Oracle Cloud Infrastructure Object Storage Classic. Note: If an Oracle Cloud Infrastructure Object Storage Classic service is not configured, builds of jobs that archive artifacts will fail. 4-17

376 5 Using IDEs with Oracle Developer Cloud Service You can access Oracle Developer Cloud Service projects from Integrated Development Environments (IDEs) such as Oracle Enterprise Pack for Eclipse (OEPE), Oracle JDeveloper, and NetBeans IDE. Topics Using Eclipse IDE with Oracle Developer Cloud Service Using NetBeans IDE with Oracle Developer Cloud Service Using Oracle JDeveloper with Oracle Developer Cloud Service Using Eclipse IDE with Oracle Developer Cloud Service The Eclipse IDE and the Oracle Enterprise Pack for Eclipse (OEPE) includes integration for Oracle Developer Cloud Service, which conveniently exposes the most common Cloud development tasks from within the IDE. You can download the Eclipse IDE from and OEPE from If you are using the Eclipse IDE, download and install the Oracle Cloud Tools plugin from the Eclipse IDE marketplace. In OEPE, the plugin is installed by default. Topics Installing the Oracle Cloud Tools Plugin Logging In to Oracle Developer Cloud Service Using the Oracle Cloud View Importing an Oracle Developer Cloud Service Project to the Eclipse IDE Exporting an Eclipse IDE Project to Oracle Developer Cloud Service Using Git in Eclipse IDE Updating Oracle Developer Cloud Service Issues in the Eclipse IDE Monitoring Project Builds in the Eclipse IDE Oracle Developer Cloud Service integration with the Eclipse IDE includes the following: A dedicated Oracle Cloud view that displays Oracle Developer Cloud Service projects of which you are a member Integration with Mylyn and the Oracle Developer Cloud Service Issues system Source control system integration with the Oracle Developer Cloud Service Git repository 5-1

377 Chapter 5 Using Eclipse IDE with Oracle Developer Cloud Service Watch a short video to learn more about Oracle Developer Cloud Service features in the Eclipse IDE. Video Installing the Oracle Cloud Tools Plugin If you are using the Eclipse IDE, you can install the plugin from the Eclipse marketplace. After the plugin is installed, you can use the Eclipse IDE to develop applications for Oracle Cloud. If you are using OEPE, the plugin is installed by default. To install the Oracle Cloud Tools plugin: 1. Open Eclipse IDE. 2. From the Help menu, select Eclipse Marketplace. 3. In the Find field of the Search tab of the Eclipse Marketplace wizard, enter Oracle Cloud Tools and click Go. 4. In the Search Result, find the Oracle Cloud Tools plugin and click the Install button. 5. In the Confirm Selected Features page of the wizard, ensure the checkbox of Oracle Tools is selected. Click Confirm to continue. 5-2

378 Chapter 5 Using Eclipse IDE with Oracle Developer Cloud Service 6. In the Review Licenses page, select the I accept the terms of the license agreements option and click Finish. 7. If prompted, restart the IDE. After installing the plugin, you can log in to Oracle Cloud from the Oracle Cloud view. Logging In to Oracle Developer Cloud Service You can log in to Oracle Developer Cloud Service from the Oracle Cloud view. To open the Oracle Cloud view: 1. In the Eclipse IDE s installation directory, open eclipse.ini in a text editor. 2. Add the following lines at the end of the file. -DOracle.Cloud.Debug=true -DOracle.Cloud.Dcs.Debug=true 3. Save the file and restart the Eclipse IDE. 4. From the Window menu, click Show View and then Oracle Cloud. If the Oracle Cloud option does not appear in the Show View menu, click Other. In the Show View dialog, expand Oracle Cloud and select Oracle Cloud. 5. If you are connecting to Oracle Developer Cloud Service for the first time, click the Connect link. If the Connect link is not available, click the New Cloud Connection icon in the Oracle Cloud view. 6. In the Oracle Cloud Service Connection dialog box, enter the following: Developer Cloud Service URL: Enter the base part of the Oracle Developer Cloud Service URL. For example, if your service URL is 5-3

379 Chapter 5 Using Eclipse IDE with Oracle Developer Cloud Service developer.us2.oraclecloud.com/developer99999-a11111/, enter developer.us2.oraclecloud.com/. Identity Domain: Enter the identity domain of Oracle Developer Cloud Service. For example, if your service URL is developer.us2.oraclecloud.com/developer99999-a11111/, enter developer a Username and Password: Enter the user name and password. 7. Click Validate. 8. After your credentials have been validated, click Finish. After the connection is successful, expand the identity domain node in the Oracle Cloud view, and then expand the Developer node to view projects that are assigned to you. Tip: The Oracle Cloud view is visible in the Java EE perspective, by default. To open the Java EE perspective, from the Window menu, select Open Perspective and then Java EE. Using the Oracle Cloud View The Oracle Cloud view displays all projects of which you are a member and provides links to the common features of Oracle Developer Cloud Service. Some of these links go to the web user interface, while others use the native IDE interface. You can perform the following actions from the Oracle Cloud view: Open the Oracle Cloud portal Select and right-click the root Identity Domain node and select Open Cloud Portal. Open the Identity Manager console Select and right-click the root Identity Domain node and select Open IDM Console. Edit connection properties Select and right-click the root Identity Domain node and select Properties. Create an Oracle Developer Cloud Service project Select and right-click the Organization node and select New Cloud Project. The Oracle Developer Cloud Service web interface opens in the embedded OEPE browser. View all Oracle Developer Cloud Service projects of which you are a member If all projects are not visible, select and right-click the Organization node and enable Show All Projects. Refresh and view the latest projects 5-4

380 Chapter 5 Using Eclipse IDE with Oracle Developer Cloud Service To view projects that were added or removed after you created the Oracle Developer Cloud Service connection, select and right-click the Organization node and select Refresh. Open an Oracle Developer Cloud Service project In the Oracle Cloud view, select the Organization node, right-click and select Activate. Then select the project you want to open, right-click and select Activate. After opening a project, you can perform the following actions: Clone the project s Git repositories, or export or import OEPE projects to the hosted Git repository. See Using Git in Eclipse IDE. Search and manage issues (see Updating Oracle Developer Cloud Service Issues in the Eclipse IDE) Monitor builds of your project (see Monitoring Project Builds in the Eclipse IDE) You can add multiple Oracle Developer Cloud Service accounts in the Oracle Cloud view. To add another account, select the root Identity Domain node in the Oracle Cloud view, right-click, and select New. Select the data center, enter the identity domain, user name, and credentials, and click Finish. Importing an Oracle Developer Cloud Service Project to the Eclipse IDE Importing a project from Oracle Developer Cloud Service to the IDE workspace creates a local clone of the Oracle Developer Service Git repository. After the local Git clone has been created, IDE projects can be imported into the workspace. To import an Oracle Developer Cloud Service project to the IDE Workspace: 1. In the Oracle Cloud view, activate and open the project. If the project is not activated, select the project, right-click and select Activate. 2. Expand the Source node. 3. Select the Git repository that you want to clone, right-click, and select Activate. If the project Git repository contains more than one branch, a dialog appears asking you to select branches you want to clone. By default, all branches are selected. Deselect the check box of the branch you do not want to clone, select the initial branch from the list, and click OK. A dialog appears informing you that the Git repository is being cloned and then disappears after cloning is complete. After the repository is cloned, expand the Git repository in the Oracle Cloud view to view its branches, references, remote repository names, and tags. The cloned Git repositories are also visible in the Git Repositories view of the IDE. If the view is not visible, select Window, then Show View, and then Git Repositories. 4. Right-click the cloned Git repository and select Import Projects. 5. In the Select a wizard to use for importing projects page of Import Projects from Git Repository dialog, select the desired project import option and click Next. 5-5

381 Chapter 5 Using Eclipse IDE with Oracle Developer Cloud Service Tip: If you are not sure which option to select, select the Import as General Project option. 6. In the Import Projects page of the Import Projects from Git Repository dialog, note the project name and directory, and click Finish. Exporting an Eclipse IDE Project to Oracle Developer Cloud Service Exporting a project from the IDE workspace to Oracle Developer Cloud Service is useful if you already have a local project and want to push the source to the project Git repository. To export an IDE project to Oracle Developer Cloud Service: 1. Create a project in Oracle Developer Cloud Service (see Creating a Project). 2. Select the project in the Oracle Cloud view. If necessary, click the Refresh icon of the Oracle Cloud view to reload projects in the Oracle Cloud view. 3. In the Source node, expand the project. 4. Clone the Git repository. Select the Git repository that you want to clone, right-click, and select Activate. 5. Create or open the OEPE project that you want to export. 6. Right-click the OEPE project and select Team, and then select Share Project. 7. In the Share Project wizard, select Git as the repository type and click Next. 8. In the Configure Git Repository page, select the project Git repository and click Finish. 9. In Project Explorer view of OEPE, select the project, right-click, and select Team, and then Commit. 10. In the Commit Changes dialog, enter a commit description, select files you want to commit, and click Commit and Push. 11. In the Push Results dialog, click OK to export the project to Oracle Developer Cloud Service. 12. Verify the project files in the Code page of Oracle Developer Cloud Service. Instead of choosing the Share Project option, committing files, and pushing the commit, you may also drag and drop the IDE project to the Git repository node in the Oracle Cloud view. All files in the project will be automatically committed and pushed to the Git hosted repository, and the IDE project will be synchronized with the Oracle Developer Cloud Service project. Using Git in Eclipse IDE Using Git tools in the Eclipse IDE and OEPE, you can create and merge branches, commit files, and push commits to the hosted Git repository. 5-6

382 Chapter 5 Using Eclipse IDE with Oracle Developer Cloud Service Eclipse IDE and OEPE use EGit to manage Git repositories. For more information about EGit and what other Git actions you can perform, see and the EGit documentation at Updating Oracle Developer Cloud Service Issues in the Eclipse IDE In the Eclipse IDE and OEPE, you can perform various issue-related actions such as creating a search query, importing issues, and so on. Watch a short video to learn more about updating Oracle Developer Cloud Service issues from the Eclipse IDE. Video Topics Creating an Oracle Developer Cloud Service Issue Creating a Custom Issue Search Query Associating an OEPE Issue with a Commit To view and update Oracle Developer Cloud Service issues in the Oracle Cloud view, select the Tasks node of your project, right-click, and select Activate. By default, the following issue queries are available in the Tasks node: Mine: Lists all issues assigned to you Open: Lists all open issues Recent: Lists all recently changed issues Related: Lists all issues related to you Double-click a query to run it, and then double-click an issue to open it in the Task Editor. To synchronize the query with Oracle Developer Cloud Service and view the latest issues, select the query, right-click, and select Synchronize. Creating an Oracle Developer Cloud Service Issue You can create Oracle Developer Cloud Service issues and local tasks in IDE. When synchronized, the Oracle Developer Cloud Service issues will also be visible in the Oracle Developer Cloud Service web interface. To create an Oracle Developer Cloud Service issue: 1. Open the Task List view. 2. Click the New Task icon, or right-click and select New, and then select Task. 3. In the New Task dialog, select your Oracle Developer Cloud Service project as the repository. Select Local if you want to create a local task. 4. Click Finish. 5. In the New Task page, enter the issue details such as the issue title, issue status, issue type, and issue priority. For more information, see About the New Issue Page. 5-7

383 Chapter 5 Using Eclipse IDE with Oracle Developer Cloud Service 6. Click Submit. The new issue now appears in the appropriate search query node of the Tasks node and in the Issues page of the Oracle Developer Cloud Service web interface. Creating a Custom Issue Search Query By default, four issue search queries are available in the Tasks node. You can create a custom search query too, if necessary. For example, you can create a custom search query to import all open defects assigned to you. To create a custom search query and import issues: 1. Select the Tasks node of your project in the Oracle Cloud view. 2. Right-click and select New Query. 3. In the Oracle Developer Cloud Service Tasks Query dialog, enter the search criteria. For example, if you want to view all open defects assigned to you, enter the name of the query, select your name from the Person list, select Defect as the Type, and select Assigned as the Status. 4. Click Finish. The custom search query is now available in the Tasks node. Expand the query to view the issues matching the search criteria. The query and the issues are also available in the Task List view. To open the Task List view, from the Window menu, select Show View, then Task List. Associating an Issue with a Commit When you commit files, you can create an association between the commit and the issue. To associate an issue with a commit, you must activate the issue first. Eclipse IDE and OEPE provides task integration with Mylyn. Activating an issue enables Mylyn to track which files are related to the current issue. Mylyn automatically hides files that are not related to the active issue. When you commit changes to the Git repository, the commit message automatically references the active issue s ID. This effectively creates a link between the code commit and the issue, allowing for easy traceability. Links between source commits and issues are also reflected in the web interface of Oracle Developer Cloud Service. For more information about Mylyn, see To associate an issue with a commit: 1. Open the Tasks List view. 2. Update the issue that you want to associate with the commit. 3. In the Tasks List view, select the issue, right-click, and select Activate. 4. Commit your files to the Git repository. The issue s name and its URL are automatically included in Commit Message. After a successful commit, open the issue in the web interface of Oracle Developer Cloud Service. The SHA-1 checksum hash of the commit is now added to Commits in Associations. 5-8

384 Chapter 5 Using NetBeans IDE with Oracle Developer Cloud Service Monitoring Project Builds in the Eclipse IDE You can view your project build jobs from the Build node in the Oracle Cloud view. To view build jobs of a project, you must activate the Build node. Select the Build node, right-click, and select Activate. When activated, the Build node shows all jobs and builds of your project. You can perform the following actions from the Build node: Run a build Select the job whose build you want to run, right-click, and select Run Build. View details of the last build Select the job, right-click, and select Open Last Build. In the page that opens, you can view the files and changes made to the Git repository, the console output, and the artifacts created by the build. Open the job details or the build details in the web browser Select the job or the build, right-click, and select Open in Browser. Using NetBeans IDE with Oracle Developer Cloud Service NetBeans IDE is closely integrated with Oracle Developer Cloud Service. You can create and open Oracle Developer Cloud Service projects in NetBeans IDE, update files and commit them to the Git repository, create and update issues, and manage project builds. You can download the latest version of NetBeans IDE from downloads/. Topics Installing the Oracle Developer Cloud Service Plugin Logging In to Oracle Developer Cloud Service Using the Oracle Developer Cloud Service Team Server Creating an Oracle Developer Cloud Service Project in NetBeans IDE Opening an Oracle Developer Cloud Service Project in NetBeans IDE Using Git in NetBeans IDE Updating Oracle Developer Cloud Service Issues in NetBeans IDE Monitoring Project Builds in NetBeans IDE Installing the Oracle Developer Cloud Service Plugin To use Oracle Developer Cloud Service features in NetBeans IDE, you must install the Oracle Developer Cloud Service plugin. See the NetBeans IDE documentation for more information about installing plugins. The Oracle Developer Cloud Service plugin is a Team Server plugin that enables you to create an Oracle Developer Cloud Service team server and then log in. 5-9

385 Chapter 5 Using NetBeans IDE with Oracle Developer Cloud Service To install the Oracle Developer Cloud Service plugin: 1. Open NetBeans IDE. 2. From the Tools menu, select Plugins. 3. In the Plugins dialog, click the Available Plugins tab. 4. Select the Install check box of the Oracle Developer Cloud Service plugin. 5. Click Install. 6. Read the license agreement and select the I accept the terms in all of the license agreements check box. 7. Click Install. Logging In to Oracle Developer Cloud Service You can log in to Oracle Developer Cloud Service from the Team window. To log in to Oracle Developer Cloud Service: 1. From the Window menu, select Team to open the Team window. 2. From the Team menu, select Team Server, then Add Team Server. Alternatively, click in the Team window. 3. In the New Team Server dialog, select Oracle Developer Cloud Service in Provider, enter a unique name in the Name field and the Oracle Developer Cloud Service URL in the URL field. You will find the URL in that you received when you signed up for the trial service or purchased the service. You can also contact the project Owner or the Identity Domain Administrator for the URL. 4. Click OK. 5. In the Team window, click Click here to select project to see the list of team servers. Click Login under the Oracle Developer Cloud Service team server. The following graphic shows an example. 6. In the Login to Team Server dialog, enter the user name and password and click Login. 5-10

386 Chapter 5 Using NetBeans IDE with Oracle Developer Cloud Service Using the Oracle Developer Cloud Service Team Server After you log in, the Oracle Developer Cloud Service team server lists all projects of which you are a member. For each project, NetBeans IDE displays project information about build jobs, issues, and Git repositories. From the Oracle Developer Cloud Service team server, you can do the following: Create an Oracle Developer Cloud Service project Open an existing project Switch to another project Log out from the Oracle Developer Cloud Service team server Click the Oracle Developer Cloud Service team server actions. icon to perform the above Note: By default, NetBeans IDE synchronizes information from all recently selected or opened projects of which you are a member or own. The information includes all issues, builds, and Git repositories. If you want to synchronize information for the selected project, click the icon, select Auto Synchronize Services, and then Selected Project Only. Creating an Oracle Developer Cloud Service Project in NetBeans IDE You can create an Oracle Developer Cloud Service project in NetBeans IDE and then push its files to the hosted Git repository. You can also push an existing NetBeans IDE project to an empty Oracle Developer Cloud Service project Git repository. To create an Oracle Developer Cloud Service project in NetBeans IDE: 1. From the Team menu, select Team Server, then Oracle Developer Cloud Service team server, then New Project. 5-11

387 Chapter 5 Using NetBeans IDE with Oracle Developer Cloud Service You may also select New Project from the Oracle Developer Cloud Service team server menu. 2. In the Name and License page of the New Project wizard, perform these steps: a. Enter a unique project name in Project Name. b. Enter a brief description of the project in. c. Select a Security setting. Private projects are accessible to invited members only. Shared projects are accessible to all members of the organization. Any member of the organization can view the source code, create or update issues, edit wiki pages, and interact with project builds. However, only project members and owners can push changes to the Git repository and perform deployment operations on the deployment configurations. d. Select the Wiki Markup language. For more information, see Creating a Project. 3. Click Next. 4. In the Source Code and Issues page of the New Project wizard, perform these steps: a. In the Local Repository Folder field, click Browse and select a local directory that you want to initialize as the project s Git repository when the project is created. b. In the Folders or Projects field, click Add Project to add an add an existing NetBeans IDE project to the new Oracle Developer Cloud Service project. In the Open Project dialog, browse and select the project directory, and click Open Project. 5. Click Next. Click Add Folder to add the contents of a directory to a project. In the Open dialog, browse and select the directory, and click Open. If you do not want to add an existing project or directory, leave the Folders or Projects field blank. 6. In the Summary page, review the information and click Finish. 7. After the project is successfully created in Oracle Developer Cloud Service, a dialog displays a message showing the local repository location. Click Close to close the dialog. If you did not add an existing project in Step 4, then follow the steps described in Opening an Oracle Developer Cloud Service Project in NetBeans IDE to clone the hosted Git repository of the new project. After cloning the Git repository, add files to the project, commit them to the local Git repository branch and then push the branch to the hosted Git repository. Opening an Oracle Developer Cloud Service Project in NetBeans IDE You can open an Oracle Developer Cloud Service project in NetBeans IDE from the Team window. After opening the project, you can clone the hosted Git repository. If the project is not already open, click the project name in the Team window, browse the list, and select the project. 5-12

388 Chapter 5 Using NetBeans IDE with Oracle Developer Cloud Service If you have a long list of projects, click the Oracle Developer Cloud Service team server icon and select Open Project. In the Search field of the Open Project dialog, enter the name of the project that you want to open, and click Search. To view all projects, leave the Search field empty and click Search. To open and clone the Oracle Developer Cloud Service project in NetBeans IDE: 1. Open the project in the Team window. 2. In the open project, expand Sources and click the get link of the Git repository you want to clone. 3. In the Get Sources from Team Server dialog, verify the Git repository URL and click Get From Developer Server. 4. In the Remote Repository page of the Clone Repository wizard, verify the repository URL, and click Next. The user name and password are automatically picked from the Team Server you are logged into. You might need to click the Back button of the wizard to open the Remote Repository page. 5. If required, in the Remote Branches page of the Clone Repository wizard, select the branches that you want to clone and click Next. 6. In the Destination Directory page of the Clone Repository wizard, perform these steps: a. Specify the directory path in the Parent Directory field. b. Enter the name of the cloned repository in the Clone Name field. c. Select the checkout branch in Checkout Branch. d. Verify the Remote Name of the checkout branch. e. Select Scan for NetBeans Projects after Clone if you want NetBeans IDE to scan the cloned project for NetBeans IDE metadata. If metadata is found, the project automatically opens in the Projects window of NetBeans IDE. 7. Click Finish. All cloned Git repositories are available in the Git Repository Browser. You can open the Git Repository browser from the Team menu. From the Team menu, select Git, then Repository Browser. Using Git in NetBeans IDE Using the Team menu or the Git Repositories Browser, you can perform various Git actions such as committing files, creating and merging branches, and pushing changes to the hosted Git repository. To open the Git Repository Browser, from the Team menu, select Repository, then Repository Browser. For more information about the Git commands and actions in NetBeans IDE, refer to the NetBeans IDE Git documentation at

389 Chapter 5 Using NetBeans IDE with Oracle Developer Cloud Service Updating Oracle Developer Cloud Service Issues in NetBeans IDE When you open a project in the Oracle Developer Cloud Service team server, the Tasks window displays the default issue search queries. The issue queries include: All tasks Assigned to me Open tasks Related to me User defined custom queries Topics Create an Oracle Developer Cloud Service Task in NetBeans IDE Create an Oracle Developer Cloud Service Task Query in NetBeans IDE Associating an Issue with a Commit Click the issue query link to open the query result in the Tasks window. If the Tasks window is not visible, open it from the Window menu. In the Tasks window, double-click the issue to open it in the Task editor. Make your edits, and then Submit to push the updates to Oracle Developer Cloud Service issue repository. Create an Oracle Developer Cloud Service Issue in NetBeans IDE You can create an Oracle Developer Cloud Service task from the Tasks window. To create an issue in the Tasks window of NetBeans IDE: 1. In the Tasks window, click the Create New Task icon. 2. In the Report a New Task editor, enter the issue details (see About the New Issue Page). Click Submit Issue to push the issue details and create the issue in Oracle Developer Cloud Service. The submitted issue will be available in the web interface of Oracle Developer Cloud Service. 5-14

390 Chapter 5 Using NetBeans IDE with Oracle Developer Cloud Service Tip: You may also create an issue from the Team menu. Open the Team menu and select Report Task, in Task Repository select the project for which you want to create the issue, enter the details, and click Submit Issue. Create an Oracle Developer Cloud Service Issue Query in NetBeans IDE You can create an Oracle Developer Cloud Service issue query in NetBeans IDE from the Tasks window. To create an issue query in NetBeans IDE: 1. In the Tasks window, click the Create New Query icon in the header of your project. 2. In the Find Tasks editor, specify the search criteria and click Search. 3. To save the search query, click Save Query. Tasks matching the search query are displayed in the bottom pane of the Find Tasks editor. 4. Enter a unique name in the Save Query dialog and click Save. The saved query will be available in the web interface of Oracle Developer Cloud Service. Tip: You may also create an issue query from the Team menu. Open the Team menu and select Find Tasks. In Task Repository, select the project for which you want to create the issue query, enter the criteria, and click Search. Associating an Issue with a Commit You can associate an issue and update it in Oracle Developer Cloud Service when you commit files. To associate an issue with a commit: 1. From the Tasks window, open the issue that you want to associate with the commit. 2. Update the issue and click Submit. 3. Commit files. 4. In the Commit dialog, expand the Update Task section. 5. Select the issue from the Task list. Only those issues that you have opened appear in the Task list. 6. Select the desired check boxes and option buttons. 5-15

391 Chapter 5 Using NetBeans IDE with Oracle Developer Cloud Service 7. Click Commit. Open the issue in Oracle Developer Cloud Service web interface and verify its status and that the SHA-1 checksum hash of the commit has been added to Commits in Associations. Monitoring Project Builds in NetBeans IDE When you open a project in the Oracle Developer Cloud Service team server, it displays all builds and jobs of the project along with their status. To view a particular build's details, double-click the job name in the Team window to view its builds in the Services window. From the Hudson Builders node of the Services window, you can perform the following actions: View jobs of a project Expand the project to view all jobs. Create a new job Right-click the project name, and select New Build. Provide the details in the Oracle Developer Cloud Service web page that opens. For more information, see Creating a Job. Synchronize jobs and builds Right-click the project name, and select Synchronize. Run a build of a job Expand the project, right-click the job, and select Start Job. View config.xml of a job Expand the project, right-click the job, and select View config.xml. Associate a job with a NetBeans IDE project Expand the project, right-click the job, and select Associate with Project. In the Select Project dialog, select the NetBeans IDE project, and click OK. 5-16

392 Chapter 5 Using Oracle JDeveloper with Oracle Developer Cloud Service View builds of a job Expand the project, and then expand the job to view all builds. View changes made to the source code that triggered the build Expand the project, and then expand the job. Right-click the build, and select Show Changes. The changes are displayed in the Output window. View console output of a build Expand the project, and then expand the job. Right-click the build, and select Show Console. The console output is displayed in the Output window. View build artifacts Expand the project, expand the job, and expand the build to view all artifacts. Using Oracle JDeveloper with Oracle Developer Cloud Service Oracle JDeveloper enables you to develop applications and commit the files to the Oracle Developer Cloud Service Git repository. Similar to NetBeans IDE, JDeveloper also uses the Oracle Developer Cloud Service Team Server plugin to access Oracle Developer Cloud Service projects. The plugin is installed by default in JDeveloper. Topics Logging In to Oracle Developer Cloud Service Using the Oracle Developer Cloud Service Team Server Creating an Oracle Developer Cloud Service Project in JDeveloper Opening an Oracle Developer Cloud Service Project in JDeveloper Using Git in Oracle JDeveloper Updating Oracle Developer Cloud Service Issues in JDeveloper Monitoring Project Builds in JDeveloper Building Oracle ADF Applications with Oracle Developer Cloud Service Logging In to Oracle Developer Cloud Service You can log in to Oracle Developer Cloud Service from the Team window. To log in to Oracle Developer Cloud Service: 1. From the Window menu, select Team to open the Team window. 2. From the Team menu, select Team Server, then Add Team Server. Alternatively, click in the Team window. 3. In the New Team Server dialog, select Oracle Developer Cloud Service in Provider, enter a unique name in the Name field and the Oracle Developer Cloud Service URL in the URL field. 5-17

393 Chapter 5 Using Oracle JDeveloper with Oracle Developer Cloud Service You will find the URL in that you received when you signed up for the trial service or purchased the service. You can also contact the project Owner or the Identity Domain Administrator for the URL. 4. Click OK. 5. In the Team window, click Click here to select project to see the list of team servers. Click Login under the Oracle Developer Cloud Service team server. 6. In the Login to Team Server dialog, enter the user name and password and click Login. Using the Oracle Developer Cloud Service Team Server After you log in, the Team window lists all projects of which you are a member. For each project, JDeveloper displays project information about build jobs, issues, and Git repositories. From the Oracle Developer Cloud Service team server, you can do the following: Create an Oracle Developer Cloud Service project Open an existing project Switch to another project Log out from the Oracle Developer Cloud Service team server Click the Oracle Developer Cloud Service team server actions. icon to perform the above 5-18

394 Chapter 5 Using Oracle JDeveloper with Oracle Developer Cloud Service Note: By default, JDeveloper synchronizes information from all recently selected or opened projects of which you are a member or own. The information includes all issues, builds, and Git repositories. If you want to synchronize information for the selected project, click the icon, select Auto Synchronize Services, and then Selected Project Only. Creating an Oracle Developer Cloud Service Project in JDeveloper You can create an Oracle Developer Cloud Service project in JDeveloper and then push its files to the hosted Git repository. You can also push an existing JDeveloper application to an empty Oracle Developer Cloud Service project Git repository. To create an Oracle Developer Cloud Service project: 1. From the Team menu, select Team Server, then Oracle Developer Cloud Service team server, then New Project. You may also select New Project from the Oracle Developer Cloud Service team server menu. 2. In the Name and License page of the New Project wizard, perform these steps: a. Enter a unique project name in Project Name. b. Enter a brief description of the project in. c. Select a Security setting. Private projects are accessible to invited members only. Shared projects are accessible to all members of the organization. Any member of the organization can view the source code, create or update issues, edit wiki pages, and interact with project builds. However, only project members and owners can push changes to the Git repository and perform deployment operations on the deployment configurations. d. Select the Wiki Markup language. For more information, see Creating a Project. 3. Click Next. 4. In the Source Code and Issues page of the New Project wizard, perform these steps: a. In the Local Repository Folder field, click Browse and select a local directory that you want to initialize as the project s Git repository when the project is created. b. In the Folders or Projects field, click Add Project to add an add an existing NetBeans IDE project to the new Oracle Developer Cloud Service project. In the Open Project dialog, browse and select the project directory, and click Open Project. Click Add Folder to add the contents of a directory to a project. In the Open dialog, browse and select the directory, and click Open. If you do not want to add an existing project or directory, leave the Folders or Projects field blank. 5-19

395 Chapter 5 Using Oracle JDeveloper with Oracle Developer Cloud Service 5. Click Next. 6. In the Summary page, review the information and click Finish. 7. After the project is successfully created in Oracle Developer Cloud Service, a dialog displays a message showing the local repository location. Click Close to close the dialog. If you did not add an existing project in Step 4, then follow the steps described in Opening an Oracle Developer Cloud Service Project in JDeveloper to clone the hosted Git repository of the new project. After cloning the Git repository, add files to the project, commit them to the local Git repository branch and then push the branch to the hosted Git repository. Opening an Oracle Developer Cloud Service Project in JDeveloper You can open an Oracle Developer Cloud Service project in JDeveloper from the Team window. After opening the project, you can clone the hosted Git repository. If the project is not already open, click the project name in the Team window, browse the list, and select the project. If you have a long list of projects, click the Oracle Developer Cloud Service team server icon and select Open Project. In the Search field of the Open Project dialog, enter the name of the project that you want to open, and click Search. To view all projects, leave the Search field empty and click Search. To open and clone the Oracle Developer Cloud Service project: 1. Open the project in the Team window. 2. In the open project, expand Sources and click the get link of the Git repository you want to clone. 3. In the Get Sources from Team Server dialog, verify the Git repository URL and click Get From Developer Server. 4. In the Remote Repository page of the Clone Repository wizard, verify the repository URL, and click Next. The user name and password are automatically picked from the Team Server you are logged into. You might need to click the Back button of the wizard to open the Remote Repository page. 5. If required, in the Remote Branches page of the Clone Repository wizard, select the branches that you want to clone and click Next. 6. In the Destination Directory page of the Clone Repository wizard, perform these steps: a. Specify the directory path in the Parent Directory field. b. Enter the name of the cloned repository in the Clone Name field. c. Select the checkout branch in Checkout Branch. d. Verify the Remote Name of the checkout branch. 7. Click Finish. 5-20

396 Chapter 5 Using Oracle JDeveloper with Oracle Developer Cloud Service Using Git in Oracle JDeveloper Using the Git extension, you can perform various Git actions such as cloning a Git repository, checking out and updating files, committing and pushing, and creating and merging branches. Watch a short video to learn more about using Git in Oracle JDeveloper. Video You can download the Git extension from the Help menu. Open the Help menu and select Check for Updates. See the JDeveloper documentation for more information. For more information about Git actions in JDeveloper, read the Versioning Applications with Source Control chapter of Oracle Fusion Middleware Developing Applications with Oracle JDeveloper on Updating Oracle Developer Cloud Service Issues in JDeveloper When you open a project in the Oracle Developer Cloud Service team server, the Tasks window displays the default issue search queries. The issue queries include: All tasks Assigned to me Open tasks Related to me User defined custom queries Click the issue query link to open the query result in the Tasks window. If the Tasks window is not visible, open it from the Window menu. In the Tasks window, double-click the issue to open it in the Task editor. Make your edits, and then click Submit to push the updates to Oracle Developer Cloud Service issue repository. Create an Oracle Developer Cloud Service Issue You can create an Oracle Developer Cloud Service task from the Tasks window. To create an issue in the Tasks window of JDeveloper: 1. In the Tasks window, click the Create New Task icon. 5-21

397 Chapter 5 Using Oracle JDeveloper with Oracle Developer Cloud Service 2. In the Report a New Task editor, enter the issue details (see About the New Issue Page). Click Submit Issue to push the issue details and create the issue in Oracle Developer Cloud Service. The submitted issue is now available in the web interface of Oracle Developer Cloud Service. Tip: You may also create an issue from the Team menu. Open the Team menu and select Report Task, in Task Repository select the project for which you want to create the issue, enter the details, and click Submit Issue. Create an Oracle Developer Cloud Service Issue Query in JDeveloper You can create an Oracle Developer Cloud Service issue query from the Tasks window. To create an issue query in JDeveloper: 1. In the Tasks window, click the Create New Query icon in the header of your project. 5-22

398 Chapter 5 Using Oracle JDeveloper with Oracle Developer Cloud Service 2. In the Find Tasks editor, specify the search criteria and click Search. 3. To save the search query, click Save Query. Tasks matching the search query are displayed in the bottom pane of the Find Tasks editor. 4. Enter a unique name in the Save Query dialog and click Save. The saved query is also available in the web interface of Oracle Developer Cloud Service. Tip: You may also create an issue query from the Team menu. Open the Team menu and select Find Tasks. In Task Repository, select the project for which you want to create the issue query, enter the criteria, and click Search. Associating an Issue with a Commit You can associate an issue and update it in Oracle Developer Cloud Service when you commit files. To associate an issue with a commit: 1. From the Tasks window, open the issue that you want to associate with the commit. 2. Update the issue and click Submit. 3. Commit files. 4. In the Task Repository field of the Commit dialog, if necessary, select the Oracle Developer Cloud Service project. 5. Select the issue from the Task list. Only those issues that you have opened and updated appear in the Task list. 6. Select the desired check boxes and option buttons. 7. Click OK. The issue is updated in the Issues tab. Open the issue in Oracle Developer Cloud Service web interface and verify that the SHA-1 checksum hash of the commit is also added to Commits in Associations Monitoring Project Builds in JDeveloper When you open a project in the Oracle Developer Cloud Service team window, it displays all builds and jobs of the project along with their status. To view a particular build's details, double-click the job name in the Team window to view its builds in the Oracle Developer Cloud Service web interface. 5-23

399 Chapter 5 Using Oracle JDeveloper with Oracle Developer Cloud Service Building Oracle ADF Applications with Oracle Developer Cloud Service You can develop Oracle ADF applications in JDeveloper and then build them using OJMake and OJDeploy tools with Ant or Maven in Oracle Developer Cloud Service. Building with Ant Tutorial To build an Oracle ADF application using Ant in Oracle Developer Cloud Service: 1. Create an Oracle ADF application in Oracle JDeveloper. 2. Add or configure the build.properties and build.xml files. In build.xml, add <property environment="env"/> immediately after the <project> element to enable Ant to access the system environment variables and store them in properties, prefixed with env. Example: <?xml version="1.0" encoding="windows-1252"?> <project name="helloworldadfproject" basedir="."> <property environment="env" /> <property file="build.properties"/>... </project> Configure build.properties file to use Oracle Developer Cloud Service build executor environment variables to access the ant library, the OJDeploy tool, and the JDeveloper directory installed on the Oracle Developer Cloud Service build executor. See Using the Oracle Developer Cloud Service Build Executor Environment Variables. 3. Commit and push the application to the hosted Git repository. 4. In Oracle Developer Cloud Service, create and configure a job with an Ant build step. 5. Run a build of the job to generate the artifacts. Using OJServer with OJDeploy When you run a job configured to use multiple OJDeploy builds, the build starts, runs, and then shuts down JDeveloper ojdeploy for each invocation. You can increase the OJDeploy performance by using OJServer, which eliminates the requirement to start and stop OJDeploy after each invocation. To use OJServer with OJDeploy, you must configure the job and update the Ant script to use OJServer. 1. Configure the build.xml file of your application to add the ojserver argument (<arg value="-ojserver"/>) before parameters are defined. Example: <property file="build.properties"/> <target name="deploy" description="deploy JDeveloper profiles"> <taskdef name="ojdeploy" 5-24

400 Chapter 5 Using Oracle JDeveloper with Oracle Developer Cloud Service classname="oracle.jdeveloper.deploy.ant.ojdeployanttask" uri="oraclelib:ojdeployanttask" classpath="${oracle.jdeveloper.ant.library}"/> <ora:ojdeploy xmlns:ora="oraclelib:ojdeployanttask" executable="${oracle.jdeveloper.ojdeploy.path}" ora:buildscript="${oracle.jdeveloper.deploy.dir}/ojdeploybuild.xml" ora:statuslog="${oracle.jdeveloper.deploy.dir}/ojdeploystatuslog.xml"> <arg value="-ojserver"/> <ora:deploy> <ora:parameter name="workspace" value="$ {oracle.jdeveloper.workspace.path}"/> <ora:parameter name="profile" value="$ {oracle.jdeveloper.deploy.profile.name}"/> </ora:deploy> </ora:ojdeploy> 2. In Oracle Developer Cloud Service web interface, configure the job to run a Shell build step that starts OJServer before running OJDeploy commands. Add a Shell build step to ojserver. Examples: $ORACLE_HOME_SOA_12_1_3/jdev/bin/ojserver -start & $ORACLE_HOME_SOA_12_2_1/jdev/bin/ojserver -start & See Adding an Unix Shell Builder. Note: In the command that invokes ojserver, the & character is required at the end of the command to keep ojserver running in the background. In the command, use the correct environment variables that matches your JDeveloper 12c or above version. OJServer is not supported in JDeveloper 11g. For more information about environment variables, see Using the Oracle Developer Cloud Service Build Executor Environment Variables. In the Shell build step that starts the ojserver, use the sleep command to add a 30 seconds or more wait time to allow the ojserver process to start before any other command runs. Example: $ORACLE_HOME_SOA_12_1_3/jdev/bin/ojserver -start & sleep 30 Configure the job to use JDK 8 (or above) as JDev and above versions do not support JDK 7 (or lower). 3. ojserver process automatically stops with any other remaining processes when the build executor is recycled/cleaned up for the next users job. Building with Maven Tutorial 5-25

401 Chapter 5 Using Oracle JDeveloper with Oracle Developer Cloud Service You can configure the Maven POM file to access the Oracle Maven Repository to access JDeveloper and ADF libraries. You would also need Oracle SSO credentials to access the Oracle Maven repository. To build an Oracle ADF application using Maven and Oracle Maven Repository in Oracle Developer Cloud Service: 1. Create an Oracle ADF application in Oracle JDeveloper. 2. Add and configure the Maven POM file of the ADF application. Use Oracle Developer Cloud Service build executor environment variables to access the OJMake and OJDeploy tools on the Oracle Developer Cloud Service build executor and the Oracle Maven Repository. See Using the Oracle Developer Cloud Service Build Executor Environment Variables. 3. Commit and push the application to the hosted Git repository. 4. In Oracle Developer Cloud Service, create and configure a job with a Maven build step. See Using the Oracle Maven Repository and Configuring Build Steps. 5. Run a build of the job to generate the artifacts. 5-26

402 6 Frequently Asked Questions for Oracle Developer Cloud Service This section provides answers to frequently asked questions (FAQ) for Oracle Developer Cloud Service. Topics: General Questions General Questions Questions about User Account Preferences Questions about the Welcome page and Projects Questions about the Project page Questions about the Code Page and Git Questions about the Maven Page and the Project Maven Repository Questions about the Releases Page and Configuring Releases of a project Questions about the Snippets Page and Snippet Files Questions about the Merge Request Page and Code Reviews Questions about the Issues Page and Tasks Questions about the Agile Page and Sprints Questions about the Builds Page and the Build System Questions about the Deploy Page and Project Deployment Questions about the Wiki Page and Wiki Pages Questions about the Administration Page and Project Ownership Questions about the Organization Administration Page This section provides answers to general Oracle Developer Cloud Service questions. What is Oracle Developer Cloud Service? Oracle Developer Cloud Service is a cloud-based software development Platform as a Service that provides a hosting environment for software development projects. See About Oracle Developer Cloud Service. How do I subscribe to Oracle Developer Cloud Service? See How to Begin with Oracle Developer Cloud Service Subscriptions. 6-1

403 Chapter 6 General Questions How do I get started with Oracle Developer Cloud Service? After you subscribe to Oracle Developer Cloud Service, log in using your credentials to access the service. You can access Oracle Developer Cloud Service from a web interface in a web browser and from popular IDEs such as NetBeans IDE, OEPE, and JDeveloper. See Accessing Oracle Developer Cloud Service. Which browsers are supported? See Oracle Software Web Browser Support Policy. Can I use components of Oracle Developer Cloud Service along with components of my existing on-premise environment? Yes, you can choose to use components of Oracle Developer Cloud Service and your on-premise environment to create a hybrid environment. Here are some examples: Use Git, Maven, build system, issue tracker, code review, and Wiki of Oracle Developer Cloud Service. Download the application artifacts from Oracle Developer Cloud Service and deploy them manually to your on-premise environment. Use Git, Maven, build system, code review tool of Oracle Developer Cloud Service; and the Wiki and the bug tracking system of your on-premise environment. Use Git, code review, and the issue tracker of Oracle Developer Cloud Service; and the build server of your on-premise environment to generate artifacts and then deploy them to your preferred web application server. Before you create a hybrid environment with external services (such as external Source Code Management system or external Continuous Integration system), note that the hybrid environment might not be a secure environment because Oracle Developer Cloud Service would require the external services to be publicly available on the internet. Also, the integration that is available between Oracle Developer Cloud Service components might not be available with the external services. How do I find my organization name? Method 1 You can find your organization name from the Oracle Developer Cloud Service instance URL. For example, if the base URL of the of your Oracle Developer Cloud Service environment is then your host name is developer.us2.oraclecloud.com, and the organization name is my-org. Method 2 If you find it difficult to find the organization name from the URL, you can find your organization name from the Organization Administration page. For example, in the following image, My Org is the organization name. 6-2

404 Chapter 6 General Questions Method 3 You can also find the organization name from the Switch Project menu. For example, in the following Switch Project menu image, My Org is the organization name, which is displayed in the menu title above the toggle buttons. How do I return to the Oracle Developer Cloud Service Welcome page? At the top of the page, click Oracle Developer Cloud Service Welcome page. in the top bar to return to the 6-3

405 Chapter 6 Questions about User Account Preferences Questions about User Account Preferences This section provides answers to Oracle Developer Cloud Service user account related questions that you might have after logging into Oracle Developer Cloud Service. How do I update my Oracle Developer Cloud Service account preferences? You can update your account preferences from the Preferences page. In the branding bar of the Oracle Developer Cloud Service web interface, click the user name and then click Preferences. How do I update my First Name and Last Name? 1. In the branding bar of the Oracle Developer Cloud Service web interface, click the user name and then click Preferences. 2. Click Profile, if necessary. 3. In First Name and Last Name, update your details. 4. Click Close when you are done. How do I update my address? 1. In the branding bar of the Oracle Developer Cloud Service web interface, click the user name and then click Preferences. 2. Click Profile, if necessary. 3. In Address, update the address. After you update your address, click the Re-send button to confirm the address. In the Confirmation that you receive, click the verification link to complete the verification process. 4. Click Close when you are done. How do I add or update my profile picture? To add a profile picture: 1. Create an account on Gravatar ( using your registered profile address. 2. Log in and upload your profile picture on Gravatar. 3. Log out of Gravatar. To verify your profile picture: 1. In the branding bar of the Oracle Developer Cloud Service web interface, click the user name and then click Preferences. 6-4

406 Chapter 6 Questions about User Account Preferences 2. Click Profile, if necessary. 3. In Picture, the profile picture is displayed. Using the registered address, Oracle Developer Cloud Service picks your profile picture from Gravatar and displays it. 4. Click Close when you are done. See Updating Profile Information. How do I add an SSH Authentication Key to my account? To authenticate yourself for SSH, you can add your SSH key to your account. Ensure that you have generated an SSH Key before you add it. 1. In the branding bar of the Oracle Developer Cloud Service web interface, click the user name and then click Preferences. 2. Click Authentication. 3. ClickAdd Key. 4. In New SSH Key dialog, enter details. See Adding an SSH Key. 5. Click Close when you are done. How do I remove an Authentication Key from my account? 1. In the branding bar of the Oracle Developer Cloud Service web interface, click the user name and then click Preferences. 2. Click Authentication. 3. Click the button on right side of Name. A notification of the same is displayed for a few seconds at the top of the page. 4. Click Close when you are done. How do I enable or disable notifications? 1. In the branding bar of the Oracle Developer Cloud Service web interface, click the user name and then click Preferences. 2. Click Notifications. 3. Select or deselect the check boxes of the desired notifications. See Setting Notifications. 4. Click Close when you are done. Note: To know more about user account preferences, see Setting Oracle Developer Cloud Service Preferences. 6-5

407 Chapter 6 Questions about the Welcome page and Projects Questions about the Welcome page and Projects This section provides answers to the Oracle Developer Cloud Service Welcome page and project related questions. What is a Project? An Oracle Developer Cloud Service project is a collection of features and services provided by Oracle Developer Cloud Service. An Oracle Developer Cloud Service project can host multiple Git repositories. Each Git repository can have multiple branches and hundreds of code files. You can create a merge request for each branch of the Git repository and ask reviewers to review the code. You can create and configure multiple build jobs to generate different project artifacts and then deploy the artifacts to Oracle Java Cloud Service - SaaS Extension, publicly available Oracle Java Cloud Service instances, or Oracle Application Container Cloud Service instances.. Watch a short video to learn about the components of Oracle Developer Cloud Service project. Video See About Oracle Developer Cloud Service Projects. What is the Welcome page? The Welcome page is the first page you see after logging in to Oracle Developer Cloud Service. It lists all projects of your organization and the toggle buttons to filter them. See About the Oracle Developer Cloud Service Welcome Page. 6-6