Skip to content

Commit

Permalink
📝 feat: improve documentation for platform-only option in README.md a…
Browse files Browse the repository at this point in the history
…nd action.yml
  • Loading branch information
brunocleite committed Sep 6, 2024
1 parent 102d200 commit fe13ef8
Showing 4 changed files with 14 additions and 9 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -11,17 +11,17 @@ installing the providers.

It automatically caches the providers if SST version in `package-lock.json` and
`sst.config.ts` files have not changed.
It is assuming that your providers are
listed in `sst.config.ts` and not referenced to another file.
It is assuming that your providers are listed in `sst.config.ts` and not
referenced to another file.

## Inputs

- **Optional**: `sst-folder` - the location of the SST folder.
Defaults to `./`
- **Optional**: `platform-only` - only caches the platform. Useful for linting runs that will not deploy.
Defaults to `false`
-
Sample with defaults:
- **Optional**: `platform-only` - Only caches the SST platform files on
'.sst/platform'. Useful for linting runs that will not deploy. Defaults to
`false`
- Sample with defaults:

```yaml
- name: Setup SST
5 changes: 5 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
@@ -12,6 +12,11 @@ inputs:
sst-folder:
description: 'SST folder location'
default: './'
platform-only:
description:
"Only caches the SST platform files on '.sst/platform'. Useful for linting
runs that will not deploy."
default: 'false'

runs:
using: node20
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "setup-sst-v3",
"description": "GitHub Actions to setup SST v3 with caching enabled",
"version": "0.0.54",
"version": "0.0.55",
"author": "",
"private": true,
"homepage": "https://github.com/brunocleite/setup-sst",

0 comments on commit fe13ef8

Please sign in to comment.