Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Tigerstripe Buckminster Actions"
(→CSPEC Definition) |
|||
| Line 39: | Line 39: | ||
#:</cs:cspec> | #:</cs:cspec> | ||
#:</source> | #:</source> | ||
| − | #* | + | #*The first two lines declare that this is XML; it follows the CSPEC format, and it describes a component called Equipment-model. |
| + | #*The next section defines an artifact. This artifact has a local alias of classlevel-generator, and is referencing the directory path "./ClassLevel-Generator. It is also defined as a ''tigerstripe-generator'' type, which at this point is simply documenting the artifact. | ||
| + | #*The next section defines the Tigerstripe Action named ''tigerstripe.installGenerator''. Note that the actor type is also defined to be ''tigerstripe.installGenerator''. | ||
| + | #*This action has one property defined as a key/value pair. In the example above, the Action property being defined is ''projectname'' and the value is the Generator project name, in this case ''ClassLevel-Generator''. | ||
| + | #*Lastly, this Action has one prerequisite. Using the reference to the project directory defined in the ''Artifacts'' section, this is simply checking to make sure that the Tigerstripe Generator project is present before installation begins. | ||
====Triggering the Action==== | ====Triggering the Action==== | ||
Revision as of 18:59, 11 November 2008
< To: Tigerstripe_Tutorials
Contents
Prerequisites
- Working knowledge and installation of the Tigerstripe Workbench [1]
- Working knowlege and installation of the Buckminster [2] Eclipse plug-ins.
- Working knowlege of Buckminster Actions (See Component Specifications).
- Completion of the Tigerstripe Buckminster Integration Tutorial
Overview
Buckminster Actions may be used to add functionality to the Buckminster materialization process. In Tigerstripe's case, one example is the automated installation of materialized Tigerstripe Generators. It is possible that more Actions will be supplied by the Tigerstripe team as the product evolves. For more information on Buckminster Actions please see the Component Specifications section of the Buckminster Introduction.
Action Definitions
tigerstripe.installGenerator
This action will trigger the automated installation of a Tigerstripe Generator.
Parameters
- projectname - The project name of the Tigerstripe Generator to be installed.
Example
This section will show you how you to trigger a Generator installation using the tigerstripe.installGenerator Buckminster Action.
CSPEC Definition
- Open Eclipse to the workspace that was materialized in the Tigerstripe Buckminster Integration Tutorial tutorial.
- Open the Equipment-model project and look over the included buckminster.cspec file.
<?xml version="1.0" encoding="UTF-8"?>- <cs:cspec xmlns:cs="http://www.eclipse.org/buckminster/CSpec-1.0" name="Equipment-model" componentType="tigerstripe">
- <cs:artifacts>
- <cs:private name="classlevel-generator" path="ClassLevel-Generator/" type="tigerstripe.generator"/>
- </cs:artifacts>
- <cs:actions>
- <cs:public name="tigerstripe.installGenerator" actor="tigerstripe.installGenerator">
- <cs:actorProperties>
- <cs:property key="projectname" value="ClassLevel-Generator"/>
- </cs:actorProperties>
- <cs:prerequisites>
- <cs:attribute name="classlevel-generator"/>
- </cs:prerequisites>
- </cs:public>
- </cs:actions>
- </cs:cspec>
- The first two lines declare that this is XML; it follows the CSPEC format, and it describes a component called Equipment-model.
- The next section defines an artifact. This artifact has a local alias of classlevel-generator, and is referencing the directory path "./ClassLevel-Generator. It is also defined as a tigerstripe-generator type, which at this point is simply documenting the artifact.
- The next section defines the Tigerstripe Action named tigerstripe.installGenerator. Note that the actor type is also defined to be tigerstripe.installGenerator.
- This action has one property defined as a key/value pair. In the example above, the Action property being defined is projectname and the value is the Generator project name, in this case ClassLevel-Generator.
- Lastly, this Action has one prerequisite. Using the reference to the project directory defined in the Artifacts section, this is simply checking to make sure that the Tigerstripe Generator project is present before installation begins.