This custom action needs to be added at step level in a job to Update change in ServiceNow instance for the change-request-number provided as input along with change-request-details.
- credentials (Devops integration token of a GitHub tool created in ServiceNow DevOps or username and password for a ServiceNow devops integration user)
- instance URL for your ServiceNow dev, test, prod, etc. environments
- tool_id of your GitHub tool created in ServiceNow DevOps , required for token based authentication
On GitHub, go in your organization settings or repository settings, click on the Secrets > Actions and create a new secret.
For token based authentication which is available from v2.0.0, create secrets called
SN_INSTANCE_URLyour ServiceNow instance URL, for example https://test.service-now.comSN_DEVOPS_INTEGRATION_TOKENrequired for token based authenticationSN_ORCHESTRATION_TOOL_IDonly the sys_id is required for the GitHub tool created in your ServiceNow instance,required for token based authentication
For basic authentication , create secrets called
SN_INSTANCE_URLyour ServiceNow instance URL, for example https://test.service-now.comSN_DEVOPS_USERSN_DEVOPS_PASSWORDSN_ORCHESTRATION_TOOL_IDonly the sys_id is required for the GitHub tool created in your ServiceNow instance,required for token based
Step 3: Identify upstream job that must complete successfully before the job using this custom action will run
Use needs to configure the identified upstream job. See test.yml for usage.
deploy:
name: Deploy
needs: <upstream job>
runs-on: ubuntu-latest
steps:
- name: ServiceNow Update Change
uses: ServiceNow/[email protected]
with:
devops-integration-token: ${{ secrets.SN_DEVOPS_INTEGRATION_TOKEN }}
tool-id: ${{ secrets.SN_ORCHESTRATION_TOOL_ID }}
instance-url: ${{ secrets.SN_INSTANCE_URL }}
context-github: ${{ toJSON(github) }}
change-request-number: 'CHG123456'
change-request-details: '{"short_description":"Automated Software Deployment","description":"Automated Software Deployment.","assignment_group":"a715cd759f2002002920bde8132e7018","implementation_plan":"Software update is tested and results can be found in Test Summaries Tab; When the change is approved the implementation happens automated by the CICD pipeline within the change planned start and end time window.","backout_plan":"When software fails in production, the previous software release will be re-deployed.","test_plan":"Testing if the software was successfully deployed"}'deploy:
name: Deploy
needs: <upstream job>
runs-on: ubuntu-latest
steps:
- name: ServiceNow Update Change
uses: ServiceNow/[email protected]
with:
devops-integration-user-name: ${{ secrets.SN_DEVOPS_USER }}
devops-integration-user-password: ${{ secrets.SN_DEVOPS_PASSWORD }}
instance-url: ${{ secrets.SN_INSTANCE_URL }}
context-github: ${{ toJSON(github) }}
change-request-number: 'CHG123456'
change-request-details: '{"short_description":"Automated Software Deployment","description":"Automated Software Deployment.","assignment_group":"a715cd759f2002002920bde8132e7018","implementation_plan":"Software update is tested and results can be found in Test Summaries Tab; When the change is approved the implementation happens automated by the CICD pipeline within the change planned start and end time window.","backout_plan":"When software fails in production, the previous software release will be re-deployed.","test_plan":"Testing if the software was successfully deployed"}'The values for secrets should be setup in Step 1. Secrets should be created in Step 2.
Optional DevOps Integration Token of GitHub tool created in ServiceNow instance for token based authentication.
Optional DevOps Integration Username to ServiceNow instance.
Optional DevOps Integration User Password to ServiceNow instance.
Required URL of ServiceNow instance to create change in ServiceNow.
Optional Orchestration Tool Id for GitHub created in ServiceNow DevOps
Required Github context contains information about the workflow run details.
The change request number to identify a unique change request
The change details to be used for Updating the change request information identified by the specified change request number with the key-value pairs. The change details is a JSON object surrounded by curly braces {} containing key-value pair separated by a comma ,. A key-value pair consists of a key and a value separated by a colon :. The keys supported in key-value pair are short_description, state, description, work_notes ..so on
Example: State should be specified at last in case if you are update the state of change request change-request-details: '{"short_description": "Test description in Updated by Github custom Action","description":"Automated Software Deployment.","close_code":"successful", "close_notes":"Closing during Github Actions CustomActionUpdate","state":"3"}'
To know the status of the Change Request Update.
ServiceNow customers may request support through the Now Support (HI) portal.
Initially, ServiceNow product management and engineering representatives will own governance of these integrations to ensure consistency with roadmap direction. In the longer term, we hope that contributors from customers and our community developers will help to guide prioritization and maintenance of these integrations. At that point, this governance model can be updated to reflect a broader pool of contributors and maintainers.