Theory Plug-in Developer Documentation - Revision history

Guillaume: Add step to speed up composite sites

2024-11-15T15:35:25Z

Add step to speed up composite sites

← Older revision		Revision as of 15:35, 15 November 2024
Line 21:		Line 21:
	*** in <code>/home/project-web/rodin-b-sharp/htdocs/updates</code> for the files built from <code>composite/compSite.xml</code>		*** in <code>/home/project-web/rodin-b-sharp/htdocs/updates</code> for the files built from <code>composite/compSite.xml</code>
	*** in <code>/home/project-web/rodin-b-sharp/htdocs/updates-archive</code> for the files built from <code>composite-archive/compSite.xml</code>		*** in <code>/home/project-web/rodin-b-sharp/htdocs/updates-archive</code> for the files built from <code>composite-archive/compSite.xml</code>
			*** to speed up the composite site, create a directory with the version number in <code>/home/project-web/rodin-b-sharp/htdocs/updates/Plugin_Theory</code> and put in that directory a copy of the files <code>p2.index</code>, <code>content.xml.xz</code> and <code>artifacts.xml.xz</code> that were uploaded to Sourceforge in step 2
	* Publish the release notes in the [[Theory Release History]] page, update the table in the [[Rodin Platform Releases]] page and list the release in [[Template:Dev News]] (it is included in the front page)		* Publish the release notes in the [[Theory Release History]] page, update the table in the [[Rodin Platform Releases]] page and list the release in [[Template:Dev News]] (it is included in the front page)
	* Announce the release on the Rodin mailing lists rodin-b-sharp-user@lists.sourceforge.net and rodin-b-sharp-announce@lists.sourceforge.net		* Announce the release on the Rodin mailing lists rodin-b-sharp-user@lists.sourceforge.net and rodin-b-sharp-announce@lists.sourceforge.net

Guillaume: Update instructions to manage composite update sites

2024-05-30T14:31:11Z

Update instructions to manage composite update sites

