Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/teakowa/setup-serverless
⚡:octocat: A Github Action for deploying with the Serverless Framework (without Node)
https://github.com/teakowa/setup-serverless
continuous-integration github-actions serverless setup-serverless
Last synced: 30 days ago
JSON representation
⚡:octocat: A Github Action for deploying with the Serverless Framework (without Node)
- Host: GitHub
- URL: https://github.com/teakowa/setup-serverless
- Owner: Teakowa
- License: other
- Created: 2020-10-01T10:17:26.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-16T13:31:30.000Z (about 1 month ago)
- Last Synced: 2024-11-16T14:26:47.943Z (about 1 month ago)
- Topics: continuous-integration, github-actions, serverless, setup-serverless
- Language: TypeScript
- Homepage:
- Size: 6.27 MB
- Stars: 8
- Watchers: 2
- Forks: 3
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG-1.x.md
- License: LICENSE-ANTI996
Awesome Lists containing this project
README
# setup-serverless
[](https://github.com/Teakowa/setup-serverless/actions/workflows/continuous-integration.yml)
[](#contributors-)
[](#LICENSE)
[](https://github.com/996icu/996.ICU/blob/master/LICENSE)
[](https://996.icu)
This action provides the following functionality for GitHub Actions users:
- Easily install Serverless without Node.js or npm.
- The action can also cache the distribution of the required standalone Serverless binary and add it to the system PATH.
Once you've utilized the action, other steps in the same job can run various Serverless commands using [GitHub Actions run syntax]((https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsrun)). This enables most Serverless commands to function similarly to how they do on your local command line.
## Usage
This action can be run on `ubuntu-latest` and `macos-latest` GitHub Actions runners.
The default configuration installs the latest version of Serverless CLI
**Basic:**
```yaml
steps:
- uses: Teakowa/setup-serverless@v3
with:
serverless_version: 3.9.0
provider: aws
env:
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY}}
- run: sls deploy
```
The `serverless_version` input is optional. If not supplied, the serverless version from the latest release will be used.
The action will first check the local cache for a semver match. If unable to find a specific version in the cache, the action will attempt to download a version of Serverless. It will pull `latest` versions from serverless-versions releases.
### Supported version syntax
The `serverless_version` input not yet support the Semantic Versioning Specification, We have plans to add this support, and welcome PR.
Examples:
- Specific versions: `2.71.0`, `3.9.0`
- Latest release: `latest`
`latest` always install to the [latest release version](https://github.com/serverless/serverless/releases).
## Support Providers
- [AWS](#aws)
- [Azure](#azure)
- [Tencent](#tencent-cloud)
- knative
- [Alibaba Cloud](#aliyun)
- [cloudflare workers](#cloudflare-workers)
- fn
- kubeless
- openwhisk
Some providers need to be configured with credentials files, and this process will be performed by the `provider` input, which will automatically generate the corresponding credentials file when the `provider` contains these providers.
### AWS
Credentials for AWS can be configured.
```yaml
steps:
- uses: Teakowa/setup-serverless@v3
with:
provider: aws
env:
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY}}
- run: sls deploy
```
### Azure
Credentials for Azure can be configured.
```yaml
steps:
- uses: Teakowa/setup-serverless@v3
with:
provider: azure
env:
AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID}}
AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID}}
AZURE_CLIENT_SECRET: ${{ secrets.AZURE_CLIENT_SECRET}}
- run: sls deploy
```
### Tencent Cloud
Credentials for Tencent Cloud can be configured.
```yaml
steps:
- uses: Teakowa/setup-serverless@v3
with:
provider: tencent
env:
TENCENT_APPID: ${{ secrets.TENCENT_APP_ID }}
TENCENT_SECRET_ID: ${{ secrets.TENCENT_SECRET_ID }}
TENCENT_SECRET_KEY: ${{ secrets.TENCENT_SECRET_KEY}}
- run: sls deploy
```
> **Note**
> If you need to use Tencent Cloud in China, you need to set the environment variable `SERVERLESS_PLATFORM_VENDOR` to tencent.
>
> You don't need `TENCENT_TOKEN`, because it is not currently supported.
```yaml
steps:
- uses: Teakowa/setup-serverless@v3
with:
provider: tencent
env:
TENCENT_APPID: ${{ secrets.TENCENT_APP_ID }}
TENCENT_SECRET_ID: ${{ secrets.TENCENT_SECRET_ID }}
TENCENT_SECRET_KEY: ${{ secrets.TENCENT_SECRET_KEY}}
SERVERLESS_PLATFORM_VENDOR: tencent # Must be set here to use in China
- run: sls deploy
```
### Aliyun
Credentials for Aliyun can be configured.
```yaml
steps:
- uses: Teakowa/setup-serverless@v3
with:
provider: aliyun
env:
ALICLOUD_ACCOUNT_ID: ${{ secrets.ALICLOUD_ACCOUNT_ID }}
ALICLOUD_ACCESS_KEY: ${{ secrets.ALICLOUD_ACCESS_KEY }}
ALICLOUD_SECRET_KEY: ${{ secrets.ALICLOUD_SECRET_KEY}}
- run: sls deploy
```
### Cloudflare Workers
Credentials for Cloudflare Workers can be configured.
```yaml
steps:
- uses: Teakowa/setup-serverless@v3
with:
provider: cloudflare-workers
env:
CLOUDFLARE_AUTH_KEY: ${{ secrets.CLOUDFLARE_AUTH_KEY }}
CLOUDFLARE_AUTH_EMAIL: ${{ secrets.CLOUDFLARE_AUTH_EMAIL }}
- name: Deploy
run: |
sls plugin install -n serverless-cloudflare-workers
sls deploy
env:
CLOUDFLARE_AUTH_KEY: ${{ secrets.CLOUDFLARE_AUTH_KEY }}
CLOUDFLARE_AUTH_EMAIL: ${{ secrets.CLOUDFLARE_AUTH_EMAIL }}
CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
CLOUDFLARE_ZONE_ID: ${{ secrets.CLOUDFLARE_ZONE_ID }}
CLOUDFLARE_WORKER_NAME: ${{ secrets.CLOUDFLARE_WORKER_NAME }}
```
## Inputs
The action supports the following inputs:
- `serverless_version`: (optional) The version of Serverless CLI to install.
- `provider`: (**required**) The infrastructure provider of serverless framework. All characters must be lowercase.
## Versioning
- Use the `v3` tag as `setup-serverless` version. It is a rolling tag and is synced with the latest minor and patch releases. With `v3` you automatically get the bug fixes, security patches, new features and support for latest `setup-serverless` releases.
- Semantic release versions can also be used. It is recommended to [use dependabot](https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot) with semantic versioning to keep the actions in your workflows up to date.
## Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/Teakowa/setup-serverless/issues).
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
ƬΣΛKӨЩΛ
💻 📖 🎨 📆
Add your contributions
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
## License
The code in this repository, unless otherwise noted, is under the terms of both the [Anti 996](./LICENSE-ANTI996) License and the [Apache License (Version 2.0)](./LICENSE-APACHE).
