Skip to content

Commit 6a7844d

Browse files
committed
README-MAINTAINER: add SimRel & EPP
1 parent 1e19b56 commit 6a7844d

File tree

1 file changed

+94
-65
lines changed

1 file changed

+94
-65
lines changed

README-MAINTAINER.md

+94-65
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,7 @@ The official download page is
5454

5555
- https://projects.eclipse.org/projects/iot.embed-cdt/downloads/
5656

57-
## How to fix issues
58-
59-
Normally all changes should be done as a result of a ticket registered as
60-
a GitHub Issue.
57+
## Prepare release
6158

6259
### Create a new milestone
6360

@@ -73,6 +70,9 @@ milestone. As title, use the current version, like _v6.0.0_.
7370

7471
### Fix issues
7572

73+
Normally all changes should be done as a result of a ticket registered as
74+
a GitHub Issue.
75+
7676
- be sure the `develop` branch is selected
7777
- scan the
7878
[plug-ins issues](https://github.com/eclipse-embed-cdt/eclipse-plugins/issues/)
@@ -82,7 +82,9 @@ number, like `[#122]`;
8282
- add a message like _fixed on 2020-01-10_;
8383
- close the issues
8484

85-
### Build locally
85+
## Build locally
86+
87+
### Run maven
8688

8789
After fixing issues, run the maven build locally:
8890

@@ -92,6 +94,8 @@ $ mvn clean verify
9294

9395
Start a Debug/Run session and try the result in a child Eclipse.
9496

97+
## How to make the pre-release
98+
9599
### Push to GitHub
96100

97101
Be sure the repo is clean and push the `develop` branch to GitHub.
@@ -140,6 +144,8 @@ Jenkins job to copy the files from `builds/master` to `updates/v6-test/`,
140144
which is the public location for the pre-release
141145
- click the **Build Now** link
142146

147+
### Announce pre-release
148+
143149
Announce the pre-release to the **[email protected]** list;
144150
use a subject like **Eclipse Embedded CDT v6.0.0 released**, and
145151
pass a link to the release page.
@@ -192,9 +198,10 @@ Start with _Pre-release_ (Header 3).
192198
<li>none</li>
193199
</ul>
194200

195-
<p>More details at GitHub:<br />
196-
<br />
197-
- <a href="https://github.com/eclipse-embed-cdt/eclipse-plugins/milestone/19">https://github.com/eclipse-embed-cdt/eclipse-plugins/milestone/19</a></p>
201+
<p>More details at GitHub:</p>
202+
<ul>
203+
<li><a href="https://github.com/eclipse-embed-cdt/eclipse-plugins/milestone/19">https://github.com/eclipse-embed-cdt/eclipse-plugins/milestone/19</a></li>
204+
</ul>
198205

199206
<h3>Release content</h3>
200207

@@ -229,7 +236,7 @@ Select the **Release Type** (major, minor, service).
229236

230237
Install the plug-ins on several platforms.
231238

232-
### Publish the final release
239+
## Publish the final release
233240

234241
When the plug-ins are considered stable:
235242

@@ -310,89 +317,111 @@ Update the URLs to use the download redirect:
310317

311318
Remove the _Pre-release_ top header.
312319

313-
### Create the test package (deprecated)
320+
### Update the Downloads page
314321

315-
TODO: explain how to edit/update the EPP project.
322+
- go to [iot.embed-cdt](https://projects.eclipse.org/projects/iot.embed-cdt/) and select the new release
323+
- click Edit -> The Basics
324+
- switch to Source mode
316325

317-
- switch to the `embed-cdt-develop` branch
318-
- in the `parent/pom.xml` file, edit the Embed CDT specifics
319-
- commit
320-
- push `embed-cdt-develop` to GitHub
321-
- go to https://ci.eclipse.org/embed-cdt/
322-
- login (otherwise the next link is not visible!)
323-
- use the [make-packages](https://ci.eclipse.org/embed-cdt/job/make-packages/)
324-
Jenkins job to maven build the `embed-cdt-develop` branch and
325-
copy the result in `packages-test/<version>
326-
- click the **Build Now** link
326+
Use copy/paste/edit.
327327

328-
The direct download URL is:
328+
## Check & update SimRel
329329

330-
- https://download.eclipse.org/embed-cdt/packages-test/
330+
Use the CBI Aggregator installed from:
331331

332-
Check if everything is fine and test.
332+
- https://download.eclipse.org/cbi/updates/aggregator/ide/4.13
333333

334-
Test on various platforms.
334+
The first time clone the SimRel Git project:
335335

336-
### Create the final package (deprecated)
336+
```
337+
git clone "ssh://[email protected]:29418/simrel/org.eclipse.simrel.build"
338+
scp -p -P 29418 [email protected]:hooks/commit-msg "org.eclipse.simrel.build/.git/hooks/"
339+
```
337340

338-
- merge `embed-cdt-develop` int `embed-cdt`
339-
- push `embed-cdt` to GitHub
340-
- tag `2020-09_R-ecdt`
341-
- go to https://ci.eclipse.org/embed-cdt/
342-
- login (otherwise the next link is not visible!)
343-
- use the [make-packages](https://ci.eclipse.org/embed-cdt/job/make-packages/)
344-
Jenkins job to maven build the `embed-cdt` branch and
345-
copy the result in `packages/<version>
346-
- click the **Build Now** link
341+
In subsequent runs, pull new commits.
347342

348-
The direct download URL is:
343+
In Eclipse:
349344

350-
- `https://download.eclipse.org/embed-cdt/packages/`
345+
- import existing project `org.eclipse.simrel.build`
346+
- open `simrel.aggr`
347+
- expand the 'Contribution: Embedded CDT'
348+
- select **Mapped Repository**
349+
- right click: **Show Properties View**
350+
- in the right side, edit the **Location** field to the new p2 URL and press Enter
351+
- select all the features in the contribution, right-click and choose **Fix Versions**
352+
- select the Contribution and **Validate**
353+
- select the Aggregation and **Validate**
351354

352-
### Update the release record (deprecated)
355+
```bash
356+
git commit
357+
git push ssh://[email protected]:29418/simrel/org.eclipse.simrel.build HEAD:refs/for/master
358+
```
353359

354-
- go to [iot.embed-cdt](https://projects.eclipse.org/projects/iot.embed-cdt/governance/) and select the new release
355-
- click Edit -> The Basics
356-
- switch to Source mode
360+
In Gerrit, click **CODE_REVIEW+2** and then **SUBMIT** to merge the changes.
357361

358-
```html
359-
<h3>Eclipse IDE for Embedded C/C++ Developers</h3>
362+
The commit will trigger the [SimRel](https://ci.eclipse.org/simrel/)
363+
Jenkins aggregator pipeline:
360364

361-
<p>For convenience, this version of the plug-ins is also available as Eclipse packages, which pack together the <strong>Eclipse IDE for C/C++ Developers</strong> standard distribution with the <strong>Eclipse Embedded CDT plug-ins</strong>:</p>
365+
- https://ci.eclipse.org/simrel/job/simrel.runaggregator.pipeline/
362366

363-
<h4>2020-06 (Eclipse 4.16)</h4>
367+
In about one hour it'll automatically rebuild the staging repo:
364368

365-
<ul>
366-
<li>Windows <a href="https://www.eclipse.org/downloads/download.php?file=/embed-cdt/packages/2020-06/eclipse-embedcdt-2020-06-R-win32.win32.x86_64.zip">64-bit</a> <a href="https://www.eclipse.org/downloads/download.php?file=/embed-cdt/packages/2020-06/eclipse-embedcdt-2020-06-R-win32.win32.x86_64.zip.sha">SHA</a></li>
367-
<li>macOS <a href="https://www.eclipse.org/downloads/download.php?file=/embed-cdt/packages/2020-06/eclipse-embedcdt-2020-06-R-macosx.cocoa.x86_64.tar.gz">64-bit</a> <a href="https://www.eclipse.org/downloads/download.php?file=/embed-cdt/packages/2020-06/eclipse-embedcdt-2020-06-R-macosx.cocoa.x86_64.tar.gz.sha">SHA</a></li>
368-
<li>Intel Linux <a href="https://www.eclipse.org/downloads/download.php?file=/embed-cdt/packages/2020-06/eclipse-embedcdt-2020-06-R-linux.gtk.x86_64.tar.gz">64-bit</a> <a href="https://www.eclipse.org/downloads/download.php?file=/embed-cdt/packages/2020-06/eclipse-embedcdt-2020-06-R-linux.gtk.x86_64.tar.gz.sha">SHA</a></li>
369-
<li>Arm Linux <a href="https://www.eclipse.org/downloads/download.php?file=/embed-cdt/packages/2020-06/eclipse-embedcdt-2020-06-R-linux.gtk.aarch64.tar.gz">64-bit</a> <a href="https://www.eclipse.org/downloads/download.php?file=/embed-cdt/packages/2020-06/eclipse-embedcdt-2020-06-R-linux.gtk.aarch64.tar.gz.sha">SHA</a></li>
370-
</ul>
369+
- https://download.eclipse.org/staging/
371370

372-
<h4>macOS security notice</h4>
371+
## Check & update EPP
373372

374-
<p>On macOS, if you download the archive with the browser, the strict security checks on recent macOS will prevent it to run, and complain that the program is damaged. That&#39;s obviously not true, and the fix is simple, you need to remove the <strong>com.apple.quarantine</strong> extended attribute.</p>
373+
If the list of features changed, it is necessary to
374+
update the EPP project.
375375

376-
<pre>
377-
$ xattr -d com.apple.quarantine ~/Downloads/eclipse-embedcdt-2020-06-R-macosx.cocoa.x86_64.tar.gz</pre>
376+
The first time clone the EPP Git project:
377+
378+
```
379+
git clone "ssh://[email protected]:29418/epp/org.eclipse.epp.packages.git"
380+
scp -p -P 29418 [email protected]:hooks/commit-msg "epp/org.eclipse.epp.packages.git/.git/hooks/"
381+
```
378382

379-
<p>After un-archiving, if the Eclipse.app still does not run, check/remove the attribute from the Eclipse.app folder too:</p>
383+
In subsequent runs, pull new commits.
380384

381-
<pre>
382-
$ xattr -dr com.apple.quarantine ~/Downloads/Eclipse.app
383-
</pre>
385+
- edit `org.eclipse.epp.package.embedcpp.product/epp.product`
386+
- update the list of features
387+
388+
To change the default preferences, edit the
389+
`org.eclipse.epp.package.embedcpp/plugin_customization.ini`
384390

391+
If necessary, update the text displayed in the Downloads page, it is in
392+
`org.eclipse.epp.package.embedcpp.feature/epp.website.xml` file, the
393+
`<description>` element.
394+
395+
Commit and push to Gerrit:
396+
397+
```bash
398+
git commit
399+
git push ssh://[email protected]:29418/epp/org.eclipse.epp.packages.git HEAD:refs/for/master
385400
```
386401

387-
### Update the Downloads page
402+
In Gerrit, click **CODE_REVIEW+2** and then **SUBMIT** to merge the changes.
388403

389-
- go to [iot.embed-cdt](https://projects.eclipse.org/projects/iot.embed-cdt/) and select the new release
390-
- click Edit -> The Basics
391-
- switch to Source mode
404+
The commit will trigger the [EPP](https://ci.eclipse.org/packaging/)
405+
Jenkins job:
392406

393-
Use copy/paste/edit.
407+
- https://ci.eclipse.org/packaging/job/simrel.epp-tycho-build/
408+
409+
In 1.5 hours the new test versions of the integrated epp builds are
410+
available from:
411+
412+
- https://ci.eclipse.org/packaging/job/simrel.epp-tycho-build/lastSuccessfulBuild/artifact/org.eclipse.epp.packages/archive/
413+
414+
### Announce release
415+
416+
Announce the release to the **[email protected]** list;
417+
use a subject like **Eclipse Embedded CDT v6.0.0 released**, and
418+
pass a link to the release page.
419+
420+
Beta testers can install the pre-release from:
421+
422+
- https://ci.eclipse.org/packaging/job/simrel.epp-tycho-build/lastSuccessfulBuild/artifact/org.eclipse.epp.packages/archive/
394423

395-
### Share on Twitter
424+
## Share on Twitter
396425

397426
- in a separate browser windows, open [TweetDeck](https://tweetdeck.twitter.com/)
398427
- using the `@embedCDT` account, enter a message like

0 commit comments

Comments
 (0)