Month: July 2016
This post is here in order to help you to improve quality on published extension on market place, because we have lot of extensions without documentation, so it’s very hard to use theses, we can add documentation easily by defining markdown.
We have set of steps to follow in order to document.
1. Create your markdown file , add readme.md to your library, if you have one extension library with set of task, suggest you to have one mardown for all tasks.
Remarks: Your file don’t need to be copied in content, let default options.
Below samples of common syntax of markdown :
# This is an H1
## This is an H2
###### This is an H6
This is [an example](http://www.amayestech.com/) inline link.
You can also install markdown extension in order to modify easily :
After installing Markdown Editor, can view the design of my code, view small symbol M on my file.
complete doc here : https://code.visualstudio.com/docs/languages/markdown
2. Register your readme.md file into manifeste extension by adding section of code below
3. For this sample we add images in readme.md, theses images must be copied to directory img (content / do not copy)
and registered into manifeste extension
Now after packaging and publishing actions, if we go to market place manager, we can view documentation of your extension.
In order apeak about solution , we explain just that we have two aspects to setup, packaging and publishing, we begin with our sample with packaging.
- PACKAGING View
For the packaging we follow steps below in order to construct our package, the result of this step is vsix file.
1. Setup Node.js
2. Install vset tool with this command : npm install vset –save-dev
3. Run Node.js command prompt tool (C:\Windows\System32\cmd.exe /k “C:\Program Files (x86)\nodejs\nodevars.bat”)
4. Locate you on directory of your extension
5. Run vset package command
Your vsix is generated into your root irectory
For information you can inspect content of your extension, by unzip your vsix
- PUBLISHING View
Before publish our extension it’s possible to visit differents extension avaiable on the cloud, it’s possible to download and install on premise version of tfs, in order to reuse.
We choose to publish our expansion on the market place on Azure
We follow theses steps, firstly we create a publisher, secondly
1. Go to https://marketplace.visualstudio.com/manage/publishers/
2. Choose to create a publisher by completing a unique Id
3. Upload your extension by drag and drop your vsix
4. Correct and adapt your manifest information
5. Now it’s ok and my vsix is downloaded
6. Share my extension on my account azure, an it’s possible to update my version on clickin on update button
7. Go to admin tfs section, and selection extension tab, clck on my extension target
8. On Build VNEXT find my created extension
Start by downloading a template project, you have two project templates, one dedicated to the integration part, another dedicated to the realization of custom build or release tasks.
In this post we will realize an extension that will aim to start an application pool, without managing this specify.
For the part back we will combine our extension with a shell script.
Begin with open Explorer Visual Studio extensions,
Install the following template :
Below is a detail on the different of your solution.
Most of these directories will be deleted in the second time.
Now we will start developing our own extension,
First, delete the files that we use nothing:
- Remove the test directory
- Remove typings directory
- Delete the file app.ts
- Add directory Sample
- Create a powershell file Sample.ps1
- Create a task manifest file task.json
- Create logo into directory
Below the output of created project
- Edit the task.json by defining your layout based on controls and groups concepts, inputs are your controls typed with type propecty, and are grouped into groups, by using group property (Below sample of grouping, we have three groups)
Below the task.json file after modify
We have another section related to call code behind, for our project, code behind is powersell, it can be another type
- Implement your Code behind and match with your layout arguments
Ensure that arguments ps1 match with json arguments, in execution section on your json, ensure that you have referenced your target file.
- For debugging after implementing, open your ps ise, you can find-it in C:\Windows\System32\WindowsPowerShell\v1.0\powershell_ise.exe
Ensure that you have right of debugging by executing this script, and just click F5
- Register your extension in the manifeste