Skip to content
This repository has been archived by the owner on Mar 7, 2021. It is now read-only.

Latest commit

 

History

History
70 lines (44 loc) · 3.68 KB

README.md

File metadata and controls

70 lines (44 loc) · 3.68 KB
Raw

White Source agent for Bamboo

A White Source external update agent for Atlassian Bamboo.

Overview

This plugin allows Bamboo users to easily create new White Source projects and update existing ones via a Task from your build. More features are planned for the near future. More information can be found on the Agents project documentation.

Supported job types

The plugin currently supports Maven and Freestyle jobs. Support for Ivy and Gradle jobs is on the roadmap.

Status

Actively developed and supported by White Source:

Release Notes

This is the initial release 1.0.0 - it offers support to create or update your White Source Open Source Software (OSS) inventory from a Task within your build, enforcing policies and failing the build if necessary.

1.0.0

Release 1.0.0 adds a Task to create or update a White Source Open Source Software (OSS) inventory, enforcing policies and failing the build if necessary.

Installation

Installation is performed via the Universal Plugin Manager as usual, see Installing a plugin for details.

Configuration

All textual Task parameters support Bamboo variable substitution to allow for global, plan or build-specific settings, see Using global, plan or build-specific variables for details.

  • Please note that if the variable key contains the phrase "password", the value will be masked with "********" in the Build Logs. E.g. if the key is password, apiKeyPassword or projectTokenPassword the value will be masked.

Parameters

Maven jobs

  • API key - Uniquely identifies your organization's White Source account.
  • Check policies? - Checking this option will check policies before any update.
  • Project token - Uniquely identifies the project built by the job.
  • Module tokens - Map of module artifactId to White Source project token.
  • Module Includes - Only modules with an artifactId matching one of these patterns will be processed by the plugin.
  • Module Excludes - Modules with an artifactId matching any of these patterns will not be processed by the plugin.
  • Ignore POM modules? - Checking this option will ignore maven modules of type POM.

Freestyle jobs

  • API key - Uniquely identifies your organization's White Source account.
  • Check policies? - Checking this option will check policies before any update.
  • Project token - Uniquely identifies the project built by the job.
  • File Includes - Ant-style FileSet pattern to determine which files to include as dependencies. Relative to the job's workspace.
  • File Excludes - Ant-style FileSet pattern to determine which files to exclude as dependencies. Relative to the job's workspace.

HTTP(S) Proxy

If your Bamboo instance is running behind a firewall, the plugin will reuse the proxy configuration from Bamboo, see Cannot connect to an AWS or EC2 instance when the Bamboo application is running behind a proxy for details.

License

Licensed under the Apache License, Version 2.0, see LICENSE for details.