Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update APIM version to 3.5.4 and fix apim create or update request wi… #135

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
64 changes: 64 additions & 0 deletions Build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Building an Azure DevOps Web Extension

To build an Azure DevOps web extension, follow these steps:

1. **Prerequisites**
- Ensure you have Node.js and npm installed on your machine. You can download them from the official Node.js website: [Node.js](https://nodejs.org).

2. **Create a new directory**
- Open a terminal or command prompt and navigate to the desired location where you want to create your extension project.
- Run the following command to create a new directory for your extension:
```bash
mkdir my-extension
cd my-extension
```

3. **Initialize the project**
- Run the following command to initialize a new Node.js project:
```bash
npm init -y
```

4. **Install the Azure DevOps Extension SDK**
- Run the following command to install the Azure DevOps Extension SDK:
```bash
npm install azure-devops-extension-sdk --save
```

5. **Create your extension**
- Create the necessary files and folders for your extension, such as HTML, CSS, and JavaScript files.
- Refer to the [Azure DevOps Extension SDK documentation](https://docs.microsoft.com/azure/devops/extend/overview?view=azure-devops-extension-sdk-12) for more information on how to create and structure your extension.

6. **Build and package your extension**
- Run the following command to build and package your extension:
```bash
npm run build
```

7. **Publish your extension**
- Follow the instructions in the [Publish an Azure DevOps extension](https://docs.microsoft.com/azure/devops/extend/publish/overview?view=azure-devops-extension-sdk-12) documentation to publish your extension to the Azure DevOps Marketplace.

That's it! You have now built and published your Azure DevOps web extension. For more detailed information and advanced topics, refer to the [Microsoft Learn documentation](https://docs.microsoft.com/learn/azure-devops/).

# Package and Publish
NOTE: before packaging, remember to increase your package version on the vss-extension.json file.

8. **Package your extension**
- Run the following command to package your extension:
```bash
tfx extension create --manifest-globs vss-extension.json
```
- This command will create a VSIX package file for your extension.

9. **Publish your extension**
- To publish your extension to the Azure DevOps Marketplace, you need to have an Azure DevOps organization and a publisher account.
- Run the following command to publish your extension:
```bash
tfx extension publish --service-url https://dev.azure.com/{organization} --token {PAT}
```
- Replace `{organization}` with your Azure DevOps organization name and `{PAT}` with a Personal Access Token (PAT) that has the necessary permissions to publish extensions.
- This command will publish your extension to the Azure DevOps Marketplace.

NOTE: alternatively, you can publish your extension using the GUI available at https://marketplace.visualstudio.com/manage/publishers/{organization} where organization is the name of your publisher company.

That's it! You have now packaged and published your Azure DevOps web extension. Congratulations!
162 changes: 0 additions & 162 deletions apim/v1/apim.ps1

This file was deleted.

Loading