Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "The Forge"

(Describe how to configure the jar signer in more detail)
 
 
Line 1: Line 1:
This is a user's guide to using the LocationTech forge.
+
This is a user's guide to using the Polarsys forge.
  
LocationTech accounts are identified using the '''email address''' of the individual, except where noted otherwise.
+
Polarsys accounts are identified using the '''email address''' of the individual, except where noted otherwise.
  
 
== Getting an account  ==
 
== Getting an account  ==
  
LocationTech uses the Eclipse Foundation account for authentication purposes.  Anyone can [https://dev.eclipse.org/site_login/ register] for an Eclipse account. If you wish to access the forge as a committer, you need to nominated by an existing project committer and elected by the existing project team before joining a project.
+
Polarsys uses the Eclipse Foundation account for authentication purposes.  Anyone can [https://dev.eclipse.org/site_login/ register] for an Eclipse account. If you wish to access the forge as a committer, you need to nominated by an existing project committer and elected by the existing project team before joining a project.
  
 
== Code ==
 
== Code ==
  
* Git and GitHub are the only SCM used on LocationTech.
+
* Git and GitHub are the only SCM used on Polarsys.
* [http://locationtech.org/r Gerrit] is used for code reviews on LocationTech.
+
* [http://polarsys.org/r Gerrit] is used for code reviews on Polarsys.
* All the code repositories are available at http://locationtech.org/c
+
* All the code repositories are available at http://polarsys.org/c
 
** Use your committer ID (e.g. wbeaton), Do not use your email address
 
** Use your committer ID (e.g. wbeaton), Do not use your email address
** For http protocol you need to use the password generated by Gerrit under [https://locationtech.org/r/#/settings/http-password Settings > Http Password]
+
** For http protocol you need to use the password generated by Gerrit under [https://polarsys.org/r/#/settings/http-password Settings > Http Password]
** For ssh protocol you need to upload your [https://locationtech.org/r/#/settings/ssh-keys ssh public key] to Gerrit.
+
** For ssh protocol you need to upload your [https://polarsys.org/r/#/settings/ssh-keys ssh public key] to Gerrit.
* [https://github.com/locationtech/ LocationTech on GitHub]
+
* [https://github.com/polarsys/ Polarsys on GitHub]
* To create a new repository, please [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Working%20Groups&component=LocationTech file a bug] (using the Eclipse Bugzilla) against the LocationTech Working Group.  Don't forget to state for which LocationTech project you want the new repository.
+
* To create a new repository, please [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Working%20Groups&component=Polarsys file a bug] (using the Eclipse Bugzilla) against the Polarsys Working Group.  Don't forget to state for which Polarsys project you want the new repository.
  
 
== Bugzilla  ==
 
== Bugzilla  ==
  
* Bugzilla is available at https://locationtech.org/bugs/
+
* Bugzilla is available at https://polarsys.org/bugs/
 
* Log in using your '''email address'''
 
* Log in using your '''email address'''
* To create Bugzilla products, components and milestones, please [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Working%20Groups&component=LocationTech file a bug] (using the Eclipse Bugzilla) against the LocationTech Working Group.  Don't forget to state for which LocationTech project you want the new items.
+
* To create Bugzilla products, components and milestones, please [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Working%20Groups&component=Polarsys file a bug] (using the Eclipse Bugzilla) against the Polarsys Working Group.  Don't forget to state for which Polarsys project you want the new items.
  
  
== Hudson ==
+
== Continuous Integration ==
  
* https://locationtech.org/hudson/ - [https://wiki.eclipse.org/Hudson Hudson docs at Eclipse]
+
* https://ci.polarsys.org/ - [https://wiki.eclipse.org/Hudson Hudson docs at Eclipse]
 
* Log in using your email address
 
* Log in using your email address
* Each LocationTech project can have one Hudson instance (called [https://wiki.eclipse.org/Hudson#HIPP HIPP])  
+
* Each Polarsys project can have one Hudson instance (called [https://wiki.eclipse.org/Hudson#HIPP HIPP])  
 
* HIPP owners can administer their instance
 
* HIPP owners can administer their instance
 
* Using Hudson as a file download service is not appropriate.  Promote builds to your project's download area (see below).
 
* Using Hudson as a file download service is not appropriate.  Promote builds to your project's download area (see below).
* To request a HIPP, please [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Working%20Groups&component=LocationTech file a bug] (using the Eclipse Bugzilla) against the LocationTech Working Group.  Don't forget to state for which LocationTech project you want the new Hudson instance.
+
* To request a HIPP, please [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Working%20Groups&component=Polarsys file a bug] (using the Eclipse Bugzilla) against the Polarsys Working Group.  Don't forget to state for which Polarsys project you want the new Hudson instance.
  
 
== Downloads  ==
 
== Downloads  ==
  
* Each project has a downloads area is available at http://download.locationtech.org/downloads/ .
+
* Each project has a downloads area is available at http://download.polarsys.org/ .
 
* HIPP can be configured with write access into your project downloads for easy build promotion.
 
* HIPP can be configured with write access into your project downloads for easy build promotion.
 
* If you do not use HIPP, you can copy build artifacts to /home/httpd/downloads/yourproject or upload them with an SCP/SFTP client using your Committer ID.
 
* If you do not use HIPP, you can copy build artifacts to /home/httpd/downloads/yourproject or upload them with an SCP/SFTP client using your Committer ID.
* Download stats are available to all LocationTech committers from your Eclipse account:
+
* Download stats are available to all committers from your Eclipse account:
 
** https://dev.eclipse.org/committers/committertools/stats.php
 
** https://dev.eclipse.org/committers/committertools/stats.php
 +
* As the downloads area uses donated bandwidth from mirror sites worldwide, download performance is based on Best Effort basis.
 +
** Organizations that make heavy use of Polarsys downloads and require specific, guaranteed performance can mirror the Polarsys downloads repository using RSYNC from GTLib: rsync://rsync.gtlib.gatech.edu/PolarSys. Please contact the Eclipse webmaster (webmaster at eclipse dot org) if you prefer to rsync from download.polarsys.org directly.
  
 
== Forums  ==
 
== Forums  ==
  
* Forums are not enabled for LocationTech.
+
* http://polarsys.org/forums/
 
+
* Log in using your '''email address'''
== Builds and Signing ==
+
* Projects typically get a single forum for discussion. If more than one forum is required for a project, please contact your working group's Steering Committee.
The JAR signing service is up and running @ locationtech.org. Here is a description about how to use it:
+
 
+
From a Maven build, use Eclipse's [https://www.eclipse.org/cbi/maven-plugins/documentation/latest/eclipse-jarsigner-plugin/sign-mojo.html jar signer plugin].
+
Version 1.1.3 and + must be used (currently, it is the latest available).  For non-Maven builds, there is some info at that link that will be of use.
+
 
+
This is a configuration using it in a Maven profile dedicated to signing:
+
  
    <profile>
 
      <id>eclipse-sign</id>
 
      <build>
 
        <plugins>
 
          <!--
 
          https://www.eclipse.org/cbi/maven-plugins/documentation/latest/eclipse-jarsigner-plugin/sign-mojo.html
 
          -->
 
          <plugin>
 
            <groupId>org.eclipse.cbi.maven.plugins</groupId>
 
            <artifactId>eclipse-jarsigner-plugin</artifactId>
 
            <version>1.1.3</version>
 
            <configuration>
 
              <signerUrl>http://locationtech.org:31338/sign</signerUrl>
 
            </configuration>
 
            <executions>
 
              <execution>
 
                <id>sign</id>
 
                <goals>
 
                  <goal>sign</goal>
 
                </goals>
 
                <phase>verify</phase>
 
              </execution>
 
            </executions>
 
          </plugin>
 
        </plugins>
 
      </build>
 
      <pluginRepositories>
 
        <pluginRepository>
 
          <id>cbi-releases</id>
 
          <url>https://repo.eclipse.org/content/repositories/cbi-releases/</url>
 
        </pluginRepository>
 
      </pluginRepositories>
 
    </profile>
 
  
'''The signing server only accepts connections originating from Eclipse infrastructure (e.g. Hudson).''' So to actually do any signing, you'll need to get a Hudson instance and possibly add a Job for the express purpose of signing.  A ramification of this is that if you wish to deploy artifacts to Maven central, you can't (or shouldn't rather) fully use Maven's release plugin, although partial use is still useful.  This is because the actual deployment step should ship Eclipse-signed jars that can only be obtained from a Hudson build server; jars built from a local developer's machine won't be signed.  The Hudson Job should have the profile "eclipse-sign" (as named in this suggested profile config), and it should also be configured to create all auxiliary jar files desired to be deployed if your project wants to deploy them.  For example javadoc jar, source jar, test jar, maybe other custom ones as desired.  That can be done by configuring Maven plugins to execute certain goals, or it can be configured in the Hudson Job by adding <tt>javadoc:jar jar:test-jar source:jar</tt> to the goals list for example.  The configuration above shows that the signing of available jars will happen at the Maven "verify" goal.
 
  
 
== Mailing lists  ==
 
== Mailing lists  ==
  
* http://locationtech.org/mailman/. Users can then subscribe to the mailing lists using the list's info page.
+
* http://polarsys.org/mailman/. Users can then subscribe to the mailing lists using the list's info page.
* To request a new mailing list, please [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Working%20Groups&component=LocationTech file a bug] (using the Eclipse Bugzilla) against the LocationTech Working Group.  Don't forget to state for which LocationTech project you want the new list.
+
* To request a new mailing list, please [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Working%20Groups&component=Polarsys file a bug] (using the Eclipse Bugzilla) against the Polarsys Working Group.  Don't forget to state for which Polarsys project you want the new list.
  
 
== Help documentation  ==
 
== Help documentation  ==
Line 99: Line 61:
 
'''Help documentation is not installed yet. Contact [mailto:webmaster@eclipse.org Webmaster] for more information.'''
 
'''Help documentation is not installed yet. Contact [mailto:webmaster@eclipse.org Webmaster] for more information.'''
  
* http://locationtech.org/help/  
+
* http://polarsys.org/help/  
 
* Documentation plugins must be uploaded to /home/httpd/help/eclipse/dropins/ by the webmaster.  Please contact [mailto:webmaster@eclipse.org Webmaster], and provide the location of your doc plugins.
 
* Documentation plugins must be uploaded to /home/httpd/help/eclipse/dropins/ by the webmaster.  Please contact [mailto:webmaster@eclipse.org Webmaster], and provide the location of your doc plugins.
  
 
== Website ==
 
== Website ==
* http://locationtech.org/
+
* http://polarsys.org/
 
* Only designated editors can modify content.
 
* Only designated editors can modify content.
 
* Project-related content can be modified by project leads committers, and PMC leads and members.
 
* Project-related content can be modified by project leads committers, and PMC leads and members.

Latest revision as of 07:58, 2 January 2018

This is a user's guide to using the Polarsys forge.

Polarsys accounts are identified using the email address of the individual, except where noted otherwise.

Getting an account

Polarsys uses the Eclipse Foundation account for authentication purposes. Anyone can register for an Eclipse account. If you wish to access the forge as a committer, you need to nominated by an existing project committer and elected by the existing project team before joining a project.

Code

  • Git and GitHub are the only SCM used on Polarsys.
  • Gerrit is used for code reviews on Polarsys.
  • All the code repositories are available at http://polarsys.org/c
    • Use your committer ID (e.g. wbeaton), Do not use your email address
    • For http protocol you need to use the password generated by Gerrit under Settings > Http Password
    • For ssh protocol you need to upload your ssh public key to Gerrit.
  • Polarsys on GitHub
  • To create a new repository, please file a bug (using the Eclipse Bugzilla) against the Polarsys Working Group. Don't forget to state for which Polarsys project you want the new repository.

Bugzilla

  • Bugzilla is available at https://polarsys.org/bugs/
  • Log in using your email address
  • To create Bugzilla products, components and milestones, please file a bug (using the Eclipse Bugzilla) against the Polarsys Working Group. Don't forget to state for which Polarsys project you want the new items.


Continuous Integration

  • https://ci.polarsys.org/ - Hudson docs at Eclipse
  • Log in using your email address
  • Each Polarsys project can have one Hudson instance (called HIPP)
  • HIPP owners can administer their instance
  • Using Hudson as a file download service is not appropriate. Promote builds to your project's download area (see below).
  • To request a HIPP, please file a bug (using the Eclipse Bugzilla) against the Polarsys Working Group. Don't forget to state for which Polarsys project you want the new Hudson instance.

Downloads

  • Each project has a downloads area is available at http://download.polarsys.org/ .
  • HIPP can be configured with write access into your project downloads for easy build promotion.
  • If you do not use HIPP, you can copy build artifacts to /home/httpd/downloads/yourproject or upload them with an SCP/SFTP client using your Committer ID.
  • Download stats are available to all committers from your Eclipse account:
  • As the downloads area uses donated bandwidth from mirror sites worldwide, download performance is based on Best Effort basis.
    • Organizations that make heavy use of Polarsys downloads and require specific, guaranteed performance can mirror the Polarsys downloads repository using RSYNC from GTLib: rsync://rsync.gtlib.gatech.edu/PolarSys. Please contact the Eclipse webmaster (webmaster at eclipse dot org) if you prefer to rsync from download.polarsys.org directly.

Forums

  • http://polarsys.org/forums/
  • Log in using your email address
  • Projects typically get a single forum for discussion. If more than one forum is required for a project, please contact your working group's Steering Committee.


Mailing lists

  • http://polarsys.org/mailman/. Users can then subscribe to the mailing lists using the list's info page.
  • To request a new mailing list, please file a bug (using the Eclipse Bugzilla) against the Polarsys Working Group. Don't forget to state for which Polarsys project you want the new list.

Help documentation

Help documentation is not installed yet. Contact Webmaster for more information.

  • http://polarsys.org/help/
  • Documentation plugins must be uploaded to /home/httpd/help/eclipse/dropins/ by the webmaster. Please contact Webmaster, and provide the location of your doc plugins.

Website

  • http://polarsys.org/
  • Only designated editors can modify content.
  • Project-related content can be modified by project leads committers, and PMC leads and members.
  • Log in using your email address

See also

Back to the top