Document how to use the Bitrise step (#3921)

* Document how to use the Bitrise step

* Update the CHANGELOG

* fix: remove unneeded run_if

Co-authored-by: Luis Padron <luis.padron@compass.com>

Co-authored-by: Pedro Piñera <pedro@ppinera.es>
Co-authored-by: Daniele Formichelli <df@bendingspoons.com>
Co-authored-by: Luis Padron <luis.padron@compass.com>
This commit is contained in:
Pedro Piñera Buendía 2021-12-30 09:22:20 +01:00 committed by GitHub
parent 0ccada5089
commit 663f286e1d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 3 deletions

View File

@ -8,6 +8,7 @@ Please, check out guidelines: https://keepachangelog.com/en/1.0.0/
- Add logging when helpers modules are being built [#3913](https://github.com/tuist/tuist/pull/3913) by [@luispadron](https://github.com/luispadron)
- Fix `tuist edit` compilation when building local helper modules that include remote plugins [#3918](https://github.com/tuist/tuist/pull/3918) by [@luispadron](https://github.com/luispadron)
- Document how to use the [Bitrise step](https://github.com/tuist/bitrise-step-tuist) [#3921](https://github.com/tuist/tuist/pull/3921) by [@pepicrft](https://github.com/pepicrft)
### Fixed
@ -24,7 +25,6 @@ Please, check out guidelines: https://keepachangelog.com/en/1.0.0/
- Add support for `exclusionRule` parameter to `Headers` [#3793](https://github.com/tuist/tuist/pull/3793) by [@pavel-trafimuk](https://github.com/pavel-trafimuk)
- Add generation time for `tuist focus` command [#3872](https://github.com/tuist/tuist/pull/3872) by [@adellibovi](https://github.com/adellibovi)
### Fixed
- Fix shell completion script generated in directory containing `.tuist_version` file [#3804](https://github.com/tuist/tuist/pull/3804) by [@mikchmie](https://github.com/mikchmie)

View File

@ -8,9 +8,9 @@ Tuist projects might need Tuist to be present in their continuous integration (C
To do so, you can add a step to your CI pipeline that executes the [installation command](/tutorial/get-started#install).
However, we recommend using pipeline steps designed by us. It's more convenient, and you'll benefit from optimizations and integrations with the underlying CI provider that otherwise you'd have to build yourself.
## GitHub Actions
### GitHub Actions
If your CI provider is GitHub Actions, you can run Tuist through the [tuist-action](https://github.com/tuist/tuist-action) GitHub Action. The action takes a `command` argument, which represents the Tuist command that will executed, for example, `generate`, and `arguments`, a string that contains all the arguments that will be passed alongside the command.
If your CI provider is [GitHub Actions](https://github.com/features/actions), you can run Tuist through the [tuist-action](https://github.com/tuist/tuist-action) GitHub Action. The action takes a `command` argument, which represents the Tuist command that will executed, for example, `generate`, and `arguments`, a string that contains all the arguments that will be passed alongside the command.
```yaml
# .github/workflows/my-project.yml
@ -32,4 +32,20 @@ jobs:
with:
command: 'build'
arguments: ''
```
### Bitrise
If your CI provider is [Bitrise](https://www.bitrise.io), we provide a plug-and-play [Bitrise Step](https://github.com/tuist/bitrise-step-tuist). The code snippet below shows an example of a `bitrise.yml` pipeline that builds a project using the step:
```yaml
format_version: 4
workflows:
build:
steps:
- git::https://github.com/tuist/bitrise-step-tuist.git:
title: Build project
inputs:
- command: build
```