← Older revision		Revision as of 14:31, 30 May 2024
Line 15:		Line 15:
	* Update the composite Eclipse repository that provides the Rodin plug-ins:		* Update the composite Eclipse repository that provides the Rodin plug-ins:
	** Clone the <code>RodinUpdateSite</code> folder from the [https://sourceforge.net/p/rodin-b-sharp/svn/HEAD/tree/trunk/RodinUpdateSite/ Subversion repository] and import it in Eclipse		** Clone the <code>RodinUpdateSite</code> folder from the [https://sourceforge.net/p/rodin-b-sharp/svn/HEAD/tree/trunk/RodinUpdateSite/ Subversion repository] and import it in Eclipse
	** Open the <code>composite/compSite.xml</code> file, ~~add a~~ <code><repository></code> line ~~for~~ the ~~new~~ version and ~~follow~~ the instructions in the ~~file~~'s comments to build the ~~composite repository~~		** Open the <code>composite/compSite.xml</code> file, copy the <code><repository location="https://rodin-b-sharp.sourceforge.net/updates/Plugin_Theory/X.Y.Z" /></code> line, then update the version number in that line
	** Connect with an SFTP client to <code>web.sourceforge.net</code> (see [https://sourceforge.net/p/forge/documentation/SFTP#for-managing-project-web-space Sourceforge's documentation]) and upload the files built previously (<code>p2.index</code>, <code>compositeArtifacts.jar</code>, <code>compositeContent.jar</code>) in <code>/home/project-web/rodin-b-sharp/htdocs/updates</code>		** Open the <code>composite-archive/compSite.xml</code> file and paste the old <code><repository></code> line copied previously
			** Follow the instructions in the files' comments to build the repositories
			** Connect with an SFTP client to <code>web.sourceforge.net</code> (see [https://sourceforge.net/p/forge/documentation/SFTP#for-managing-project-web-space Sourceforge's documentation]) and upload the files built previously (<code>p2.index</code>, <code>compositeArtifacts.jar</code>, <code>compositeContent.jar</code>):
			*** in <code>/home/project-web/rodin-b-sharp/htdocs/updates</code> for the files built from <code>composite/compSite.xml</code>
			*** in <code>/home/project-web/rodin-b-sharp/htdocs/updates-archive</code> for the files built from <code>composite-archive/compSite.xml</code>
	* Publish the release notes in the [[Theory Release History]] page, update the table in the [[Rodin Platform Releases]] page and list the release in [[Template:Dev News]] (it is included in the front page)		* Publish the release notes in the [[Theory Release History]] page, update the table in the [[Rodin Platform Releases]] page and list the release in [[Template:Dev News]] (it is included in the front page)
	* Announce the release on the Rodin mailing lists rodin-b-sharp-user@lists.sourceforge.net and rodin-b-sharp-announce@lists.sourceforge.net		* Announce the release on the Rodin mailing lists rodin-b-sharp-user@lists.sourceforge.net and rodin-b-sharp-announce@lists.sourceforge.net

Guillaume: Update path to file used to generate update site

2021-07-15T07:15:37Z

Update path to file used to generate update site

← Older revision		Revision as of 07:15, 15 July 2021
Line 15:		Line 15:
	* Update the composite Eclipse repository that provides the Rodin plug-ins:		* Update the composite Eclipse repository that provides the Rodin plug-ins:
	** Clone the <code>RodinUpdateSite</code> folder from the [https://sourceforge.net/p/rodin-b-sharp/svn/HEAD/tree/trunk/RodinUpdateSite/ Subversion repository] and import it in Eclipse		** Clone the <code>RodinUpdateSite</code> folder from the [https://sourceforge.net/p/rodin-b-sharp/svn/HEAD/tree/trunk/RodinUpdateSite/ Subversion repository] and import it in Eclipse
	** Open the <code>compSite.xml</code> file, add a <code><repository></code> line for the new version and follow the instructions in the file's comments to build the composite repository		** Open the <code>composite/compSite.xml</code> file, add a <code><repository></code> line for the new version and follow the instructions in the file's comments to build the composite repository
	** Connect with an SFTP client to <code>web.sourceforge.net</code> (see [https://sourceforge.net/p/forge/documentation/SFTP#for-managing-project-web-space Sourceforge's documentation]) and upload the files built previously (<code>p2.index</code>, <code>compositeArtifacts.jar</code>, <code>compositeContent.jar</code>) in <code>/home/project-web/rodin-b-sharp/htdocs/updates</code>		** Connect with an SFTP client to <code>web.sourceforge.net</code> (see [https://sourceforge.net/p/forge/documentation/SFTP#for-managing-project-web-space Sourceforge's documentation]) and upload the files built previously (<code>p2.index</code>, <code>compositeArtifacts.jar</code>, <code>compositeContent.jar</code>) in <code>/home/project-web/rodin-b-sharp/htdocs/updates</code>
	* Publish the release notes in the [[Theory Release History]] page, update the table in the [[Rodin Platform Releases]] page and list the release in [[Template:Dev News]] (it is included in the front page)		* Publish the release notes in the [[Theory Release History]] page, update the table in the [[Rodin Platform Releases]] page and list the release in [[Template:Dev News]] (it is included in the front page)

Guillaume: Fix some links

2021-06-14T14:52:40Z

Fix some links

← Older revision		Revision as of 14:52, 14 June 2021
Line 17:		Line 17:
	** Open the <code>compSite.xml</code> file, add a <code><repository></code> line for the new version and follow the instructions in the file's comments to build the composite repository		** Open the <code>compSite.xml</code> file, add a <code><repository></code> line for the new version and follow the instructions in the file's comments to build the composite repository
	** Connect with an SFTP client to <code>web.sourceforge.net</code> (see [https://sourceforge.net/p/forge/documentation/SFTP#for-managing-project-web-space Sourceforge's documentation]) and upload the files built previously (<code>p2.index</code>, <code>compositeArtifacts.jar</code>, <code>compositeContent.jar</code>) in <code>/home/project-web/rodin-b-sharp/htdocs/updates</code>		** Connect with an SFTP client to <code>web.sourceforge.net</code> (see [https://sourceforge.net/p/forge/documentation/SFTP#for-managing-project-web-space Sourceforge's documentation]) and upload the files built previously (<code>p2.index</code>, <code>compositeArtifacts.jar</code>, <code>compositeContent.jar</code>) in <code>/home/project-web/rodin-b-sharp/htdocs/updates</code>
	* Publish the release notes in the [[Theory ~~Plug-in~~]] page, update the table in the [[Rodin Platform Releases]] page and list the release in [[Template:Dev News]] (it is included in the front page)		* Publish the release notes in the [[Theory Release History]] page, update the table in the [[Rodin Platform Releases]] page and list the release in [[Template:Dev News]] (it is included in the front page)
	* Announce the release on the Rodin mailing lists rodin-b-sharp-user@lists.sourceforge.net and rodin-b-sharp-announce@lists.sourceforge.net		* Announce the release on the Rodin mailing lists rodin-b-sharp-user@lists.sourceforge.net and rodin-b-sharp-announce@lists.sourceforge.net

	[[Category:Developer documentation]]		[[Category:Developer documentation]]
			[[Category:Theory Plug-in]]

Guillaume: New page with info about Eclipse setup and release process

2021-06-14T14:45:51Z

New page with info about Eclipse setup and release process

New page

This page provides some documentation for developers of the Theory plug-in. Documentation for users of the plug-in is available in [[Theory Plug-in|this page]].

== Eclipse setup ==

* Clone the [https://sourceforge.net/p/rodin-b-sharp/theory git repository] from Sourceforge
* Import the subdirectories of the git repository in Eclipse (each subdirectory corresponds to an Eclipse project providing an Eclipse feature or plug-in)
* Open <code>org.eventb.theory.feature/org.eventb.theory.feature.target</code> and click on ''Set as Active Target Platform'', at the top right of the window; this assumes that the [https://sourceforge.net/projects/rodin-b-sharp/files/Core_Rodin_Platform/3.5/org.rodinp.dev-3.5.0-9f39f1653.zip/download Rodin target platform] has been downloaded and put in <code>/var/tmp</code>: if this location is not available, or if another version of Rodin is should be targeted, edit the <code>.target</code> file accordingly

== Release checklist ==

To release a new version of the plug-in:

* Tag the last commit with the version number (remember to pass the <code>--tags</code> flag to <code>git push</code> to publish it)
* On Sourceforge, create a new folder with the version number in the [https://sourceforge.net/projects/rodin-b-sharp/files/Plugin_Theory/ plug-in's directory] and upload the files of the update site there (they are built in <code>org.eventb.theory.repository/target/repository</code>)
* Update the composite Eclipse repository that provides the Rodin plug-ins:
** Clone the <code>RodinUpdateSite</code> folder from the [https://sourceforge.net/p/rodin-b-sharp/svn/HEAD/tree/trunk/RodinUpdateSite/ Subversion repository] and import it in Eclipse
** Open the <code>compSite.xml</code> file, add a <code><repository></code> line for the new version and follow the instructions in the file's comments to build the composite repository
** Connect with an SFTP client to <code>web.sourceforge.net</code> (see [https://sourceforge.net/p/forge/documentation/SFTP#for-managing-project-web-space Sourceforge's documentation]) and upload the files built previously (<code>p2.index</code>, <code>compositeArtifacts.jar</code>, <code>compositeContent.jar</code>) in <code>/home/project-web/rodin-b-sharp/htdocs/updates</code>
* Publish the release notes in the [[Theory Plug-in]] page, update the table in the [[Rodin Platform Releases]] page and list the release in [[Template:Dev News]] (it is included in the front page)
* Announce the release on the Rodin mailing lists rodin-b-sharp-user@lists.sourceforge.net and rodin-b-sharp-announce@lists.sourceforge.net

[[Category:Developer documentation]]