generator-azuresfguest

Yeoman generator for Azure Service Fabric guest executable projects

Installation

First, install Yeoman and generator-azuresfguest using npm (we assume you have pre-installed npm and node.js).

npm install -g yo
npm install -g generator-azuresfguest

The commands might ask for root access. Please run them with sudo, if needed.

Then generate your new project:

yo azuresfguest

You can have a look at our documentation to understand how can you deploy the generated Service Fabric guest executable application

Getting To Know Yeoman

• Yeoman has a heart of gold.
• Yeoman is a person with feelings and opinions, but is very easy to work with.
• Yeoman can be too opinionated at times but is easily convinced not to be.
• Feel free to learn more about Yeoman.

License

MIT Copyright (c) Microsoft Corporation. All rights reserved.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Steps to contribute

Once you have figured out all the legalities above, you can follow the steps below -

• Create a fork of this repository
• Git clone the forked repository to your development box
• Make the changes
• You can update your local Yeo using npm link (or sudo npm link as required) at the project root-level
• Create a new project with yo azuresfguest (ensure it picks Yeo node-module bits from your local changes)
• Validate that changes are working as expected and not breaking anything regressively - following the steps mentioned in the documentation by creating and deploying the generated project on a Service Fabric cluster
• Raise a pull request and share with us

Known Issues

• If you are using Node 8.1.0 the yeoman generators freeze. The behaviour is that the prompt stops accepting input. Updating to Node 8.11.2 will fix this issue. Thanks to Nicolas for the call out #3.