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 "Swordfish Documentation: Build Eclipse Feature"
(New page: {{#eclipseproject:rt.swordfish}} Draft = Description = All Swordfish components shall be included into 'Eclipse Features'. = Current Problem / Pain = Currently the Build artefects crea...) |
(→Architecture Outline/ Implementation Ideas) |
||
(8 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{#eclipseproject:rt.swordfish}} | {{#eclipseproject:rt.swordfish}} | ||
− | + | The disccussion on this feature is available on the [[Talk:Swordfish_Documentation:_Build_Eclipse_Feature |Talk Page]] | |
= Description = | = Description = | ||
− | All Swordfish | + | All Swordfish bundles/plugins shall be included into 'Eclipse Features'. |
= Current Problem / Pain = | = Current Problem / Pain = | ||
− | Currently the Build | + | Currently the Build artefacts created during the Swordfish Build only create bundles/plugins. |
= Advantages/Business Case = | = Advantages/Business Case = | ||
Line 16: | Line 16: | ||
= Use Cases = | = Use Cases = | ||
− | + | The Eclipse Feature can be provided through Eclipse Update site. | |
= Conditions of satisfaction = | = Conditions of satisfaction = | ||
+ | The Features for Eclipse Swordfish for the Galileo Release are defined, it is decided which plugins belong to witch features. | ||
+ | |||
+ | The Eclipse Features is ready to be included/ be provided for the Eclipse Update Site for Galileo. | ||
− | * Run a successful Feature Build for the | + | * Feature is [[Swordfish_Documentation:_Feature_Completenes_Definition | complete]]: Start/Run/Control/Documentation This feature itself is a prerequisite to acheive completeness for other features. |
− | * Show the Feature.xml it shall contain all required information | + | * Run a successful Feature Build for the defined Swordfish Features |
+ | * Show the Feature.xml, it shall contain all required information | ||
+ | ** Feature with ID, Label, Version, Provider-Name | ||
** Copyright | ** Copyright | ||
** Description | ** Description | ||
− | ** License | + | ** License (including 3rd Parties) |
− | ** List of Plugins | + | ** Update Site URL |
− | + | ** List of Plugins, for each Pluging: ID, download Size, install size (optional), version, unpack | |
+ | List of Information not yet included (restricted to external dependencies) | ||
= Limitations = | = Limitations = | ||
− | + | In case information not defined within the Bundles/Plugins can not be obtained from Eclipse yet for Galileo, this may be added later. | |
− | + | ||
= Dependencies = | = Dependencies = | ||
Line 38: | Line 44: | ||
''Are there any dependencies to other components, documentation, QA?'' | ''Are there any dependencies to other components, documentation, QA?'' | ||
− | = Non | + | = Non functional aspects = |
Section is mandatory for step "First Estimation".<br/> | Section is mandatory for step "First Estimation".<br/> | ||
== Volume / Load aspects == | == Volume / Load aspects == | ||
− | + | N/A | |
== Security aspects == | == Security aspects == | ||
− | + | General for the Build and Installation: No No unencrypted passwords shall occur in installation directories. | |
== Ease of Use == | == Ease of Use == | ||
+ | The Feature is at least as easy to handle as any other Eclipse Feature. | ||
+ | The possibility to link to the deployment should be considered and clarified at the beginning of implementation. | ||
+ | = Architecture Outline/ Implementation Ideas = | ||
+ | Use the Maven Plugin to create Eclipse Features. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
+ | ---------------------------- | ||
+ | Return to Eclipse Swordfish [[Swordfish_Documentation:_Product_Backlog |Swordfish Product Backlog]] | ||
− | + | [[Swordfish | Swordfish Wiki Home]] |
Latest revision as of 08:06, 27 March 2009
{{#eclipseproject:rt.swordfish}}
The disccussion on this feature is available on the Talk Page
Contents
Description
All Swordfish bundles/plugins shall be included into 'Eclipse Features'.
Current Problem / Pain
Currently the Build artefacts created during the Swordfish Build only create bundles/plugins.
Advantages/Business Case
Having build artefeacts compliant to Eclipse Features is a prerequisite for making them available on the Eclipse Update Site. The Interface definition can be found [ http://download.eclipse.org/eclipse/downloads/documentation/2.0/html/plugins/org.eclipse.platform.doc.isv/reference/api/org/eclipse/update/core/Feature.html here]
Use Cases
The Eclipse Feature can be provided through Eclipse Update site.
Conditions of satisfaction
The Features for Eclipse Swordfish for the Galileo Release are defined, it is decided which plugins belong to witch features.
The Eclipse Features is ready to be included/ be provided for the Eclipse Update Site for Galileo.
- Feature is complete: Start/Run/Control/Documentation This feature itself is a prerequisite to acheive completeness for other features.
- Run a successful Feature Build for the defined Swordfish Features
- Show the Feature.xml, it shall contain all required information
- Feature with ID, Label, Version, Provider-Name
- Copyright
- Description
- License (including 3rd Parties)
- Update Site URL
- List of Plugins, for each Pluging: ID, download Size, install size (optional), version, unpack
List of Information not yet included (restricted to external dependencies)
Limitations
In case information not defined within the Bundles/Plugins can not be obtained from Eclipse yet for Galileo, this may be added later.
Dependencies
Section is mandatory for step "Decision/Prioritization".
Are there any dependencies to other components, documentation, QA?
Non functional aspects
Section is mandatory for step "First Estimation".
Volume / Load aspects
N/A
Security aspects
General for the Build and Installation: No No unencrypted passwords shall occur in installation directories.
Ease of Use
The Feature is at least as easy to handle as any other Eclipse Feature. The possibility to link to the deployment should be considered and clarified at the beginning of implementation.
Architecture Outline/ Implementation Ideas
Use the Maven Plugin to create Eclipse Features.
Return to Eclipse Swordfish Swordfish Product Backlog