Skip to content

Latest commit

 

History

History
38 lines (21 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

38 lines (21 loc) · 2.34 KB
Raw

Contributing

Contributions From Aqua

What you need

  • Your own Azure DevOps Organisation (for testing)
  • Access to the Aqua Security Azure DevOps Organisation (for publishing)
  • A GitHub account with write access to this repository.

There are two published versions of this extension - the real, public version, and a private, test version. You cannot have both versions installed to your test organisation at the same time, so you must uninstall one before installing the other.

The test version exists so we can publish a version and test it amongst ourselves before publishing to the real version.

You'll need to give your test organisation with access to the test version, which you can do by adding to the --share-with flag in scripts/dev.sh.

You can follow the guide to install the extension to your test organisation.

Updating the Publisher Token

The extension is published using an API which requires an Azure Publisher Token. This is stored as a secret named PUBLISHER_TOKEN in the GitHub repository.

To update the token, you'll need to create a personal access token in Azure Dev Ops with access to publish extensions to the Aqua organisation. You can then update the secret in the GitHub repository with this key. Setting it to expire after a short period is good practice.

Testing a New Version

Create a tag that is prefixed with dev on your branch, such as dev1.2.3, and push it. This will trigger a GitHub action that will publish a test version of the extension. Wait a few minutes and then try running the extension in your test organisation.

Publishing a New Version

After ensuring you have published a test version of the extension, and tested it, you can publish the real version.

After merging your changes to the main branch, create a semver tag that is prefixed with v on your branch, such as v1.2.3, and push it. This will trigger a GitHub action that will publish a new version of the extension. Wait a few minutes and then try running the extension in your test organisation to confirm it works.