Semmle 1.20
Skip to end of metadata
Go to start of metadata

This topic gives an overview of the options for editing a project configuration file.

Overview

Each project is controlled by a project file that defines the configuration details for the project. You can edit the configuration file to:

Editing the project file

You can edit the project file using your preferred text editor.

To edit the project file
  1. Open the project file for editing (for example, using nano or vi).
  2. Edit the XML elements as required (see project file for a full overview).
  3. When you have finished editing the project file, save your changes.

Changes to most elements in the project file are applied to all new snapshots created after the change (created using the addSnapshot or addLatestSnapshot command). If you define a new display name for the project, then this change is seen on all dashboards built after the change (built using the buildDashboard command).

Changing the minimum period between new snapshots

The frequency at which new snapshots are created depends on:

When the addLatestSnapshot command is called, the date of the most recent snapshot and the value of the days-between-updates element are checked. A new snapshot is added to the project only if the number of days since the most recent snapshot matches or exceeds the value of the days-between-updates element.

To change the frequency defined in the project file
  1. Open the project file for editing.
  2. Edit the value of the days-between-updates element. For example, to add a new snapshot on alternate days, define a value of 2.
  3. When you have finished editing the project file, save your changes.

When addLatestSnapshot is called it will no longer run if a snapshot for yesterday is already available unless the --overwrite flag is specified.