Development Practices - Revision history

Tuukka Lehtonen: /* Contributing to the Simantics codebase */

2021-03-28T11:48:15Z

Contributing to the Simantics codebase

← Older revision		Revision as of 11:48, 28 March 2021
Line 1:		Line 1:
	== Contributing to the Simantics codebase ==		== Contributing to the Simantics codebase ==

	The development of the Simantics platform is coordinated by the ''Simantics Technical Board''. The Technical Board consists of three to six members that are selected among the THTH Simantics Division member organisations by the Simantics General Meeting. The duties of the Simantics Technical Board are defined in the [https://www.simantics.org~~/simantics~~/about~~-simantics~~/thth-simantics~~#thth-simantics-division-rules~~ THTH Simantics Division Rules and Regulations].		The development of the Simantics platform is coordinated by the ''Simantics Technical Board''. The Technical Board consists of three to six members that are selected among the THTH Simantics Division member organisations by the Simantics General Meeting. The duties of the Simantics Technical Board are defined in the [https://www.simantics.org/about/thth-simantics THTH Simantics Division Rules and Regulations].

	The Simantics Technical Board shall:		The Simantics Technical Board shall:

Tuukka Lehtonen: /* Contributing to the Simantics codebase */

2018-03-04T21:23:24Z

Contributing to the Simantics codebase

← Older revision		Revision as of 21:23, 4 March 2018
Line 8:		Line 8:
	# update simantics.org website both public and member areas		# update simantics.org website both public and member areas

	'''All contributions made to Simantics modules go through the Simantics Technical Board (STB).''' The Simantics Technical Board meetings are arranged ~~every week~~. These meetings are documented in the Simantics ticket management system ([https://www.simantics.org/redmine Redmine]).		'''All contributions made to Simantics modules go through the Simantics Technical Board (STB) via Gerrit code reviews.''' The Simantics Technical Board meetings are arranged 6-8 weeks apart. These meetings are documented in the Simantics ticket management system ([https://www.simantics.org/redmine Redmine]).

	== Our Scrum ==		== Our Scrum ==

Tuukka Lehtonen: /* Modifying the target platform */

2017-08-15T10:36:22Z

Modifying the target platform

← Older revision		Revision as of 10:36, 15 August 2017
Line 209:		Line 209:

	== Modifying the target platform ==		== Modifying the target platform ==

			DEPRECATED: these instructions are mainly deprecated with the current Git-based system

	The target platform is a composition of features and plug-ins that contains all the bundles that you as a developer can build your code against when starting from a blank table. In Simantics, it is a mixture of the standard Eclipse RCP platform, other general Eclipse components and some Simantics components.		The target platform is a composition of features and plug-ins that contains all the bundles that you as a developer can build your code against when starting from a blank table. In Simantics, it is a mixture of the standard Eclipse RCP platform, other general Eclipse components and some Simantics components.

Tuukka Lehtonen: /* Deploying plug-ins for the target platform */

2014-07-08T09:28:28Z

Deploying plug-ins for the target platform

← Older revision		Revision as of 09:28, 8 July 2014
Line 227:		Line 227:
	* http://www.simantics.org/download/_version_/sdk (w/o source)		* http://www.simantics.org/download/_version_/sdk (w/o source)
	* http://www.simantics.org/download/_version_/sdk-source (w/ source)		* http://www.simantics.org/download/_version_/sdk-source (w/ source)
	where ''_version_'' is one of '''head''', '''1.11''', '''1.10''', etc. head is trunk.		where ''_version_'' is one of '''head''', '''1.11''', '''1.10''', etc. '''head''' is trunk.

	The repository is built using the buckminster build definition projects at [[svn:releng/sdk/branches]]. Ultimately, these builds use the feature project at [[svn:workbench/trunk/org.simantics.sdk.site.feature/]] to define which features and plug-ins are part of the platform.		The repository is built using the buckminster build definition projects at [[svn:releng/sdk/branches]]. Ultimately, these builds use the feature project at [[svn:workbench/trunk/org.simantics.sdk.site.feature/]] to define which features and plug-ins are part of the platform.

Tuukka Lehtonen: /* Using version control */

2013-11-08T12:13:42Z

Using version control

← Older revision		Revision as of 12:13, 8 November 2013
Line 20:		Line 20:
	Bugs and feature requests shall be reported in the platform backlog. New issues are processed by the STB in sprint meetings. As a minimum effort, the bug is prioritized in the backlog and put on hold if not taken up for implementation immediately. There is a [https://www.simantics.org/redmine/projects/simantics/issues?query_id=92 stored query] in Redmine for listing all new issues created within the last two weeks.		Bugs and feature requests shall be reported in the platform backlog. New issues are processed by the STB in sprint meetings. As a minimum effort, the bug is prioritized in the backlog and put on hold if not taken up for implementation immediately. There is a [https://www.simantics.org/redmine/projects/simantics/issues?query_id=92 stored query] in Redmine for listing all new issues created within the last two weeks.

	== ~~Using version~~ control ==		== Version control ==

	First things first, read through [http://svn.apache.org/repos/asf/subversion/trunk/doc/user/svn-best-practices.html Subversion best practices].		First things first, read through [http://svn.apache.org/repos/asf/subversion/trunk/doc/user/svn-best-practices.html Subversion best practices].

Tuukka Lehtonen: /* Our Scrum */

2013-11-08T11:21:51Z

Our Scrum

← Older revision		Revision as of 11:21, 8 November 2013
Line 12:		Line 12:
	== Our Scrum ==		== Our Scrum ==

	~~TODO~~		Simantics platform development progresses in 2 week sprints. The technical board convenes for sprint meetings at the end of every sprint for review, retrospective and planning of the next sprint.

	[~~http~~://www.simantics.org/~~~niemisto~~/~~dod~~.~~pdf Definition of Done~~]		The planning is done in the [https://www.simantics.org/redmine/projects/simantics-platform Simantics Platform Redmine project] and its [https://www.simantics.org/redmine/rb/master_backlog/simantics-platform?jump=rb_master_backlogs# backlog].

			=== Reporting Bugs and Feature Requests ===

			Bugs and feature requests shall be reported in the platform backlog. New issues are processed by the STB in sprint meetings. As a minimum effort, the bug is prioritized in the backlog and put on hold if not taken up for implementation immediately. There is a [https://www.simantics.org/redmine/projects/simantics/issues?query_id=92 stored query] in Redmine for listing all new issues created within the last two weeks.

	== Using version control ==		== Using version control ==

Tuukka Lehtonen: /* Contributing to the Simantics codebase */

2013-11-08T10:59:54Z

Contributing to the Simantics codebase

← Older revision		Revision as of 10:59, 8 November 2013
Line 8:		Line 8:
	# update simantics.org website both public and member areas		# update simantics.org website both public and member areas

	'''All contributions made to Simantics modules go through the Simantics Technical Board.''' The Simantics Technical Board meetings are arranged every week. These meetings are documented in the Simantics ticket management system ([https://www.simantics.org/redmine Redmine]).		'''All contributions made to Simantics modules go through the Simantics Technical Board (STB).''' The Simantics Technical Board meetings are arranged every week. These meetings are documented in the Simantics ticket management system ([https://www.simantics.org/redmine Redmine]).

	== Our Scrum ==		== Our Scrum ==

Tuukka Lehtonen: /* Modifying the target platform */

2013-11-08T00:57:02Z

Modifying the target platform

← Older revision		Revision as of 00:57, 8 November 2013
Line 206:		Line 206:
	== Modifying the target platform ==		== Modifying the target platform ==

	The target platform is a composition of features and plug-ins that contains all the bundles that you as a developer can build your code against when starting from a blank table. It is a mixture of the standard Eclipse RCP platform, other general Eclipse components and ~~also~~ some Simantics components.		The target platform is a composition of features and plug-ins that contains all the bundles that you as a developer can build your code against when starting from a blank table. In Simantics, it is a mixture of the standard Eclipse RCP platform, other general Eclipse components and some Simantics components.

	It makes sense to deploy into the target platform only if your plug-ins:		It makes sense to deploy into the target platform only if your plug-ins:
Line 215:		Line 215:
	Deploying plug-ins into the target platform will most likely break:		Deploying plug-ins into the target platform will most likely break:

	~~# [http://www.simantics.org/jenkins Headless PDE builds] that depend on the feature~~
	~~#* Remove the deployed plug-ins from the plugins/ directory of the build structure to take the deployed plug-ins from the target platform~~
	~~#* The target platform(s) used by the builds must be updated~~
	~~#* TODO: link to instructions for general hudson and PDE build configuration~~
	# [[svn:project-set/\|Project sets]]		# [[svn:project-set/\|Project sets]]
	#* FIX: remove lines matching the plug-ins that were moved into the target platform		#* FIX: remove lines matching the plug-ins that were moved into the target platform

Tuukka Lehtonen: /* Deprecated instructions */

2013-11-08T00:54:42Z

Deprecated instructions

← Older revision		Revision as of 00:54, 8 November 2013
Line 237:		Line 237:

	Jenkins build [http://www.simantics.org/jenkins/job/target-simantics-head-sdk/ target-simantics-head-sdk] takes care of building and publishing the trunk platform. Other branches have similar builds visible [http://www.simantics.org/jenkins/view/Platform/ here].		Jenkins build [http://www.simantics.org/jenkins/job/target-simantics-head-sdk/ target-simantics-head-sdk] takes care of building and publishing the trunk platform. Other branches have similar builds visible [http://www.simantics.org/jenkins/view/Platform/ here].

	~~==== Deprecated instructions ====~~

	~~TODO: these instructions are out-of-date for Simantics 1.4+ and the proper use of P2 repositories~~

	~~;Standard Procedure:~~
	~~# Test your deployed components.~~
	~~# Read the instructions below and deploy your plug-ins and features as P2 repositories~~
	~~# Make your built P2 repository available on the internet and notify the [[Target Platform#Maintainer\|target platform maintainer]] to grab your changes and update the official target platform.~~

	~~There are two main ways of deploying for the target platform:~~
	* deploying plug-ins and fragments directly
	* deploying plug-ins and fragments through features

	~~These steps can be performed using the Eclipse ''export wizard'' through the ''Plug-in Development/Deployable features'' and ''Plug-in Development/Deployable plug-ins and fragments'' wizards~~

	~~When considering whether your component should have a feature or not, consider these points:~~
	* Eclipse products/applications are always made up of either a set of features or a set of plug-ins. In order for someone to use your component in an product, either your features or your plug-ins need to be included somewhere in the product. If a product is using features and you don't provide one, the product either has to create a new feature and include it or include your plug-ins in his own features.
	* Features can be used as a way to give a collective version all plug-ins of a component. The feature will identify the versions of its included plug-ins but these need not be identical to the feature version. Not all plug-ins have to change versions while a feature version changes each time a new release of the component is made.
	** '''IMPORTANT''': The feature deployment build will produce a ''P2 repository'' containing ''content.jar'', ''artifacts.jar'' and two directories, ''features/'' and ''plugins/''. The features-directory will contain the feature as JAR files which is correct when used as a P2 repository. But if you want to install your deployed features into the current target platforms, the feature jars must be unpacked with the JAR file names as the directory names' '''Don't unpack directly into the features directory''', the feature JARs do not contain a common parent folder. For example, if you've built your feature with an ID '''my.feature''' and version '''1.0.0''', the build will produce a file '''my.feature_1.0.0.jar'''. The contents of this jar must be unpacked into '''features/my.feature_1.0.0/'''. If you copied the JAR files into the features directory and unpack them there, '''do not leave the JARs in the features directory'''. This will also break the features.

	== Building Products ==		== Building Products ==

Tuukka Lehtonen: /* Deploying plug-ins for the target platform */

2013-11-08T00:53:46Z

Deploying plug-ins for the target platform

← Older revision		Revision as of 00:53, 8 November 2013
Line 236:		Line 236:
	# Include them in [[svn:workbench/trunk/org.simantics.sdk.site.feature/\|org.simantics.sdk.site]] feature include them into the platform builds.		# Include them in [[svn:workbench/trunk/org.simantics.sdk.site.feature/\|org.simantics.sdk.site]] feature include them into the platform builds.

	Jenkins ~~builds~~ [http://www.simantics.org/jenkins/job/target-simantics-head-sdk/ target-simantics-head-sdk] and [http://www.simantics.org/jenkins/~~job~~/~~target-simantics-head~~/ ~~target-simantics-head~~] ~~will take care of building and publishing the trunk platform~~.		Jenkins build [http://www.simantics.org/jenkins/job/target-simantics-head-sdk/ target-simantics-head-sdk] takes care of building and publishing the trunk platform. Other branches have similar builds visible [http://www.simantics.org/jenkins/view/Platform/ here].

	==== Deprecated instructions ====		==== Deprecated instructions ====