https://github.com/stoplightio/stoplight-cli-workflow
Stoplight CLI action
https://github.com/stoplightio/stoplight-cli-workflow
Last synced: 3 months ago
JSON representation
Stoplight CLI action
- Host: GitHub
- URL: https://github.com/stoplightio/stoplight-cli-workflow
- Owner: stoplightio
- License: apache-2.0
- Created: 2021-10-19T22:12:55.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-04T19:57:06.000Z (over 4 years ago)
- Last Synced: 2026-01-15T20:25:11.605Z (5 months ago)
- Size: 29.3 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Stoplight CLI Workflow
Use this workflow to push data to Stoplight CLI projects from your GitHub repository
## When will this push data?
When there's a push made to the `default branch` or branches starting with `design/` **OR** when a pull request is made in the repository on **any** branch
**AND**
When theres a change in `json`,`yaml`,`yml` or `md` files
## Using the Stoplight CLI Workflow
1. Create a `.github/workflows` folder in your repository
2. Copy the `stoplight-cli-workflow.yml` file into the `.github/workflows` folder you created in Step 1
3. Add your project CI token on Line 28. You can get the CI token from the project settings of a CLI project.
4. Add your project URL on Line 30. You can get the project URL from the browser bar. e.g. `https://your-workspace.stoplight.io/project-name`.
5. Create a PR to see it work