Skip to content

Commit

Permalink
feat(trdl-actions): update typescript boilerplate for werf/trdl-actions
Browse files Browse the repository at this point in the history
Signed-off-by: Alexandr Zaytsev <[email protected]>
  • Loading branch information
nervgh committed Feb 21, 2025
1 parent f320041 commit 37ca067
Show file tree
Hide file tree
Showing 15 changed files with 27,420 additions and 46 deletions.
57 changes: 57 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,60 @@ ___

This repository allows you to organize CI/CD with GitHub Actions and
[trdl](https://trdl.dev/).

**Ready-to-use GitHub Actions Workflows** for different CI/CD workflows.

```yaml
- name: Install trdl
uses: werf/trdl-actions/install@v2
inputs:
channel: ...
version: ...

- name: Setup werf
uses: werf/trdl-actions/setup-repo@v2
inputs:
app: werf

- name: Run werf
run: |
. $(trdl use werf 2 alpha)
. $(werf ci-env github --as-file)
werf converge
env:
WERF_KUBECONFIG_BASE64: ${{ secrets.KUBE_CONFIG_BASE64_DATA }}
WERF_ENV: production
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
## Versioning
When using action, select the version corresponding to the required `MAJOR`
version of trdl.

By default, the action installs actual trdl version within _stable_ channel
(more details about channels, trdl release cycle and compatibility promise
[here](https://werf.io/installation.html#all-changes-in-werf-go-through-all-stability-channels)).
Using the `channel` input the user can switch the release channel.

> This is recommended approach to be up-to-date and to use actual trdl version
> without changing configurations.

```yaml
- uses: werf/trdl-actions/install@v2
with:
channel: stable
```

Withal, it is not necessary to work within release channels, and the user might
specify certain trdl version with `version` input.

```yaml
- uses: werf/trdl-actions/install@v2
with:
version: v2.1.0
```

## License

Apache License 2.0, see [LICENSE](LICENSE)
1 change: 1 addition & 0 deletions install/dist/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export {};
Loading

0 comments on commit 37ca067

Please sign in to comment.