https://github.com/byu-oit/github-action-start-standard-change
A GitHub Action for starting standard change RFCs in BYU's ServiceNow system
https://github.com/byu-oit/github-action-start-standard-change
github-action
Last synced: 6 months ago
JSON representation
A GitHub Action for starting standard change RFCs in BYU's ServiceNow system
- Host: GitHub
- URL: https://github.com/byu-oit/github-action-start-standard-change
- Owner: byu-oit
- License: apache-2.0
- Created: 2020-05-16T22:04:14.000Z (about 6 years ago)
- Default Branch: staging
- Last Pushed: 2025-07-21T22:50:26.000Z (about 1 year ago)
- Last Synced: 2025-12-16T08:11:52.274Z (7 months ago)
- Topics: github-action
- Language: JavaScript
- Homepage:
- Size: 2.19 MB
- Stars: 0
- Watchers: 18
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#  github-action-start-standard-change
A GitHub Action for starting standard change RFCs in BYU's ServiceNow system
## Usage
### Get the inputs
* Get client credentials from Tyk
> In the `byu-oit` GitHub organization, we provide the following secrets to every repo:
> - `STANDARD_CHANGE_PRODUCTION_CLIENT_KEY`
> - `STANDARD_CHANGE_PRODUCTION_CLIENT_SECRET`
> - `STANDARD_CHANGE_SANDBOX_CLIENT_KEY`
> - `STANDARD_CHANGE_SANDBOX_CLIENT_SECRET`
* Get the alias or sys_id of your standard change template
>Existing templates can be found [here](https://support.byu.edu/nav_to.do?uri=%2Fu_standard_change_template_list.do) in production, or [here](https://support-test.byu.edu/nav_to.do?uri=%2Fu_standard_change_template_list.do) in sandbox
* Estimate how long a deployment should take, in minutes
### Add to your workflow (making replacements as necessary)
In a workflow where the deploy phase is a step, do this...
```yaml
on: push
name: Some Pipeline
jobs:
do-all-the-things:
runs-on: ubuntu-latest
steps:
# Build, unit tests, linting, etc.
# ...
- name: Start Standard Change
uses: byu-oit/github-action-start-standard-change@v1
id: start-standard-change
with:
client-key: ${{ secrets.STANDARD_CHANGE_SANDBOX_CLIENT_KEY }} # You'll want to use the production secrets in production
client-secret: ${{ secrets.STANDARD_CHANGE_SANDBOX_CLIENT_SECRET }}
template-id:
minutes-until-planned-end: 30 # Optional, defaults to 15
# Your actual deployment step would go here
- name: Deploy
id: deploy
run: echo Deploy
- name: End Standard Change
uses: byu-oit/github-action-end-standard-change@v1
if: always() && steps.start-standard-change.outcome == 'success' # Run if RFC started, even if the deploy failed
with:
client-key: ${{ secrets.STANDARD_CHANGE_SANDBOX_CLIENT_KEY }}
client-secret: ${{ secrets.STANDARD_CHANGE_SANDBOX_CLIENT_SECRET }}
change-sys-id: ${{ steps.start-standard-change.outputs.change-sys-id }}
work-start: ${{ steps.start-standard-change.outputs.work-start }}
success: ${{ job.status == 'success' }}
```
In a workflow where the deploy phase is a job, do this...
Have a job with an `id` of `deploy` (or change this example accordingly), then
```yaml
on: push
name: Some Pipeline
jobs:
# Build, unit tests, linting, etc.
# ...
start-standard-change:
name: Start Standard Change
needs:
runs-on: ubuntu-latest
steps:
- name: Start Standard Change
uses: byu-oit/github-action-start-standard-change@v1
id: start-standard-change
with:
client-key: ${{ secrets.STANDARD_CHANGE_SANDBOX_CLIENT_KEY }} # You'll want to use the production secrets in production
client-secret: ${{ secrets.STANDARD_CHANGE_SANDBOX_CLIENT_SECRET }}
template-id:
minutes-until-planned-end: 30 # Optional, defaults to 15
outputs:
change-sys-id: ${{ steps.start-standard-change.outputs.change-sys-id }}
work-start: ${{ steps.start-standard-change.outputs.work-start }}
deploy:
name: Deploy
needs: start-standard-change
runs-on: ubuntu-latest
steps:
# ...
end-standard-change:
name: End Standard Change
needs: [deploy, start-standard-change] # We need to wait on outcome of deploy, and we list start-standard-change so that we can grab its outputs
if: always() && needs.start-standard-change.result == 'success' # Run if RFC started, even if the deploy failed
runs-on: ubuntu-latest
steps:
- uses: byu-oit/github-action-end-standard-change@v1
with:
client-key: ${{ secrets.STANDARD_CHANGE_SANDBOX_CLIENT_KEY }}
client-secret: ${{ secrets.STANDARD_CHANGE_SANDBOX_CLIENT_SECRET }}
change-sys-id: ${{ needs.start-standard-change.outputs.change-sys-id }}
work-start: ${{ needs.start-standard-change.outputs.work-start }}
success: ${{ needs.deploy.result == 'success' }} # Evaluates to 'true' or 'false'
```
>For performance reasons, we'd recommend a workflow where the deploy phase is a step, but sometimes it needs to be a job
## Contributing
Hopefully this is useful to others at BYU. Feel free to ask me some questions about it, but I make no promises about being able to commit time to support it.
### Modifying Source Code
Just run `npm install` locally. There aren't many files here, so hopefully it should be pretty straightforward.
### Cutting new releases
GitHub Actions will run the entry point from the `action.yml`. In our case, that happens to be `/dist/index.js`.
Actions run from GitHub repos. We don't want to check in `node_modules`. Hence, we package the app using `npm run package`.
Then, push to the corresponding branch, respecting SemVer.