General
{% if item.project-groups|not-empty %}
{% endif %}
Specify a point of contact for this analysis project, e.g. name or email (free text field).
A free text field where you can add notes describing your configuration.
{% ifunequal item.local-path-for-remotes "" %}
{% if item.fixed_repo_roots %}
This path is auto generated from your admin settings, and points to a folder where the remotes will be cloned.
{% else %}
A path to a writeable folder where we'll clone your remotes. If you change the path we'll re-clone each Git remote.
{% endif %}
{% endifunequal %}
{% if item.fixed_results_root %}
This path is auto generated from your admin settings. It specifies a folder where the analysis results will
be written. This would, typically, be a persistent folder.
{% else %}
A path to a (writeable) folder for analysis results. Must
be a directory outside of the repositories you analyze.
{% endif %}
Specifies how far back in time we will go to collect data. Leave empty for the largest possible range.
Specifies how far back in time to collect Hotspot
data. When the full history is used, the results will be
more complete but might include hotspots that have
recently become stable. This option does not affect any
other analysis time frames.
Specifies how far back in time to collect Cost and Cost trends from
a project/lifecycle tool integration (e.g. Jira, GitHub Issues, Azure DevOps).
Specifies how far back in time to analyse team work (coordination, team coupling, etc.). This should
typically be a short time span since teams tend to be more volatile than code, and you want the
analyses to reflect recent acitivity, not old team contribution patterns.
If the Full option is selected, CodeScene will use the starting date specified
below for Start team analyses.
This is used as the start date for team analyses in case the Full option
is specified above.
When checked, we use the complete Git history to calculate individual knowledge metrics independent of your analysis period. Uncheck if you want a faster analysis and don't care about individual metrics.
Pulls the latest changes before each analysis. Uncheck if updating repositories is not possible.
By checking this box you improve the accuracy of the knowledge metrics in case you have content that's frequently extracted/copied from other files. The disadvantage is that this operation may slow down the analysis on large projects.
If enabled, VCS data will be stored and reused in subsequent analysis improving performance.
If enabled, Code Health Score data will be stored and reused in subsequent analysis improving performance.
{% include "cacsremoteservice/views/projects/configuration/social.html" %}
Exclusions & Filters
{% if feature-flags.code-coverage? %}
Code Coverage exclusions
Exclude selected files and folders from the code coverage analytics.
By default, files for which no code coverage data is available are considered to have 0% coverage and are displayed as red in the system map.
This also affects the calculation of the code coverage KPIs.
To avoid these false positives, you can provide glob patterns that match the files you wish to exclude from the code coverage analysis.
Glob patterns must begin with the repository root.
Consult the documentation for more details.
{% endif %}
{% include "cacsremoteservice/views/projects/configuration/codehealth.html" %}
Change coupling
Change Coupling Filters
Add filters to exclude change couplings by default, for
example files that you expect to change together. See
the documentation for more details and examples.
Architecture
Architectural Components
Specify the logical components in your codebase. The definitions are used for the architectural analyses (see
the documentation
for examples).
{% if feature-flags.ranked-architectural-components %}
{% endif %}
Import/Export Architectural Definitions
Instead of specifying the patterns manually in the section above, you can import a CSV file with the definitions. This is a simpler option in a large system where you can script the generation of the CSV to import.
The CSV file must have two columns, without any header row:
- Component Name
- Glob Pattern
See
the documentation for more details.
Any import will overwrite existing architectural definitions.
Export Architectural Definitions
Architectural Trends
Complexity trends on the architectural level.
Deprecation warning:
The architectural trends are deprecated and will be removed in the future. This information is better captured by other KPIs.
CodeScene is able to calculate complexity trends on an architectural level (see
the documentation
for examples). However, this feature is expensive in
terms of analysis time. You toggle the feature on and off here.
Status Badges
Status badges help stakeholders stay up to date on the health of
your project. They can be embedded anywhere, as long as CodeScene is
available on the same network.
When you select a badge below, you'll see HTML and
Markdown code you can use for embedding badges.
Security: status badges
are public. When activated here, the badge image
itself is visible to anyone with access to the same
network. Activating a badge does not open any other access besides
the image itself.
{% for badge in item.status-badges %}
{% if badge.identifier %}
Markdown
[](CS_URL/{{ item.id}}/analyses/latest)
HTML
<a href="CS_URL/{{ item.id }}/analyses/latest">
<img src="CS_URL/{{ item.id }}/status-badges/{{ badge.identifier|name }}">
</a>
{% comment %} See https://trello.com/c/qcfqrCto/794-provide-missed-goals-badge-on-architectural-component-level {% endcomment %}
{% if badge.non-architectural-message %}
Note: {{ badge.non-architectural-message }}
{% else %}
{% endif %}
{% endif %}
{% endfor %}
Static badge for remote use
If your code is hosted on GitHub and CodeScene is on
your local network, status badges will not work as
expected. GitHub serves externally hosted images through
a proxy server which requires direct access to the image
source.
In these cases, the next best solution is to display a
static badge. The image is hosted
at codescene.com or you
can copy it to your own server. When used with the
markup provided here, it will still allow your users to
quickly navigate to their project on CodeScene.
Markdown
[](CS_URL/{{ item.id}}/analyses/latest)
HTML
<a href="CS_URL/{{ item.id }}/analyses/latest">
<img src="https://codescene.com/status/analyzed-by-codescene-badge.svg">
</a>
{% include "cacsremoteservice/views/projects/configuration/delta-analysis.html" %}
{% include "cacsremoteservice/views/projects/configuration/delivery-performance.html" %}