Skip to content

Commit

Permalink
READMEs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ilg-ul committed Apr 3, 2024
1 parent 9f0717a commit 34ae4eb
Show file tree
Hide file tree
Showing 2 changed files with 92 additions and 114 deletions.
73 changes: 73 additions & 0 deletions README-EPP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@

## Prerequisites

### Clone EPP

At first use, clone the EPP Git repo:

```bash
git clone ssh://[email protected]:29418/epp/org.eclipse.epp.packages.git org.eclipse.epp.packages.git
mkdir -p org.eclipse.epp.packages.git/.git/hooks/
scp -p -P 29418 [email protected]:hooks/commit-msg org.eclipse.epp.packages.git/.git/hooks/
```

### EPP deadline

The deadline for EPP changes is **Thu 9am Ottawa time**.

## Check & update EPP

If the list of features changed, it is necessary to
update the EPP project.

Pull new commits.

- edit `packages/org.eclipse.epp.package.embedcpp.product/epp.product`
- update the list of features

### package.embedcpp

To change the default preferences, edit the
`packages/org.eclipse.epp.package.embedcpp/plugin_customization.ini`

### package.embedcpp.feature

If necessary, update the text displayed in the Downloads page, it is in
`packages/org.eclipse.epp.package.embedcpp.feature/epp.website.xml` file, the
`<description>` element.

Update the version in **NewAndNoteworthy**, in the same file.

### Compare to package.cpp

Compare the three packages with the similar ones from CPP:

```sh
cd org.eclipse.epp.packages.git

diff packages/org.eclipse.epp.package.cpp packages/org.eclipse.epp.package.embedcpp
diff packages/org.eclipse.epp.package.cpp.feature packages/org.eclipse.epp.package.embedcpp.feature
diff packages/org.eclipse.epp.package.cpp.product packages/org.eclipse.epp.package.embedcpp.product
```

### Commit & push

Commit and push to Gerrit:

```bash
git commit -m 'embedcpp: ...'
git push ssh://[email protected]:29418/epp/org.eclipse.epp.packages.git HEAD:refs/for/master
```

In Gerrit, click **CODE_REVIEW+2** and then **SUBMIT** to merge the changes.

The commit will trigger the [EPP](https://ci.eclipse.org/packaging/)
Jenkins job:

- <https://ci.eclipse.org/packaging/job/simrel.epp-tycho-build/>

In 1.5 hours the new test versions of the integrated epp builds are
available from:

- <https://ci.eclipse.org/packaging/job/simrel.epp-tycho-build/lastSuccessfulBuild/artifact/org.eclipse.epp.packages/archive/>

133 changes: 19 additions & 114 deletions README-MAINTAINER.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,20 +69,6 @@ to

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

### Clone EPP (deprecated)

At first use, clone the EPP Git repo:

```bash
git clone ssh://[email protected]:29418/epp/org.eclipse.epp.packages.git org.eclipse.epp.packages.git
mkdir -p org.eclipse.epp.packages.git/.git/hooks/
scp -p -P 29418 [email protected]:hooks/commit-msg org.eclipse.epp.packages.git/.git/hooks/
```

### EPP deadline (deprecated)

The deadline for EPP changes is **Thu 9am Ottawa time**.

### Create a new milestone

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

<ul>
<li>https://download.eclipse.org/embed-cdt/updates/v6-test/</li>
<li>https://download.eclipse.org/embed-cdt/updates/v6-test/</li>
</ul>
```

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

Click the bottom **Save** button.
Click the bottom **Save** button. Leave the page.

### Test

Install the plug-ins on several platforms.

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

If everything is fine, update SimRel.

With a Git client:
Full instructions are here: <https://github.com/orgs/eclipse-simrel/discussions/3>

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

Go to the release candidate folder
If everything is fine, sync the SimRel fork:

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

In Eclipse:
With a Git client:

- import existing project `org.eclipse.simrel.build`
- open `simrel.aggr`
- expand the 'Contribution: Embedded CDT'
- select **Mapped Repository**
- right click: **Show Properties View**
- in the right side, edit the **Location** field to the new release
candidate p2 URL (like
`https://download.eclipse.org/embed-cdt/release-candidates/6.6.0-202403210905/p2/`
and press Enter
- select all the features in the contribution, right-click and choose
**Fix Versions**
- select the Contribution and **Validate**
- select the Aggregation and **Validate**
- Save
- stage `simrel.aggr` & `embedcdt.aggrcon`
- open `simrel.build-fork.git`
- pull new commits
- edit `embedcdt.aggrcon`
- replace location to <https://download.eclipse.org/embed-cdt/release-candidates/6.6.0-202403210905/p2/>
- replace full version to `6.6.0.202403210905`
- replace short version to `6.6.0`
- commit with a message like:
- _embedcdt: update for 6.6.0-202403210905_,
- _Signed-off-by: Liviu Ionescu <[email protected]>_
- click the **Commit** button (do not Push yet)
- right click, Show in local Terminal

```bash
git push ssh://[email protected]:29418/simrel/org.eclipse.simrel.build HEAD:refs/for/master
```

This will trigger a Gerrit run.

Check the console output, for the Gerrit link. If missed, it'll be
later sent by e-mail, when the run completes.

In Gerrit web page, if the check is successful and Verified+1 is shown,
click **CODE_REVIEW+2** and then **SUBMIT** to merge the changes.
- _embedcdt: update for 6.6.0-202403210905 release candidate_,
- push
- create pull request

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

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

## Check & update EPP

If the list of features changed, it is necessary to
update the EPP project.

Pull new commits.

- edit `packages/org.eclipse.epp.package.embedcpp.product/epp.product`
- update the list of features

### package.embedcpp

To change the default preferences, edit the
`packages/org.eclipse.epp.package.embedcpp/plugin_customization.ini`

### package.embedcpp.feature

If necessary, update the text displayed in the Downloads page, it is in
`packages/org.eclipse.epp.package.embedcpp.feature/epp.website.xml` file, the
`<description>` element.

Update the version in **NewAndNoteworthy**, in the same file.

### Compare to package.cpp

Compare the three packages with the similar ones from CPP:

```sh
cd org.eclipse.epp.packages.git

diff packages/org.eclipse.epp.package.cpp packages/org.eclipse.epp.package.embedcpp
diff packages/org.eclipse.epp.package.cpp.feature packages/org.eclipse.epp.package.embedcpp.feature
diff packages/org.eclipse.epp.package.cpp.product packages/org.eclipse.epp.package.embedcpp.product
```

### Commit & push

Commit and push to Gerrit:

```bash
git commit -m 'embedcpp: ...'
git push ssh://[email protected]:29418/epp/org.eclipse.epp.packages.git HEAD:refs/for/master
```

In Gerrit, click **CODE_REVIEW+2** and then **SUBMIT** to merge the changes.

The commit will trigger the [EPP](https://ci.eclipse.org/packaging/)
Jenkins job:

- <https://ci.eclipse.org/packaging/job/simrel.epp-tycho-build/>

In 1.5 hours the new test versions of the integrated epp builds are
available from:

- <https://ci.eclipse.org/packaging/job/simrel.epp-tycho-build/lastSuccessfulBuild/artifact/org.eclipse.epp.packages/archive/>

## Announce release

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

## Share on Twitter

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

0 comments on commit 34ae4eb

Please sign in to comment.