https://github.com/nitrictech/setup-nitric
Make nitric available for GitHub actions
https://github.com/nitrictech/setup-nitric
Last synced: about 1 year ago
JSON representation
Make nitric available for GitHub actions
- Host: GitHub
- URL: https://github.com/nitrictech/setup-nitric
- Owner: nitrictech
- License: apache-2.0
- Created: 2022-03-28T01:57:28.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-02T23:13:14.000Z (over 2 years ago)
- Last Synced: 2024-01-03T01:17:07.760Z (over 2 years ago)
- Language: TypeScript
- Homepage:
- Size: 93.8 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nitric Actions
### Deprecation notice
**Warning** This action has been deprecated.
Please use the [nitrictech/actions](https://github.com/nitrictech/actions) action
in [installation only mode](https://github.com/nitrictech/actions#installation-only).
#### Migrating to nitrictech/actions
To migrate, switch to `nitrictech/actions@v1`.
BeforeAfter
```yaml
- name: Install nitric
uses: nitrictech/setup-nitric@v1
```
---
```yaml
- name: Install nitric
uses: nitrictech/setup-nitric@v1
with:
version: 1.32.0
```
```yaml
- name: Install nitric
uses: nitrictech/actions@v1
```
---
```yaml
- name: Install nitric
uses: nitrictech/actions@v1
with:
version: 1.32.0
```
## Introduction
Nitric's GitHub Setup exposes the Nitric CLI to your GitHub workflow so that you can run any command you wish using actions.
> Note: Action runner must be set to linux, as MacOS runner does not include docker and Windows VMs are limited in depth.
```yaml
runs-on: ubuntu-latest
```
## Build
To update your changes, rebuild the dist folder with the following command -
```bash
npm run build
```
## Inputs
```yaml
version:
description: Version of the CLI being used
required: false
default: 1.2.1
```
## Example workflow
```yaml
name: Sample configuration to deploy to AWS
on:
workflow_dispatch:
push:
branches:
- main
env:
PULUMI_CONFIG_PASSPHRASE: ${{ secrets.PULUMI_CONFIG_PASSPHRASE }}
PULUMI_ACCESS_TOKEN: ${{ secrets.PULUMI_ACCESS_TOKEN }}
jobs:
update:
name: Deploy
runs-on: ubuntu-latest
steps:
- name: Configure AWS Credentials
uses: aws-actions/configure-aws-credentials@v1
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-region: ${{ secrets.AWS_REGION }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
- name: Install Nitric CLI
uses: nitrictech/setup-nitric@v1
with:
version: 1.2.1
- name: Install dependencies
uses: pulumi/setup-pulumi@v2
- name: Checkout project
uses: actions/checkout@v3
- name: Resolve packages
run: npm install
- name: Deploy stack to aws
run: nitric up -s dev -v0
```