Skip to content

Commit 34ae4eb

Browse files
committed
READMEs updates
1 parent 9f0717a commit 34ae4eb

File tree

2 files changed

+92
-114
lines changed

2 files changed

+92
-114
lines changed

Diff for: README-EPP.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
2+
## Prerequisites
3+
4+
### Clone EPP
5+
6+
At first use, clone the EPP Git repo:
7+
8+
```bash
9+
git clone ssh://[email protected]:29418/epp/org.eclipse.epp.packages.git org.eclipse.epp.packages.git
10+
mkdir -p org.eclipse.epp.packages.git/.git/hooks/
11+
scp -p -P 29418 [email protected]:hooks/commit-msg org.eclipse.epp.packages.git/.git/hooks/
12+
```
13+
14+
### EPP deadline
15+
16+
The deadline for EPP changes is **Thu 9am Ottawa time**.
17+
18+
## Check & update EPP
19+
20+
If the list of features changed, it is necessary to
21+
update the EPP project.
22+
23+
Pull new commits.
24+
25+
- edit `packages/org.eclipse.epp.package.embedcpp.product/epp.product`
26+
- update the list of features
27+
28+
### package.embedcpp
29+
30+
To change the default preferences, edit the
31+
`packages/org.eclipse.epp.package.embedcpp/plugin_customization.ini`
32+
33+
### package.embedcpp.feature
34+
35+
If necessary, update the text displayed in the Downloads page, it is in
36+
`packages/org.eclipse.epp.package.embedcpp.feature/epp.website.xml` file, the
37+
`<description>` element.
38+
39+
Update the version in **NewAndNoteworthy**, in the same file.
40+
41+
### Compare to package.cpp
42+
43+
Compare the three packages with the similar ones from CPP:
44+
45+
```sh
46+
cd org.eclipse.epp.packages.git
47+
48+
diff packages/org.eclipse.epp.package.cpp packages/org.eclipse.epp.package.embedcpp
49+
diff packages/org.eclipse.epp.package.cpp.feature packages/org.eclipse.epp.package.embedcpp.feature
50+
diff packages/org.eclipse.epp.package.cpp.product packages/org.eclipse.epp.package.embedcpp.product
51+
```
52+
53+
### Commit & push
54+
55+
Commit and push to Gerrit:
56+
57+
```bash
58+
git commit -m 'embedcpp: ...'
59+
git push ssh://[email protected]:29418/epp/org.eclipse.epp.packages.git HEAD:refs/for/master
60+
```
61+
62+
In Gerrit, click **CODE_REVIEW+2** and then **SUBMIT** to merge the changes.
63+
64+
The commit will trigger the [EPP](https://ci.eclipse.org/packaging/)
65+
Jenkins job:
66+
67+
- <https://ci.eclipse.org/packaging/job/simrel.epp-tycho-build/>
68+
69+
In 1.5 hours the new test versions of the integrated epp builds are
70+
available from:
71+
72+
- <https://ci.eclipse.org/packaging/job/simrel.epp-tycho-build/lastSuccessfulBuild/artifact/org.eclipse.epp.packages/archive/>
73+

Diff for: README-MAINTAINER.md

+19-114
Original file line numberDiff line numberDiff line change
@@ -69,20 +69,6 @@ to
6969

7070
The deadline for SimRel changes is **Wed 5pm Ottawa time**.
7171

72-
### Clone EPP (deprecated)
73-
74-
At first use, clone the EPP Git repo:
75-
76-
```bash
77-
git clone ssh://[email protected]:29418/epp/org.eclipse.epp.packages.git org.eclipse.epp.packages.git
78-
mkdir -p org.eclipse.epp.packages.git/.git/hooks/
79-
scp -p -P 29418 [email protected]:hooks/commit-msg org.eclipse.epp.packages.git/.git/hooks/
80-
```
81-
82-
### EPP deadline (deprecated)
83-
84-
The deadline for EPP changes is **Thu 9am Ottawa time**.
85-
8672
### Create a new milestone
8773

8874
If not already done, create a new milestone.
@@ -239,65 +225,40 @@ Start with _Release candidate_ (Header 3).
239225
<p>For those who want to beta test, the release candidate is available via <strong>Install New Software</strong> from:</p>
240226

241227
<ul>
242-
<li>https://download.eclipse.org/embed-cdt/updates/v6-test/</li>
228+
<li>https://download.eclipse.org/embed-cdt/updates/v6-test/</li>
243229
</ul>
244230
```
245231

246232
Select the **Release Type** (major, minor, service).
247233

248-
Click the bottom **Save** button.
234+
Click the bottom **Save** button. Leave the page.
249235

250236
### Test
251237

252238
Install the plug-ins on several platforms.
253239

254240
### Update SimRel for the release candidate (optional)
255241

256-
If everything is fine, update SimRel.
257-
258-
With a Git client:
242+
Full instructions are here: <https://github.com/orgs/eclipse-simrel/discussions/3>
259243

260-
- open `org.eclipse.simrel.build.git`
261-
- pull new commits
244+
but the simple version is update and create a PR against <https://github.com/eclipse-simrel/simrel.build>
262245

263-
Go to the release candidate folder
246+
If everything is fine, sync the SimRel fork:
264247

265-
- [https://download.eclipse.org/embed-cdt/release-candidates/](https://download.eclipse.org/embed-cdt/release-candidates/)
248+
- <https://github.com/embed-cdt/simrel.build>
266249

267-
In Eclipse:
250+
With a Git client:
268251

269-
- import existing project `org.eclipse.simrel.build`
270-
- open `simrel.aggr`
271-
- expand the 'Contribution: Embedded CDT'
272-
- select **Mapped Repository**
273-
- right click: **Show Properties View**
274-
- in the right side, edit the **Location** field to the new release
275-
candidate p2 URL (like
276-
`https://download.eclipse.org/embed-cdt/release-candidates/6.6.0-202403210905/p2/`
277-
and press Enter
278-
- select all the features in the contribution, right-click and choose
279-
**Fix Versions**
280-
- select the Contribution and **Validate**
281-
- select the Aggregation and **Validate**
282-
- Save
283-
- stage `simrel.aggr` & `embedcdt.aggrcon`
252+
- open `simrel.build-fork.git`
253+
- pull new commits
254+
- edit `embedcdt.aggrcon`
255+
- replace location to <https://download.eclipse.org/embed-cdt/release-candidates/6.6.0-202403210905/p2/>
256+
- replace full version to `6.6.0.202403210905`
257+
- replace short version to `6.6.0`
284258
- commit with a message like:
285-
- _embedcdt: update for 6.6.0-202403210905_,
286-
- _Signed-off-by: Liviu Ionescu <[email protected]>_
287-
- click the **Commit** button (do not Push yet)
288-
- right click, Show in local Terminal
289-
290-
```bash
291-
git push ssh://[email protected]:29418/simrel/org.eclipse.simrel.build HEAD:refs/for/master
292-
```
293-
294-
This will trigger a Gerrit run.
295-
296-
Check the console output, for the Gerrit link. If missed, it'll be
297-
later sent by e-mail, when the run completes.
298-
299-
In Gerrit web page, if the check is successful and Verified+1 is shown,
300-
click **CODE_REVIEW+2** and then **SUBMIT** to merge the changes.
259+
- _embedcdt: update for 6.6.0-202403210905 release candidate_,
260+
- push
261+
- create pull request
301262

302263
The commit will trigger the [SimRel](https://ci.eclipse.org/simrel/)
303264
Jenkins aggregator pipeline:
@@ -469,8 +430,8 @@ In Eclipse:
469430
- select **Mapped Repository**
470431
- right click: **Show Properties View**
471432
- in the right side, edit the **Location** field to the new release p2 URL
472-
(like `https://download.eclipse.org/embed-cdt/releases/6.6.0/p2/`
473-
and press Enter
433+
(like `https://download.eclipse.org/embed-cdt/releases/6.6.0/p2/`)
434+
and press Enter
474435
- select all the features in the contribution, right-click and choose
475436
**Fix Versions**
476437
- select the Contribution and **Validate**
@@ -503,62 +464,6 @@ After another while (about 10 min) it'll automatically rebuild the staging repo:
503464

504465
- <https://download.eclipse.org/staging/>
505466

506-
## Check & update EPP
507-
508-
If the list of features changed, it is necessary to
509-
update the EPP project.
510-
511-
Pull new commits.
512-
513-
- edit `packages/org.eclipse.epp.package.embedcpp.product/epp.product`
514-
- update the list of features
515-
516-
### package.embedcpp
517-
518-
To change the default preferences, edit the
519-
`packages/org.eclipse.epp.package.embedcpp/plugin_customization.ini`
520-
521-
### package.embedcpp.feature
522-
523-
If necessary, update the text displayed in the Downloads page, it is in
524-
`packages/org.eclipse.epp.package.embedcpp.feature/epp.website.xml` file, the
525-
`<description>` element.
526-
527-
Update the version in **NewAndNoteworthy**, in the same file.
528-
529-
### Compare to package.cpp
530-
531-
Compare the three packages with the similar ones from CPP:
532-
533-
```sh
534-
cd org.eclipse.epp.packages.git
535-
536-
diff packages/org.eclipse.epp.package.cpp packages/org.eclipse.epp.package.embedcpp
537-
diff packages/org.eclipse.epp.package.cpp.feature packages/org.eclipse.epp.package.embedcpp.feature
538-
diff packages/org.eclipse.epp.package.cpp.product packages/org.eclipse.epp.package.embedcpp.product
539-
```
540-
541-
### Commit & push
542-
543-
Commit and push to Gerrit:
544-
545-
```bash
546-
git commit -m 'embedcpp: ...'
547-
git push ssh://[email protected]:29418/epp/org.eclipse.epp.packages.git HEAD:refs/for/master
548-
```
549-
550-
In Gerrit, click **CODE_REVIEW+2** and then **SUBMIT** to merge the changes.
551-
552-
The commit will trigger the [EPP](https://ci.eclipse.org/packaging/)
553-
Jenkins job:
554-
555-
- <https://ci.eclipse.org/packaging/job/simrel.epp-tycho-build/>
556-
557-
In 1.5 hours the new test versions of the integrated epp builds are
558-
available from:
559-
560-
- <https://ci.eclipse.org/packaging/job/simrel.epp-tycho-build/lastSuccessfulBuild/artifact/org.eclipse.epp.packages/archive/>
561-
562467
## Announce release
563468

564469
Announce the release to the **[email protected]** list;
@@ -567,7 +472,7 @@ pass a link to the release page (<https://eclipse-embed-cdt.github.io/news/>).
567472

568473
## Share on Twitter
569474

570-
- in a separate browser windows, open [TweetDeck](https://tweetdeck.twitter.com/)
475+
- in a separate browser windows, open [X/Twitter](https://twitter.com/)
571476
- using the `@EmbedCDT` account, enter a message like
572477
**Eclipse Embedded CDT plug-ins v6.6.0 released** and on the next line
573478
paste the link to the release

0 commit comments

Comments
 (0)