https://github.com/bitrise-steplib/steps-appetize-io-deploy
https://github.com/bitrise-steplib/steps-appetize-io-deploy
bitrise bitrise-step ci production-code
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/bitrise-steplib/steps-appetize-io-deploy
- Owner: bitrise-steplib
- License: mit
- Created: 2018-05-28T15:47:26.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-10-03T11:50:38.000Z (over 2 years ago)
- Last Synced: 2025-03-24T07:52:23.488Z (about 1 year ago)
- Topics: bitrise, bitrise-step, ci, production-code
- Language: Go
- Homepage:
- Size: 37.1 KB
- Stars: 1
- Watchers: 11
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Appetize.io deploy
## 📄 Description
Bitrise step to facilitate deployment of your app to Appetize.io
## :arrow_right: Inputs
| Name | Description | Required | Default |
|----------------|-------------------------------------------------------------------------------------------|--------------------|--------------------------|
| app_path | The full path to the application file (.app, .zip, .tar.gz, or .apk) | :white_check_mark: | |
| appetize_token | The API token provided by Appetize.io | :white_check_mark: | |
| public_key | The public key in case you want to deploy this build to an existing app | | |
| appetize_api | Allows for customized Appetize.io API endpoints, e.g. Public vs Private Cloud deployments | :white_check_mark: | @api.appetize.io/v1/apps |
| appetize_host | Allows for customized Appetize.io hosts, e.g. Public vs Private Cloud deployments | :white_check_mark: | appetize.io |
## :arrow_left: Outputs
| Name | Description |
|------------------|---------------------------|
| APPETIZE_APP_URL | The URL to access the app |
## 🛠Developer Setup
### How to use this Step
Can be run directly with the [bitrise CLI](https://github.com/bitrise-io/bitrise),
just `git clone` this repository, `cd` into it's folder in your Terminal/Command Line
and call `bitrise run test`.
*Check the `bitrise.yml` file for required inputs which have to be
added to your `.bitrise.secrets.yml` file!*
Step by step:
1. Open up your Terminal / Command Line
2. `git clone` the repository
3. `cd` into the directory of the step (the one you just `git clone`d)
5. Create a `.bitrise.secrets.yml` file in the same directory of `bitrise.yml`
(the `.bitrise.secrets.yml` is a git ignored file, you can store your secrets in it)
6. Check the `bitrise.yml` file for any secret you should set in `.bitrise.secrets.yml`
* Best practice is to mark these options with something like `# define these in your .bitrise.secrets.yml`, in the `app:envs` section.
7. Once you have all the required secret parameters in your `.bitrise.secrets.yml` you can just run this step with the [bitrise CLI](https://github.com/bitrise-io/bitrise): `bitrise run test`
An example `.bitrise.secrets.yml` file:
```
envs:
- A_SECRET_PARAM_ONE: the value for secret one
- A_SECRET_PARAM_TWO: the value for secret two
```
### How to create your own step
1. Create a new git repository for your step (**don't fork** the *step template*, create a *new* repository)
2. Copy the [step template](https://github.com/bitrise-steplib/step-template) files into your repository
3. Fill the `step.sh` with your functionality
4. Wire out your inputs to `step.yml` (`inputs` section)
5. Fill out the other parts of the `step.yml` too
6. Provide test values for the inputs in the `bitrise.yml`
7. Run your step with `bitrise run test` - if it works, you're ready
__For Step development guidelines & best practices__ check this documentation: [https://github.com/bitrise-io/bitrise/blob/master/_docs/step-development-guideline.md](https://github.com/bitrise-io/bitrise/blob/master/_docs/step-development-guideline.md).
**NOTE:**
If you want to use your step in your project's `bitrise.yml`:
1. git push the step into it's repository
2. reference it in your `bitrise.yml` with the `git::PUBLIC-GIT-CLONE-URL@BRANCH` step reference style:
```
- git::https://github.com/user/my-step.git@branch:
title: My step
inputs:
- my_input_1: "my value 1"
- my_input_2: "my value 2"
```
You can find more examples of step reference styles
in the [bitrise CLI repository](https://github.com/bitrise-io/bitrise/blob/master/_examples/tutorials/steps-and-workflows/bitrise.yml#L65).
### How to contribute to this Step
1. Fork this repository
2. `git clone` it
3. Create a branch you'll work on
4. To use/test the step just follow the **How to use this Step** section
5. Do the changes you want to
6. Run/test the step before sending your contribution
* You can also test the step in your `bitrise` project, either on your Mac or on [bitrise.io](https://www.bitrise.io)
* You just have to replace the step ID in your project's `bitrise.yml` with either a relative path, or with a git URL format
* (relative) path format: instead of `- original-step-id:` use `- path::./relative/path/of/script/on/your/Mac:`
* direct git URL format: instead of `- original-step-id:` use `- git::https://github.com/user/step.git@branch:`
* You can find more example of alternative step referencing at: https://github.com/bitrise-io/bitrise/blob/master/_examples/tutorials/steps-and-workflows/bitrise.yml
7. Once you're done just commit your changes & create a Pull Request
### Share your own Step
You can share your Step or step version with the [bitrise CLI](https://github.com/bitrise-io/bitrise). If you use the `bitrise.yml` included in this repository, all you have to do is:
1. In your Terminal / Command Line `cd` into this directory (where the `bitrise.yml` of the step is located)
1. Run: `bitrise run test` to test the step
1. Run: `bitrise run audit-this-step` to audit the `step.yml`
1. Check the `share-this-step` workflow in the `bitrise.yml`, and fill out the
`envs` if you haven't done so already (don't forget to bump the version number if this is an update
of your step!)
1. Then run: `bitrise run share-this-step` to share the step (version) you specified in the `envs`
1. Send the Pull Request, as described in the logs of `bitrise run share-this-step`
That's all ;)
### Trigger a new release
- __merge every code changes__ to the `master` branch
- __push the new version tag__ to the `master` branch