Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iamlizu/verceler
Automates tag or released based deployments on Vercel using GitHub Actions
https://github.com/iamlizu/verceler
automation ci cicd devops github-actions vercel vercel-deployment
Last synced: 13 days ago
JSON representation
Automates tag or released based deployments on Vercel using GitHub Actions
- Host: GitHub
- URL: https://github.com/iamlizu/verceler
- Owner: IamLizu
- License: mit
- Created: 2024-06-03T13:01:25.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-08-01T08:22:05.000Z (4 months ago)
- Last Synced: 2024-10-24T15:06:04.170Z (22 days ago)
- Topics: automation, ci, cicd, devops, github-actions, vercel, vercel-deployment
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/verceler
- Size: 94.7 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# verceler
`verceler` is a CLI tool that simplifies and automates the process of deploying based on tags/releases to Vercel. It helps you automate trunk-based development and deploy through tags and releases.
## Installation
To install `verceler`, you can use npm or yarn:
```sh
npm install -g verceler
```
or
```sh
yarn global add verceler
```
## Usage
After installing verceler, you can use it via the command line. Here are some common commands and options:
```sh
verceler -vt -gt [options]
```
### Options
| Option | Description |
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `--vercel-token, -vt ` | Your Vercel API token. |
| `--github-token, -gt ` | Your GitHub API token. |
| `--create-github-workflow, -cgw` | Create a GitHub Actions workflow file for Vercel deployment. |
| `--debug, -d` | Enable debug mode to log extra information. |
| `--load-env, -le ` | Comma-separated list of environments to set variables in Vercel projects (e.g., preview,development,production). |
| `--domain, -dom ` | Domain name to set up with your Vercel project. |
### Example
```sh
verceler -vt your_vercel_token -gt your_github_token --create-github-workflow --load-env preview,development,production --domain yourdomain.com
```
This command will:
1. Create a GitHub Actions workflow file for Vercel deployment.
2. Install the Vercel CLI globally if not already installed.
3. Link the project to Vercel.
4. Load environment variables from .env.local and set them in Vercel for the specified environments.
5. Set up the necessary GitHub secrets for Vercel deployment.
6. Add the specified domain to your Vercel project.
## Contributing
We welcome contributions to verceler. To contribute, follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with descriptive messages.
4. Push your changes to your fork.
5. Submit a pull request to the main repository.
### Running Tests
To run the test suite, use the following command:
```sh
yarn test --verbose --coverage
```
This will run all the unit tests and provide you with a coverage report. Make sure to write tests for any new features or bug fixes you add.
### Code Style
We follow standard JavaScript coding conventions. Please make sure your code adheres to these conventions before submitting a pull request.
## License
`verceler` is licensed under the MIT License. See the [LICENSE](./LICENSE.md) file for more details.
---
We hope verceler makes your Vercel deployments easier and more efficient. If you have any questions or feedback, feel free to open an issue or reach out to us.