Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Summary: this page describes how to create a plugin.nuspec metadata description file for your custom extension.

Introduction

Each extension must contain a description file that contains the information required for each extension to function correctly. The requirements for this file are listed below:

On this page:

Description file name

The description file must be named plugin.nuspec.

Description file location

Please place the plugin.nuspec file at the root of your extensions folder:

Description file content

The plugin.nuspec file should be encoded in utf-8 without BOM and must contain the following elements:

Please note:

ElementDescription
id

The id of the extension. CAST recommends using the same name as you have designated for the extension's folder.

Maximum length is 99.

For example:

  • for CAST extensions provided by the Product team, the recommended id uses the form: com.castsoftware.nameoftheextension
  • for CAST extensions provided by the Users Community team, the recommended id uses the form com.castsoftware.uc.nameoftheextension
  • for CAST extensions provided by the CAST Labs , the recommended id uses the form com.castsoftware.labs.nameoftheextension
title

The extension's title. CAST recommends using a meaningful title. For example:

  • if your extension supports a new framework CAST recommends including the framework name in the title
  • if your extension supports a technology CAST recommends including the technology name in the title
  • in order to give more clarity CAST recommends including the name of the company that provides the product that is targeted by the extension in the title as well
  • if the extension involves an existing CAST component, include the name of the component explicitly in the name of the extension
  • it is not necessary to include "CAST" in the name of the extension
version

The extension version number. This must use the format defined by Semantic Versioning 2.0.0. For example: 1.0.0. Please follow the versioning policy defined within your own team.

Maximum length is 30.

The Stable versus Pre-Release versions is encoded inside the version itself, following the Semantic Versioning conventions also:

  • x.y.z are considered as stable
  • x.y.z-... are considered as pre-release

 For example:

  • Alpha versions
    • For alpha version: 1.1.0-alpha1 is considered as a pre-release alpha version
    • For alpha version: 1.1.0-alpha2 is considered as a pre-release alpha version

  • Beta versions
    • For beta version: 1.1.0-beta1 is considered as a pre-release beta version
    • For beta version: 1.1.0-beta2 is considered as a pre-release beta version

  •  Functional releases
    • For a functional release: 1.2.0-funcrel is considered as a functional release version
    • For a functional release: 1.3.0-funcrel is considered as a functional release version
  • Long Term Support
    • Version 1.0.1 : is considered as stable
    • Version 1.3.0 : is considered as stable 
For CAST User Community extensions CAST recommends not using intermediate version numbering such as: alphas, betas and functional releases - a simple version number (such as 1.3.0) is sufficient (the versions provided by the User Community do not follow a standard product development process with the release of the alphas, betas etc versions therefore this numbering is not necessary).


authors

The author of the extension using an email address. Multiple email addresses should be separated by a comma. However in the case of CAST provided extensions the following values are recommended:

  • for CAST extensions provided by the Product team, the author is set to "CAST Product"
  • for CAST extensions provided by the Labs team, the author is set to "CAST Labs"
  • for CAST extensions provided by the User Community team, the author will be "CAST User Community".
ownersThe owner of the extension. In the case of official CAST extensions the owner is always "CAST".
projectUrl

Each extension must include a link to the related extension documentation.

The documentation, stored in a separate page (which MUST BE FREELY AVAILABLE ON THE INTERNET) must include the following information:

  • a description of the extension, which scenarios the extension can be used in, what results should be expected and how the results generated by the extension impact the results of the entire analysis
  • a section must be dedicated to listing CAST AIP compliance
  • where specific technologies are supported by the extension, the versions of the technologies/frameworks supported should also be listed
  • types of projects supported by the extension
  • details of the types of projects, objects, links created by the extension
  • list of any new metrics provided by the extension
  • list of any new Quality Rules provided by the extension
  • a clear list of limitations if there are any

Publication:

descriptionA quick description of the extension. This description is displayed in the CAST Extension Downloader, therefore cannot exceed 200 characters. The description must contain a few details about the extension, which scenarios the extension can be used in, what results should be expected and how the results generated by the extension impact the results of the entire analysis.
releaseNotesA link to a a description of the changes made in each release of the package. This field only shows up when the _Updates_ tab is selected and the package is an update to a previously installed package. It is displayed where the Description would normally be displayed.
dependencies

This element configured the dependencies required by the extension - i.e. which other extensions must be installed and which release of CAST AIP is required (this is mandatory). For example if an extension is compliant with CAST AIP 7.3.6 and/or 8.0.0 then this should be added here.

