https://github.com/genez-io/genezio-github-action
GitHub Action to deploy your code using genezio
https://github.com/genez-io/genezio-github-action
actions genezio github-actions serverless serverless-functions
Last synced: 8 months ago
JSON representation
GitHub Action to deploy your code using genezio
- Host: GitHub
- URL: https://github.com/genez-io/genezio-github-action
- Owner: Genez-io
- License: gpl-3.0
- Created: 2023-01-30T15:39:56.000Z (almost 3 years ago)
- Default Branch: production
- Last Pushed: 2024-12-09T16:33:57.000Z (about 1 year ago)
- Last Synced: 2025-04-14T23:06:27.910Z (8 months ago)
- Topics: actions, genezio, github-actions, serverless, serverless-functions
- Language: TypeScript
- Homepage: https://genez.io
- Size: 438 KB
- Stars: 7
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# genezio-github-action
[](https://github.com/Genez-io/genezio-github-action/actions/workflows/test.yml)
This action sets up a `genezio` environment for using it in actions.
## Usage
To deploy your project on `genezio` using GitHub Actions, you have to provide a `genezio` access token.
Follow these steps to setup a `genezio` access token to use GitHub Actions:
- Head to the `genezio` [dashboard](https://app.genez.io/settings/tokens) to generate a `genezio` access token.
- Store the access token as a GitHub secret in your repository. To see how to create an action secret check this [tutorial](https://docs.github.com/en/actions/security-guides/encrypted-secrets?tool=webui#creating-encrypted-secrets-for-a-repository).
In the examples below the secret is referred to as `secrets.GENEZIO_TOKEN`. Change accordingly for your project.
### Deployment
An example workflow to deploy the backend of your project with the latest version of `genezio`:
```yaml
name: genezio workflow
on:
push:
branches:
- main
jobs:
deploy-backend:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
- uses: Genez-io/genezio-github-action@v3
with:
token: ${{ secrets.GENEZIO_TOKEN }}
- name: Deploy backend
working-directory: ./
run: genezio deploy
```
You can test or check logs for the deployed project at https://app.genez.io.
## Documentation
To find more details on how to use `genezio`, check out the official [documentation](https://genez.io/docs):
- [Getting started](https://genezio.com/docs/getting-started/)
- [Integrations](https://docs.genez.io/genezio-documentation/integrations)
If you cannot find what you are looking for in the docs, don't hesitate to drop us a [GitHub issue](https://github.com/Genez-io/genezio/issues) or [start a discussion on Discord](https://discord.gg/uc9H5YKjXv).
## License
The associated scripts and documentation in this project are released under the GNU General Public License v3.0 license.