Skip to content

Commit f6e9e79

Browse files
committed
Updates to readme and contributor reference
- for #179 - add a reminder to update the Eclipse Marketplace entry - fix outdated links Signed-off-by: Krum Tsvetkov <krum.tsvetkov@sap.com>
1 parent dc31d3a commit f6e9e79

2 files changed

Lines changed: 26 additions & 24 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Eclipse Memory Analyzer
33

44
The Eclipse Memory Analyzer is a fast and feature-rich Java heap dump analyzer that helps you find memory leaks and reduce memory consumption.
55

6-
- Web site: <http://eclipse.dev/mat/>
6+
- Web site: <https://eclipse.dev/mat/>
77

88
Download
99
----------------
@@ -24,9 +24,9 @@ For detailed build documentation refer to [Building MAT with Maven](dev-doc/Buil
2424
Documentation
2525
----------------
2626

27-
- [Documentation](http://help.eclipse.org/index.jsp?topic=/org.eclipse.mat.ui.help/welcome.html) - online version of the documentation available also from within the tool
28-
- [Learning](https://wiki.eclipse.org/MemoryAnalyzer/Learning_Material) - learn from presentations, blogs, tutorials
29-
- [FAQ](http://wiki.eclipse.org/index.php/MemoryAnalyzer/FAQ) - check some of the frequently asked questions
27+
- [Documentation](https://help.eclipse.org/index.jsp?topic=/org.eclipse.mat.ui.help/welcome.html) - online version of the documentation available also from within the tool
28+
- [Learning](https://github.com/eclipse-mat/mat/wiki/learning_material) - learn from presentations, blogs, tutorials
29+
- [FAQ](https://github.com/eclipse-mat/mat/wiki/faq) - check some of the frequently asked questions
3030

3131
Contributing
3232
----------------
@@ -48,4 +48,4 @@ Contact:
4848
----------------
4949

5050
- Developers [mailing list](https://dev.eclipse.org/mailman/listinfo/mat-dev)
51-
- Memory Analyzer [Forum](http://www.eclipse.org/forums/eclipse.memory-analyzer) at Eclipse
51+

dev-doc/Contributor_Reference.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -206,24 +206,27 @@ It is possible to [run Memory Analyzer under WSL](MAT_under_WSL.md), which might
206206

207207
See [CONTRIBUTING.md](../CONTRIBUTING.md)
208208

209-
## New version development process
209+
## New Version Development Process
210210

211211
* Document new version at [MAT project page](https://projects.eclipse.org/projects/tools.mat)
212212
* Update references to old release in the code e.g. 1.X -&gt; 1.Y excluding update sites
213-
** See pom.xml e.g. `<version>1.9.1-SNAPSHOT</version>`
214-
** See manifest.mf e.g. `Bundle-Version: 1.9.1.qualifier`
215-
** See feature.xml, excluding updateSiteName
216-
** See org.eclipse.mat.ui.rcp about.mappings
217-
** org.eclipse.mat.product mat.product
218-
** org.eclipse.mat.ui.rcp.feature rootfiles/.eclipseproduct (hidden file, may need to use navigator view)
219-
213+
* The Tycho version plugin is helpful to change across pom.xml and MANIFEST.MF files, but leaves some places within MAT src unchanged:
214+
215+
```mvn org.eclipse.tycho:tycho-versions-plugin:<TYCHO-VERSION-FROM-THE-PARENT-POM>:set-version -DnewVersion=1.17.0-SNAPSHOT```
216+
* As the versions plugin would miss some places, search for the version across the files and replace if neccessary. These are the places where the changes should be at the end:
217+
* See pom.xml e.g. `<version>1.17.0-SNAPSHOT</version>`
218+
* See manifest.mf e.g. `Bundle-Version: 1.17.0.qualifier`
219+
* See feature.xml, excluding updateSiteName
220+
* See org.eclipse.mat.ui.rcp about.mappings
221+
* org.eclipse.mat.product mat.product
222+
* org.eclipse.mat.ui.rcp.feature rootfiles/.eclipseproduct (hidden file, may need to use navigator view)
220223
* Develop features and fix bugs
221224
* If a plugin depends on new function in another plugin, update the dependency version in manifest.mf
222225
* If creating a new plugin, add it to the JavaDoc build process in extrabuild.xml, use package-info.java to mark packages as not API or API as appropriate. Consider carefully adding new APIs.
223226
* If the Java version changes then the minor version must increase, also change:
224227
* .classpath
225228
* .settings/org.eclipse.jdt.core.prefs
226-
* manifest.mf &lt;code&gt;Bundle-RequiredExecutionEnvironment: J2SE-1.5&lt;/code&gt;
229+
* manifest.mf &lt;code&gt;Bundle-RequiredExecutionEnvironment: JavaSE-21&lt;/code&gt;
227230
* Update org.eclipse.ui.help extrabuild.xml for the new JavaDoc compile level, and for the link to the Java class library documentation
228231
* Consider keeping org.eclipse.mat.ibmdumps at a lower level as it uses classes for the exec dump provider and the attach jar which may be executed on lower level JVMs.
229232
* Update copyright date in source code if updated in a new year
@@ -243,35 +246,34 @@ See [CONTRIBUTING.md](../CONTRIBUTING.md)
243246
* See feature.xml, including updateSiteName
244247
* Also write a New and Noteworthy document replacing the previous release, and add a link to the old document on the MAT website. This should be done in org.eclipse.mat.help in noteworthy.dita, and take the generated noteworthy.html, modify it if needed and add to the website.
245248
* Follow [Simultaneous release policies](#Simultaneous release policies)
246-
* After release create Bugzilla entry for the new version [Bugzilla Manager](https://dev.eclipse.org/committers/bugs/bugz_manager.php)
247-
* [Add a new Babel definition](https://wiki.eclipse.org/Babel/FAQ#How_do_I_add_my_project_to_Babel.3F) so the messages files could be translated.
249+
* After release
250+
* create Bugzilla entry for the new version [Bugzilla Manager](https://dev.eclipse.org/committers/bugs/bugz_manager.php)
251+
* update the [Eclipse Marketplace entry for MAT](https://marketplace.eclipse.org/content/memory-analyzer)
252+
* [Add a new Babel definition](https://wiki.eclipse.org/Babel/FAQ#How_do_I_add_my_project_to_Babel.3F) so the messages files could be translated.
248253

249254

250-
## Simultaneous release policies
255+
## Simultaneous Release Policies
251256

252257
* Create a release record in [Eclipse Memory Analyzer project page](https://projects.eclipse.org/projects/tools.mat)
253258
* For reference, read [contribute to the Simultaneous Release Build](https://github.com/orgs/eclipse-simrel/discussions/3)
254-
* [Build](https://ci.eclipse.org/mat/job/prepare_simrel_contribution/) to copy update site build to SimRel location.
259+
* Use the [prepare_simlel_contribution Build](https://ci.eclipse.org/mat/job/prepare_simrel_contribution/) to copy a snapshot update site build to a dedicated location for the SimRel.
255260
* Follow the SimRel process to update mat.aggrcon in the SimRel build.
256261
* Preserve the [tycho-build-nightly](https://ci.eclipse.org/mat/job/tycho-mat-nightly/) as 'Keep forever' and label it with the release build e.g. 'Photon RC2'
257-
* The [MAT configuration file](http://git.eclipse.org/c/simrel/org.eclipse.simrel.build.git/tree/mat.aggrcon) which is [updated using Git in GitHub.com/eclipse-simrel](https://github.com/orgs/eclipse-simrel/discussions/3) to match the SimRel location.
262+
* The [MAT configuration file](https://github.com/eclipse-simrel/simrel.build/blob/main/mat.aggrcon) which is [updated using Git in GitHub.com/eclipse-simrel](https://github.com/orgs/eclipse-simrel/discussions/3) to match the SimRel location.
258263
* Tag in Git with 'R_1.X.Y' the source used to generate the final build for a release. See [MAT Git Refs](https://git.eclipse.org/c/mat/org.eclipse.mat.git/refs/)
259264
* Complete the Eclipse release process, including getting a review if needed at [Eclipse Memory Analyzer project page](https://projects.eclipse.org/projects/tools.mat)
260265
* To release, also run the [Stand-alone packaging build](https://ci.eclipse.org/mat/job/mat-standalone-packages/), notarize the Mac x86_64 and aarch64 .dmg files and copy the results to the download site using [promote release](https://ci.eclipse.org/mat/job/mat-promote-release/).
261-
* Add the version name '1.XX' to [Bugzilla manager](https://dev.eclipse.org/committers/bugs/bugz_manager.php) so users can report bugs against the new version
262-
* Also release on [Eclipse Marketplace](https://marketplace.eclipse.org/content/memory-analyzer-0)
266+
* Update the [Eclipse Marketplace](https://marketplace.eclipse.org/content/memory-analyzer)
263267
* Also consider archiving some old releases
264268

265269

266270
MAT Policies - to satisfy [Simultaneous Release Requirements](https://github.com/eclipse-simrel/.github/blob/main/wiki/SimRel/Simultaneous_Release_Requirements.md)
267-
* [Ramp Down Plan](https://wiki.eclipse.org/MemoryAnalyzer/Ramp_Down_Plan)
268-
* [Retention Policy](https://wiki.eclipse.org/MemoryAnalyzer/Retention_policy)
269271
* [API Policy](./API_policy.md)
270272
* [Capabilities](./MAT_capabilities.md)
271273

272274
## Download Statistics
273275

274276
Eclipse committers once logged in at accounts.eclipse.org can see download statistics at
275-
[Download Stats](https://dev.eclipse.org/committers/committertools/stats.php|Eclipse).
277+
[Download Stats](https://dev.eclipse.org/committers/committertools/stats.php).
276278
These are from downloads via the Find a Mirror script for stand-alone MAT and from p2 downloads from an update site.
277279
Search for '/mat/' for mirror downloads and 'org.eclipse.mat.api' for p2 downloads.

0 commit comments

Comments
 (0)