Skip to content

Commit

Permalink
Update README.md (#10)
Browse files Browse the repository at this point in the history
* Update README.md

I have made some grammatical changes.I am an English college professor and part time coder hope this helps

* Update README.md

Co-authored-by: Olivér Falvai <[email protected]>
  • Loading branch information
goodbrothero and ofalvai authored Oct 13, 2021
1 parent 9c5dc3b commit b40be23
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Go test

## How to use this Step

Can be run directly with the [bitrise CLI](https://github.com/bitrise-io/bitrise),
It 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`.

Expand All @@ -15,11 +15,11 @@ 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)
3. `cd` into the directory of the step (the one which was 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.
* 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:
Expand All @@ -42,7 +42,7 @@ envs:

__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:**
**NOTE**

If you want to use your step in your project's `bitrise.yml`:

Expand All @@ -64,16 +64,16 @@ in the [bitrise CLI repository](https://github.com/bitrise-io/bitrise/blob/maste

1. Fork this repository
2. `git clone` it
3. Create a branch you'll work on
3. Create a branch that 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
5. Do the changes you want to do
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
7. Once you're done, commit your changes & create a Pull Request


## Share your own Step
Expand Down

0 comments on commit b40be23

Please sign in to comment.