The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

ArmorCode Release Gate

View this plugin on the Plugins site

armorcodeReleaseGate: ArmorCode Release Gate

ArmorCode Release Gate ensures that code changes meet security standards before they are deployed.

When this build step runs, it will:

  1. Connect to ArmorCode and request validation of your build against security policies
  2. Wait for validation to complete (polling with the specified retry interval)
  3. Either block the build or issue a warning based on the validation results and configured mode

For this to work properly, you need to:

  1. Configure the ArmorCode API token in Jenkins credentials with ID "ARMORCODE_TOKEN"
  2. Set the correct product and sub-product IDs from your ArmorCode account
  3. Configure global settings under "Manage Jenkins" > "System" > "ArmorCode Configuration"
  • product : String
  • subProducts : Object

    ArmorCode sub-group (sub-product) identifiers.

    In Freestyle UI: Enter one identifier per line for multiple sub-products:

    sub-product1
sub-product2
sub-product3

    In Pipeline: Use array syntax:

    subProducts: ["sub-product1", "sub-product2", "sub-product3"]

    For single sub-product (Pipeline):

    subProducts: "sub-product1"
// OR
subProducts: ["sub-product1"]
  • env : String
  • maxRetries : int (optional)

    The maximum number of times the plugin will poll the ArmorCode API for status before giving up.

    Because security validation may take time to complete, the plugin will continue checking until a definitive result is returned or this retry limit is reached.

    Each retry includes a 20-second pause between attempts when the status is "HOLD".

  • mode : String (optional)

    Determines how the build responds to security validation failures:

    • Block build on failure (block): The build will fail if ArmorCode finds security issues that violate release criteria. This is the recommended setting for enforcement.
    • Mark as unstable but continue (warn): The build will be marked as unstable but allowed to proceed if security issues are found. Use this for initial integration or when you want visibility without blocking.

    Note: Block mode is the default setting. When using block mode, the 'mode' parameter will not appear in the generated pipeline syntax to keep it clean.

  • retryDelay : int (optional)
  • targetUrl : String (optional)

    Override the default ArmorCode API endpoint for build validation.

    This field should normally be left empty to use the global configuration setting. Only modify this if you need to point to a different environment for testing or development purposes.

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.