https://github.com/servicenow/sncicd-plugin-activate
https://github.com/servicenow/sncicd-plugin-activate
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/servicenow/sncicd-plugin-activate
- Owner: ServiceNow
- License: mit
- Created: 2020-09-25T14:40:53.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-14T07:52:19.000Z (about 2 years ago)
- Last Synced: 2025-09-12T01:28:21.015Z (6 months ago)
- Language: TypeScript
- Size: 1.19 MB
- Stars: 9
- Watchers: 4
- Forks: 13
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# ServiceNow CI/CD GitHub Action for Activate Plugin
Activate a desired plugin on your ServiceNow instance
# Usage
## Step 1: Prepare values for setting up your variables for Actions
- credentials (username and password for a service account)
- instance URLs for your dev, test, prod, etc. environments
- sys_id or scope for your app
- sys_id for your ATF Test Suite
## Step 2: Configure Secrets in your GitHub repository
On GitHub, go in your repository settings, click on the secret _Secrets_ and create a new secret.
Create secrets called
- `NOW_USERNAME`
- `NOW_PASSWORD`
- `NOW_INSTALL_INSTANCE` only the **domain** string is required from the instance URL, for example https://**domain**.service-now.com
## Step 3: Example Workflow Template
https://github.com/ServiceNow/sncicd_githubworkflow
## Step 4: Configure the GitHub Action if need to adapt for your needs or workflows
```yaml
- name: Activate Plugin
id: sncicd-plugin-activate # id of the step
uses: ServiceNow/sncicd-plugin-activate@1.0 # like username/repo-name
with:
pluginID:
env:
nowUsername: ${{ secrets.NOW_USERNAME }}
nowPassword: ${{ secrets.NOW_PASSWORD }}
nowInstallInstance: ${{ secrets.NOW_INSTALL_INSTANCE }}
```
Inputs:
- **pluginID** - Plugin ID to be installed (like com.servicenow_now_calendar)
Outputs:
- **failed** - Indicates if plugin installed correctly
Environment variable should be set up in the Step 1
- nowUsername - Username to ServiceNow instance
- nowPassword - Password to ServiceNow instance
- nowInstallInstance - ServiceNow instance where plugin will be activated
# Contributing
## Tests
Tests should be ran via npm commands:
#### Unit tests
```shell script
npm run test
```
#### Integration test
```shell script
npm run integration
```
## Build
```shell script
npm run buid
```
## Formatting and Linting
```shell script
npm run format
npm run lint
```
# Notices
## Support Model
ServiceNow built this integration with the intent to help customers get started faster in adopting CI/CD APIs for DevOps workflows, but __will not be providing formal support__. This integration is therefore considered "use at your own risk", and will rely on the open-source community to help drive fixes and feature enhancements via Issues. Occasionally, ServiceNow may choose to contribute to the open-source project to help address the highest priority Issues, and will do our best to keep the integrations updated with the latest API changes shipped with family releases. This is a good opportunity for our customers and community developers to step up and help drive iteration and improvement on these open-source integrations for everyone's benefit.
## Governance Model
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.