Skip to content

Latest commit

 

History

History
21 lines (15 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

21 lines (15 loc) · 1.37 KB
Raw

Contributing to TeamCity Snyk Security Plugin

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to TeamCity Snyk Security Plugin. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Testing

  • If you don't already have an instance of Teamcity available to use, you can download and run a local instance from the Jetbrains website here
  • Download the Teamcity Snyk plugin here
  • Install the plugin following this guide
  • Configure the plugin following this guide
    • Optionally, you can set your API endpoint if it differs from the default (https://snyk.io/). Do this by setting the SNYK_API environment variable in the build configuration's parameters page

Releases

Releases are handled by the release Github Action. It will:

  • Build the plugin assets
  • Create a tagged release with the plugin assets
  • Deploy the plugin to the JetBrains plugin portal

Releases are scheduled to occur every Tuesday.