https://github.com/stepzen-dev/stepzen-deploy
GitHub action to deploy a StepZen schema.
https://github.com/stepzen-dev/stepzen-deploy
Last synced: 4 months ago
JSON representation
GitHub action to deploy a StepZen schema.
- Host: GitHub
- URL: https://github.com/stepzen-dev/stepzen-deploy
- Owner: stepzen-dev
- License: mit
- Created: 2024-05-23T15:05:46.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-23T15:44:47.000Z (about 2 years ago)
- Last Synced: 2025-05-08T00:13:46.670Z (about 1 year ago)
- Size: 2.93 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# stepzen-login
This action deploys a StepZen schema assuming the environment has been logged into a StepZen account.
# What's new
First release
# Usage
## Pre-requisites
- Node
- StepZen CLI must be installed, see [stepzen-dev/stepzen-install action](https://github.com/stepzen-dev/stepzen-install/blob/main/README.md).
- Logged into StepZen account, see [stepzen-dev/stepzen-login action](https://github.com/stepzen-dev/stepzen-login/blob/main/README.md).
## Inputs
- `dir` - directory containing index.graphql
- `folder` - folder name for the endpoint
- `name` - name for the endpoint
- `tag` - tag to be appended to endpoint name (default empty), typically useful when testing to create a unique endpoint.
## Outputs
- `endpoint` - Endpoint name, for example `api/customers`
- `url` - Full URL of the deployed GraphQL endpoint
## Examples
### Standard deployment
```yaml
- uses: stepzen-dev/stepzen-deploy
with:
workspace: "schema/customers'
folder: qa
name: customers
```
### Unit testing
Using a tag such as the GitHub run identifier can ensure that concurrent runs of workflows do not conflict with each other.
```yaml
- uses: stepzen-dev/stepzen-deploy
with:
workspace: "schema/customers"
folder: unittest
name: customers
tag: ${{ github.run_id }}
```