top of page

Getting Started with Code Warden

Installing and using Code Warden is a breeze!  Here's a checklist of things you'll need to set up:

  • You must be using Jira.  Either Data Center edition or Cloud edition will work.

  • You must be using source control:

  • The Jira Code Warden plugin must be installed from the Atlassian Marketplace onto your Jira instance

While Code Warden was designed to be easy to use and setup, if you have questions or need help we're here to support you.

 

Please contact us if you would like help, have questions, or would like to see a live demo.

Step 1 - Install the Jira Plugin

Simply visit the Atlassian Marketplace, search for Code Warden and get the plugin.  Code Warden is available for both Jira Data Center and Jira Cloud editions.

​

Important!  Remember, Jira must be integrated with your source control.  Ensure your network and firewall connections allow for your Jira instance to connect to your GitHub  or Bitbucket repos.

 

If you need instructions on how to do this, you can visit the links below.

Blurry Blue
Blurry Blue
Blurry Blue
GitHub-Simbolo.png

If you're new to GitHub actions, have no fear!  The guide for creating an action is very simple and you can find official instructions on GitHub's website.

​

But, if you're a seasoned pro with actions, then you'll want to add the Code Warden action code from our GitHub repository into your own repo's .github/workflows directory.

bitbucket-vector-logo.png

Code Warden also supports Bitbucket Pipelines!  The guide for creating a pipeline is very simple and you can find official instructions on the Bitbucket Pipes Integrations page.

Step 2 - Connect Your Source Control

Step 3 - Benefit

If everything is installed and configured properly, Code Warden will passively run on every pull request you create. Most developer workflows require a pull request (or PR) to be created in order to merge code from a development into the main code base.  It's this PR creation that kickoffs off the Code Warden analysis.

All you need to do is sit back and watch the tool analyze your code and compare it to your requirements, then listen to its feedback to produce high quality software!

​

If you're having any issues, please see our troubleshooting guide.

​

Here are some examples of Code Warden in action:

bottom of page