wharf-provider-azuredevops

README

Azure DevOps provider for Wharf

Import Wharf projects from Azure DevOps repositories. Mainly focused on importing from self hosted Azure DevOps instances, importing from dev.azure.com is not well tested.

Components

• HTTP API using the gin-gonic/gin web framework.

• Swagger documentation generated using swaggo/swag and hosted using swaggo/gin-swagger

• Azure DevOps REST API accessed using good'ol net/http and encoding/json

Development

1. Install Go 1.13 or later: https://golang.org/

2. Install the swaggo/swag CLI globally:

   # Run this outside of any Go module, including this repository, to not
   # have `go get` update the go.mod file.
   $ cd ..
   
   $ go get -u github.com/swaggo/swag
   

3. Generate the swaggo files (this has to be redone each time the swaggo documentation comments has been altered):

   # Navigate back to this repository
   $ cd wharf-provider-github
   
   # Generate the files into docs/
   $ swag --parseDependency --parseDepth 1
   

4. Start hacking with your favorite tool. For example VS Code, GoLand, Vim, Emacs, or whatnot.

Linting Golang

• Requires Node.js (npm) to be installed: https://nodejs.org/en/download/
• Requires Revive to be installed: https://revive.run/

go get -u github.com/mgechev/revive

npm run lint-go

Linting markdown

• Requires Node.js (npm) to be installed: https://nodejs.org/en/download/

npm install

npm run lint-md

# Some errors can be fixed automatically. Keep in mind that this updates the
# files in place.
npm run lint-md-fix

Linting

You can lint all of the above at the same time by running:

npm run lint

# Some errors can be fixed automatically. Keep in mind that this updates the
# files in place.
npm run lint-fix

---

Maintained by Iver. Licensed under the MIT license.