Skip to content

Commit

Permalink
wip
Browse files Browse the repository at this point in the history
  • Loading branch information
shuheiktgw committed Jan 15, 2021
1 parent 9bd00dd commit 83f5fa6
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 14 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,26 @@ $ pip install nose-launchable

## Usage

### Reorder

```
$ nosetests --launchable-reorder --launchable-build-number <build number>
```

### Subset

```
$ nosetests --launchable --launchable-build-number <build number>
$ nosetests --launchable-subset --launchable-build-number <build number> --launchable-subset-target <target percentage>
```
In addition to specifying the `--launchable` flag, you need to set the following environment variables in your environment. These values should be provided from Launchable.

In addition to specifying the `--launchable-reorder` / `--launchable-subset` flag, you may need to set the following environment variables in your environment. These values should be provided from Launchable.

| Key | Description |
| ---- | ---- |
| LAUNCHABLE_BASE_URL | A Launchable API URL. Default is `https://api.mercury.launchableinc.com` |
| LAUNCHABLE_BUILD_NUMBER | A CI/CD build number |
| LAUNCHABLE_DEBUG | Prints out debug logs |
| LAUNCHABLE_TOKEN | A token to access Launchable API |
| LAUNCHABLE_BASE_URL | (Optional) A Launchable API URL. Default is `https://api.mercury.launchableinc.com` |
| LAUNCHABLE_BUILD_NUMBER | (Optional) A CI/CD build number |
| LAUNCHABLE_DEBUG | (Optional) Prints out debug logs |
| LAUNCHABLE_TOKEN | (Required) A token to access Launchable API |

## Development
Pull requests are always appreciated. If you want to see whether your changes work as expected, run the following command to install the plugin locally.
Expand Down
29 changes: 21 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,39 @@ Install
Usage
-----

Reorder
~~~~~~~

::

$ nosetests --launchable-reorder --launchable-build-number <build number>

Subset
~~~~~~

::

$ nosetests --launchable --launchable-build-number <build number>
$ nosetests --launchable-subset --launchable-build-number <build number> --launchable-subset-target <target percentage>

In addition to specifying the ``--launchable`` flag, you need to set the
following environment variables in your environment. These values should
be provided from Launchable.
In addition to specifying the ``--launchable-reorder`` /
``--launchable-subset`` flag, you may need to set the following
environment variables in your environment. These values should be
provided from Launchable.

+-----------------------------------+-----------------------------------+
| Key | Description |
+===================================+===================================+
| LAUNCHABLE_BASE_URL | A Launchable API URL. Default is |
| LAUNCHABLE_BASE_URL | (Optional) A Launchable API URL. |
| | Default is |
| | ``https: |
| | //api.mercury.launchableinc.com`` |
+-----------------------------------+-----------------------------------+
| LAUNCHABLE_BUILD_NUMBER | A CI/CD build number |
| LAUNCHABLE_BUILD_NUMBER | (Optional) A CI/CD build number |
+-----------------------------------+-----------------------------------+
| LAUNCHABLE_DEBUG | Prints out debug logs |
| LAUNCHABLE_DEBUG | (Optional) Prints out debug logs |
+-----------------------------------+-----------------------------------+
| LAUNCHABLE_TOKEN | A token to access Launchable API |
| LAUNCHABLE_TOKEN | (Required) A token to access |
| | Launchable API |
+-----------------------------------+-----------------------------------+

Development
Expand Down

0 comments on commit 83f5fa6

Please sign in to comment.