https://github.com/omnistrate-oss/setup-omnistrate-ctl
Omnsitrate's Setup CTL github action
https://github.com/omnistrate-oss/setup-omnistrate-ctl
ci deployment saas
Last synced: 2 months ago
JSON representation
Omnsitrate's Setup CTL github action
- Host: GitHub
- URL: https://github.com/omnistrate-oss/setup-omnistrate-ctl
- Owner: omnistrate-oss
- License: mit
- Created: 2024-08-09T05:13:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-14T18:14:15.000Z (2 months ago)
- Last Synced: 2026-01-14T22:36:08.258Z (2 months ago)
- Topics: ci, deployment, saas
- Language: TypeScript
- Homepage: https://omnistrate.com/
- Size: 1.17 MB
- Stars: 16
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Setup Omnistrate CTL
[](https://github.com/super-linter/super-linter)
[](https://github.com/actions/setup-omnistrate-ctl/actions/workflows/check-dist.yml)
[](https://github.com/actions/setup-omnistrate-ctl/actions/workflows/codeql-analysis.yml)
[](./badges/coverage.svg)
## About
This action allows you to easily setup Omnistrate CTL command like to be able to
create and operate Omnistrate services. It allows to setup a email and password
to use to login to Omnistrate, we recommend storing the email and passwords as
secrets in GitHub and reference those secrets from the Action. It also allows to
optionally set up a version of the Omnistrate CTL command to use or uses latest
by default. Using this action ensures that the logout command is executed at the
end of the workflow so the temporal token to access Omnistrate is removed from
the host machine.
---
- [Usage](#usage)
- [Customizing](#customizing)
- [inputs](#inputs)
- [Contributing](#contributing)
- [About Omnistrate](#about-omnistrate)
---
---
## Usage
- **Create secrets in your repository for your Omnistrate email and password**
```yaml
- name: Setup Omnistrate CTL
uses: omnistrate-oss/setup-omnistrate-ctl@v1
with:
email: ${{ secrets.OMNISTRATE_USERNAME }}
password: ${{ secrets.OMNISTRATE_PASSWORD }}
version: latest # OPTIONAL
# Execute and example command
- name: Test CTL command
shell: bash
run: |
# rum simple command as an example
omnistrate-ctl --version
# omctl alias is also supported
omctl --version
```
## Customizing
### inputs
The following inputs can be used as `step.with` keys:
| Name | Type | Description |
| ---------- | ------ | ------------------------------------------------- |
| `email` | String | Email of the user used to log in to Omnistrate |
| `password` | String | Password of the user used to log in to Omnistrate |
| `version` | String | Version of the CTL to used (default:latest) |
## Contributing
Want to contribute? Awesome! You can find information about contributing to this
project in the [CONTRIBUTING](/CONTRIBUTING.md) page
## About Omnistrate
[Omnistrate](https://omnistrate.com/) is the operating system for your SaaS,
offering enterprise-grade capabilities: automated provisioning, serverless
capabilities, auto-scaling, billing, monitoring, centralized logging,
self-healing, intelligent patching and much more!