This element also provides the possibility to declare dependencies between extensions.

licenseUrlThis concerns the type of license. In the case of CAST extensions provided by the Product team the license is a CAST standard license. In all the other cases, the author must add a link to a chosen license.
tagsA space-delimited list of tags and keywords that describe the package. This information is used to help make sure users can find the package using searches. Some important tags to add are the technology, the language, the framework, CAST AIP release, components in CAST AIP that are impacted by the use of the extension. Other tags can be added as well.
Please find below an example of manifest file and manifest file template for each type of contributor.

Example description file

Please find below an example plugin.nuspec file:

<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
    <metadata>
        <id>com.castsoftware.nameoftheextension</id>
        <version>1.0.0</version>
        <title>A great extension</title>
        <authors>my.address@my.company.com,CAST</authors>
        <owners>my.address@my.company.com,CAST</owners>
        <licenseUrl>http://my.company.com/doc/license</licenseUrl>
        <projectUrl>http://my.company.com/doc/my.company.extension.html</projectUrl>
        <requireLicenseAcceptance>false</requireLicenseAcceptance>
        <description>This is a great extension that creates great objects and even greater links</description>
        <tags>DotNet WCF C# Beta CAIP736</tags>
        <dependencies>
            <dependency id="CAIP" version="8.0.0" />
        </dependencies>
    </metadata>
    <files />
</package>
Here <dependency id="CAIP" version="8.0.0" /> means that this extension is compatible with CAIP version from 8.0.0 and above.

Example templates

CAST Product extensions

Please find below an example plugin.nuspec file that is used with "official" CAST AIP extensions created by CAST R&D:

<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
    <metadata>
        <id>com.castsoftware.nameoftheextension</id>
        <version>x.x.x</version>
        <title>MyExtension</title>
        <authors>CAST Product</authors>
        <owners>CAST</owners>
        <licenseUrl>https://help.castsoftware.com/hc/en-us/articles/212612648-AIP-Extension-License</licenseUrl>
        <projectUrl>http://my.company.com/doc/my.company.plugin.html</projectUrl>
        <requireLicenseAcceptance>false</requireLicenseAcceptance>
        <description>This is a great extension that creates great objects and even greater links</description>
        <tags>Technology Language Framework Version CAIPVersion</tags>
        <dependencies>
            <dependency id="CAIP" version="8.0.0" />
        </dependencies>
    </metadata>
    <files />
</package>

CAST Labs extensions

Please find below an example plugin.nuspec file that should be used with custom CAST AIP extensions created by CAST Labs:

<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
    <metadata>
        <id>com.castsoftware.labs.nameoftheextension</id>
        <version>x.x.x</version>
        <title>MyExtension</title>
        <authors>CAST Labs</authors>
        <owners>CAST</owners>
        <licenseUrl>http://my.company.com/doc/pleaseCheckWithYourBossWhatLicenseYouShouldChoose</licenseUrl>
        <projectUrl>http://my.company.com/doc/my.company.plugin.html</projectUrl>
        <requireLicenseAcceptance>false</requireLicenseAcceptance>
        <description>This is a great extension that creates great objects and even greater links</description>
        <tags>Technology Language Framework Version CAIPVersion</tags>
        <dependencies>
            <dependency id="CAIP" version="8.0.0" />
        </dependencies>
    </metadata>
    <files />
</package>

CAST User Community extensions

Please find below an example plugin.nuspec file that should be used with custom CAST AIP extensions created by the CAST User Community:

<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
    <metadata>
        <id>com.castsoftware.uc.nameoftheextension</id>
        <version>x.x.x</version>
        <title>MyExtension</title>
        <authors>CAST User Community</authors>
        <owners>CAST</owners>
        <licenseUrl>http://my.company.com/doc/pleaseCheckWithYourBossWhatLicenseYouShouldChoose</licenseUrl>
        <projectUrl>http://my.company.com/doc/my.company.plugin.html</projectUrl>
        <requireLicenseAcceptance>false</requireLicenseAcceptance>
        <description>This is a great extension that creates great objects and even greater links</description>
        <tags>Technology Language Framework Version CAIPVersion</tags>
        <dependencies>
            <dependency id="CAIP" version="8.0.0" />
        </dependencies>
    </metadata>
    <files />
</package>
  • No labels