GitHub Actions configuration
learn how to integrate github actions in to enable insights into your build and deploy workflows github actions enables the automation of tasks and processes in their build and deploy workflows, providing insights into these phases of the devops lifecycle developers can define custom workflows using yaml syntax, which can be triggered by events such as code pushes, pull requests, or scheduled intervals captures all workflows in github actions and retrieves them this data is then processed and displayed in the form of graphs and tables on the build and deploy pages integration of github actions in pulls data from github actions such as build and deploy details, including its unique identifier, status, time stamp, duration and cause the process for onboarding github actions comprises the following steps, each of which is a multistep procedure crate a personal access token create a connection configure the application for two supported devops phases build deploy onboard the github actions technical service create a personal access token use the following procedure to create a personal access token navigate to your github homepage go to user settings → developer settings → personal access tokens → generate new token ensure the token has read permissions on the org/repo intended to sync create a connection to pull data from github actions, you must establish a connection between devops intelligence and github actions use the following procedure click on settings → service iam → connections → add new → add connection complete the form for content provider, select github for name, enter local account name for reference for name, enter local account name for reference for host git api, enter the url of the git host (e g , https //github test net) for user, populate this field with the same username that you use for your github account for user, populate this field with the same username that you use for your github account for user, populate this field with the same username that you use for your github account for token, use the pat token created in create token step if you are using a proxy adapter to access through an intermediary layer, enter the uuid for the adapter in the proxy id field when archive is enabled, the connection is archived for future use configuring for github actions and recent customers the procedures in this section are valid only for customers onboarded 6 june, 2024 or after procedures for legacy customers are provided in the subsequent section configure for github, legacy customers supports github actions for two devops phases build deploy build use the following procedure to configure github actions for the build phase click on settings & utilities → application configuration navigate to the add tools step select the phase as build press add tool configuration for tool engine , select github actions complete the form for both tabs (refer to note directly following this list workflow jobs status click add configuration enable workflow jobs to builds from all workflow jobs irrespective of workflow job name enable workflow job names to enable job names for which build data is needed the status data from the source is mapped to the specific categories as passed , failed and in progress deploy use the following procedure to configure github actions for the build phase click on settings & utilities → application configuration navigate to the add tools step select the phase as deploy press add tool configuration for tool engine , select github actions complete the form for the three tabs (refer to note directly following this list release and environment status incident mapping click add configuration for release and environment release prefix signifies the starting sequence of characters for releases, with the default value being empty release variable signifies the starting sequence of characters for releases, with the default value being empty environment prefix signifies the starting sequence of characters for environment, with the default value being empty environment name environment name where your application is deployed environment field signifies the field from where environment name has to be picked from ex env release field signifies the field from where incident release name has to be picked from ex env map your production environment signifies the environment used for production deployments the tool configuration inherits the release prefix, variable & environment prefix, name from the application to override these values only for this configuration, click the edit button and make the necessary changes please note that changing the values here will not impact the release prefix and variable set in the application the status data from the source is mapped to the specific categories as passed , failed and in progress for incident mapping , the host url of incident management tool used to monitor incidents if any arising out of application deployment issues for example servicenow onboard the github actions technical service you must now onboard the technical service use the following procedure navigate to → settings & utilities → application configurations click the overflow menu for the chosen application and click on onboard technical service select the phase for which you want to configure github actions the page displays only the phases for which this tools has been configured for the application select the tool engine as github actions for connection select the appropriate connection name from the drop down select provider only in the deploy phase for the current deployment supports the following types of github tracking organization repository organization tracking to track organizational data, use the following procedure select tracking type organization select the appropriate organization click onboard to onboard the technical service repository tracking to track organizational data, use the following procedure select tracking type organization and repository select the appropriate organization select the appropriate repository click onboard to onboard the technical service for github enterprise accounts, if the administrator has set a limit on api calls, will optimize its process of fetching data and will execute approximately 1000 calls each hour this is to make sure no other task using the credentials are hampered once the limit is exceeded display a message on the github sync page deleting the github actions technical service the administrator may, at will, delete the github technical service use the following procedure navigate to → settings & utilities → application configurations expand the application to see all the associated phases click the overflow menu associated with the phase ( build or deploy ) click delete technical service the service responds by displaying a form completed the form for tool engine, select github actions select the appropriate organization select the appropriate repository click delete at the bottom of the form configuring for github actions and legacy customers the procedures in this section are valid only for customers onboarded before 6 june, 2024 use the following procedure to configure for sonarqube navigate to → settings & utilities → tools configuration → add configuration select github actions as the tool engine under connection , select the appropriate connection name select the project and metrics you want to track in note additional configurations are provided to manage the status, including passed , failed and in progress