Work Item Wiki

Add static wiki pages to your work items
Explore the docs »

View Extension · Changelog · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Limitations
2. Post Install Configuration
3. Getting Started
   • Prerequisites
   • Installation
4. Usage
5. Roadmap
6. Contributing
7. Release and merge strategy
8. License
9. Contact

---

About The Project

Work item wiki is a control to render a wikipage inside a work item page. This can be useful if you need to document something for that work item type. For example definition of done/ready, bug categories etc.

Example where rendered on custom page:

Supported Wiki Features

Feature	Supported
Header (H1, H2, H3)	✅
Italic	✅
Bold	✅
Link	✅
Attachment	✅
Image	✅
Code / Code Block	✅
Unordered list	✅
Ordered list	✅
Table	✅
Mermaid Diagram	❌
Work Item Mentions	❌
Table of Contents	❌
Formulas	❌
Mention	❌
Query Results	❌
Task List	❌ (Display only)

(back to top)

Post Install Configuration

Work Item Link is a custom form control that needs to be added to the Work Item Form. It can be added on an existing page, or as a new tab. For how to do this, refer to the official documentation.

• Wiki Url is the url to the wiki page, it should look something like: https://dev.azure.com/organization/demo-project/_wiki/wikis/demo-project.wiki/1/This-is-a-page
• Version Branch is used when publishing the wiki from code. If your main branch is not wikiMaster, this field must be set to load links, images and attachments correctly.

Getting Started

Prerequisites

• A MarketPlace publisher Create a publisher

• tfx-cli installed. Due to issues with outdated dependencies this is not included in package.json

  npm install -g tfx-cli

• Pipelines uses the following extensions that needs to be installed in your organization in addition to default tasks:

  • GitGuard - Used to verify changes to files, such as changelog.
  • Azure DevOps Extension Tasks - Used to build and publish extension.

Installation

1. Clone the repo

   git clone https://github.com/joachimdalen/azdevops-work-item-wiki.git

2. Install dependencies

   > npm install

3. Update publisher in vss-extension.dev.json

4. Compile development version

   npm run prepare:dev

5. Publish extension

6. Share and install extension

7. Run extension

   npm run serve:dev

   Note: You might need to open https://localhost:3000/ in your browser from time to time to accept the unsecure certificate to have the extension load properly from your local environment.

(back to top)

Usage

See documenation.

(back to top)

Roadmap

See the open issues for a full list of proposed features.

(back to top)

Contributing

Contributions are welcome, both in the form of suggestions and code. Create

If you want to contribute code, I ask that you follow some guidelines.

• New and changed features should to the best ability be covered by tests
• Follow the branching policy:
  • feature/ for new features
  • bugfix/ for bug fixes
  • docs/ for documentation changes
• If your change is related to an issue, use the id as the first part of the branch e.g bugfix/12-fix-crash-when-updating-rule
• Pull requests should target the develop branch

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/123-some-feature)
3. Commit your Changes (git commit -m 'Add some feature')
4. Push to the Branch (git push origin feature/123-some-feature)
5. Open a Pull Request

(back to top)

Release and merge strategy

• master is only deployed to PROD and tagged with v<extension_version>
  • Pull requests are always squash merged into master
  • master is the only branch where GitHub releases are created for
• feature/* and bugfix/* are deployed to QA. For deployment to DEV using local assets (only manifest changes are deployed to dev), the Deploy to DEV instead of QA option needs to be checked when running the deployment pipeline.

QA and DEV are private development and verfication environments (publications of the extensions.) Submit a new issue if you for some reason wish access to either of these.

Note Access to these are not given for your local development. Please publish your own development release.

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

If you have generic questions about the project or usage you can make contact in the following ways:

• Submit an issue with the @type/question label - New Issue
• Submit a new question under the Marketplace Q&A section.

(back to top)