Skip to content

Commit

Permalink
Version bump and doc updates for 0.3.0 release.
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris Tavares committed Dec 14, 2016
1 parent db13312 commit 3178a9b
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 36 deletions.
56 changes: 30 additions & 26 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Although our current feature set is minimal, all the existing Mobile Center serv

# Prerequisites

Mobile Center CLI requires Node.js version 6.3 or better.
Mobile Center CLI requires Node.js version 6.3 or better. Do not use Node.js 7.1.0, there is a known issue that breaks the CLI code (and many other projects) on Windows 10. This bug has been fixed in later releases of Node.js 7.

# Installation

Expand All @@ -26,33 +26,37 @@ To get help on a specific command or category, run `mobile-center help command`

Below is the list of commands currently supported by Mobile Center CLI:


| Command | Description |
| ------------------------------------- | -------------------------------------------------------------- |
| `mobile-center help` | Get command or category help |
| `mobile-center login` | Login to Mobile Center |
| `mobile-center logout` | Logout from Mobile Center |
| | |
| `mobile-center apps create` | Create a new app |
| `mobile-center apps get-current` | Get the application that's set as default for all CLI commands |
| `mobile-center apps list` | Get list of configured applications |
| `mobile-center apps set-current` | Set default application for all CLI commands |
| `mobile-center apps show` | Show the details of a specific app |
| `mobile-center apps update` | Update the details of an app |
| `mobile-center apps delete` | Delete an app |
| | |
| `mobile-center profile configure` | Update user information |
| `mobile-center profile list` | Get information about logged in user |
| | |
| `mobile-center test status` | Checks status of started test run. |
| `mobile-center test prepare appium` | Creates artifacts directory with Appium tests. |
| `mobile-center test prepare calabash` | Creates artifacts directory with Calabash tests. |
| `mobile-center test prepare espresso` | Creates artifacts directory with Espresso tests. |
| `mobile-center test prepare uitest` | Creates artifacts directory with Xamarin UI Tests. |
| `mobile-center test run appium` | Starts test run with Appium tests. |
| `mobile-center test run calabash` | Starts test run with Calabash tests. |
| `mobile-center test run espresso` | Starts test run with Espresso tests. |
| `mobile-center test run manifest` | Starts test run with previously prepared artifacts. |
| `mobile-center test run uitest` | Starts test run with Xamarin UI Tests. |
| `mobile-center help` | Get command or category help |
| `mobile-center login` | Login to Mobile Center |
| `mobile-center logout` | Logout from Mobile Center |
| | |
| `mobile-center apps create` | Create a new app |
| `mobile-center apps delete` | Delete an app |
| `mobile-center apps get-current` | Get the application that's set as default for all CLI commands |
| `mobile-center apps list` | Get list of configured applications |
| `mobile-center apps set-current` | Set default application for all CLI commands |
| `mobile-center apps show` | Get the details of an app |
| `mobile-center apps update` | Update an app |
| | |
| `mobile-center profile list` | Get information about logged in user |
| `mobile-center profile update` | Update user information |
| `mobile-center test status` | Checks status of started test run. |
| `mobile-center test prepare appium` | Creates artifacts directory with Appium tests. |
| `mobile-center test prepare calabash` | Creates artifacts directory with Calabash tests. |
| `mobile-center test prepare espresso` | Creates artifacts directory with Espresso tests. |
| `mobile-center test prepare uitest` | Creates artifacts directory with Xamarin UI Tests. |
| `mobile-center test run appium` | Starts test run with Appium tests. |
| `mobile-center test run calabash` | Starts test run with Calabash tests. |
| `mobile-center test run espresso` | Starts test run with Espresso tests. |
| `mobile-center test run manifest` | Starts test run with previously prepared artifacts. |
| `mobile-center test run uitest` | Starts test run with Xamarin UI Tests. |
| | |
| `mobile-center tokens create` | Create a new API token |
| `mobile-center tokens delete` | Delete an API token |
| `mobile-center tokens list` | Get a list of API tokens |

Please use the `mobile-center help` command to get more information about each one.

Expand Down
25 changes: 16 additions & 9 deletions contributing.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,15 @@ works well.
#### Typescript compiler and Typings

The typescript compilation can be run via the `npm run build` command, but if you want the Typescript compiler available directly,
install it on you machine by doing `npm install -g [email protected]`.
install it on your machine by doing `npm install -g [email protected]`.

The Typings tool is useful if you're bringing in a new exteral Javascript library and want to get access to type definitions
for that library. The typings files are checked into the repo, but if you want to download and add new ones, you'll need to
install typings: `npm install -g typings`.

Do _not_ run `typings install` - the typings files are already included in the repos, and this would overwrite necessary changes to the
type declaration files.

#### gulp

gulp is used as a task runner to get everything built and in the right place. Everything is hooked up through NPM scripts, but if you
Expand All @@ -63,7 +66,7 @@ see the [Mono download page](http://www.mono-project.com/download/) for download
## Troubleshooting

If you are running on a Mac and have to use `sudo` to install global npm modules (for example, `npm install -g typescript`),
the please check out [this tutorial](https://docs.npmjs.com/getting-started/fixing-npm-permissions).
then please check out [this tutorial](https://docs.npmjs.com/getting-started/fixing-npm-permissions).

# Building

Expand Down Expand Up @@ -104,16 +107,20 @@ There will be more over time.

The gulpfile.js file contains the following targets that can be called manually if you desire

| Target | npm script |What it does |
|--------|------------|-------------|
| `clean` | `clean` | Deletes the dist folder |
| Target | npm script | What it does |
|--------|------------|--------------|
| `default` | | Runs the `build` task |
| `autorest` | `autorest` | Regenerate client code from swagger/bifrost.swagger.json file |
| `build` | `build` | Runs the build (build-ts, copy-assets, copy-generated-clients) |
| `build-sourcemaps` | | Create sourcemap files for the compiled typescript to aid in debugging |
| `build-ts-sourcemaps` | | Run Typescript compiler to output sourcemap files |
| `build-ts` | | Runs typesscript compiler, using settings in tsconfig.json |
| `clean` | `clean` | Deletes the dist folder |
| `clean-autorest` | | Deleted all generated code from src directory |
| `clean-sourcemaps` | | Delete generated source map files from dist directory |
| `copy-assets` | | Copies .txt files from src to dist (category descriptions) |
| `copy-generated-client` | | Copies the generated HTTP client code to dist |
| `build` | `build` | Runs the build (build-ts, copy-assets, copy-generated-clients) |
| `clean-autorest` | | Deleted all generated code from src directory |
| `autorest` | `autorest` | Regenerate client code from swagger/bifrost.swagger.json file |
| `default` | | Runs the build task |
| `prepublish` | `prepublish` | Runs the `clean` and `build` tasks before publishing to npm |

# Touring the codebase

Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "mobile-center-cli",
"version": "0.2.1",
"version": "0.3.0",
"description": "Command line tool for Microsoft Mobile Center",
"keywords": [
"microsoft",
Expand Down

0 comments on commit 3178a9b

Please sign in to comment.