Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for Eclipse-BundleShape in Manifest-Editor #949

Merged
merged 1 commit into from Feb 11, 2024

Conversation

alshamams
Copy link
Contributor

Three modes are supported: jar, dir and default.
First two are self-explanatory, third option removes the header which is the default behaviour.
Fixes: #864

Copy link

github-actions bot commented Nov 29, 2023

Test Results

   291 files  ±0     291 suites  ±0   53m 56s ⏱️ + 1m 5s
 3 526 tests ±0   3 468 ✅ ±0   58 💤 ±0  0 ❌ ±0 
10 875 runs  ±0  10 698 ✅ ±0  177 💤 ±0  0 ❌ ±0 

Results for commit fe94e3d. ± Comparison against base commit 530e7a7.

♻️ This comment has been updated with latest results.

@laeubi
Copy link
Contributor

laeubi commented Nov 29, 2023

@alshamams can you share a screenshot how it looks like?

@alshamams
Copy link
Contributor Author

Hi @laeubi ,
This is an image of the overview tab where the options jar, dir and default are available.
image

This is an image of the updated Manifest, if for example jar is chosen.
image

@laeubi
Copy link
Contributor

laeubi commented Nov 30, 2023

@alshamams thanks for sharing the screen, the radio buttons look a bit stretched, can you make it that there is no large space between them?

@alshamams
Copy link
Contributor Author

image

I have adjusted the spacing between the radio buttons. Kindly review and let me know. @laeubi

@alshamams
Copy link
Contributor Author

Thanks a lot @laeubi . Do you think this qualifies as a noteworthy feature?

@laeubi
Copy link
Contributor

laeubi commented Dec 1, 2023

Thanks a lot @laeubi . Do you think this qualifies as a noteworthy feature?

I think anything new can be added to N&N if you like.

@merks
Copy link
Contributor

merks commented Dec 1, 2023

Just a general comment. It generally looks nice to have a significant number of N&N entries for each release. It makes it look like we're doing lots of good things for the community...

@laeubi
Copy link
Contributor

laeubi commented Dec 1, 2023

It makes it look like we're doing lots of good things for the community...

It makes it look like visible that we're doing lots of good things for the community...

Copy link
Member

@HannesWell HannesWell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @alshamams for working on this.
I just have a coarse look, but in general it looks good.
Will make a more detailed review tomorrow.

@alshamams
Copy link
Contributor Author

Hi @HannesWell ,
I have made the suggested changes. Do let me know if any other edits are required.

@HannesWell
Copy link
Member

Hi @HannesWell , I have made the suggested changes. Do let me know if any other edits are required.

Thank you. Sorry I didn't find the time at the weekend. But will do a (hopefully final) review this evening.

image

From a quick look at this image, I would say that default should be the first option, then jar and then directory.

Copy link
Member

@HannesWell HannesWell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have reviewed this in detail and added some remarks below and pushed another commit on top yours that applies the remarks and also does a few more minor simplifications.

What do you think about them?

@alshamams
Copy link
Contributor Author

Thanks @HannesWell for your meticulous review. All the proposed changes look good to me.
Let me know if I could squash the commits. (Not sure if squashing will cause your attribution to be lost?)

Copy link
Member

@HannesWell HannesWell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @HannesWell for your meticulous review. All the proposed changes look good to me. Let me know if I could squash the commits. (Not sure if squashing will cause your attribution to be lost?)

Your welcome and I'm glad you like the suggestions. Yes please squash the commits.
You can attribute me by mentioning me in a footer in the sense of
Co-authored-by: Some Bodyelse <somebodyelse@nowhere.com>
using my Name+Mail from the commit (see https://www.eclipse.org/projects/handbook/#resources-commit for details).

I just rebased and slightly updated the PR to further unify the button creation.
The points that are currently open:

  • Externalization of radio button labels (default, jar and directory should be externalized just like the main message, we should not reuse the constants for the labels although they have the same value by default, but in other languages other labels might be appropriate).
  • We could add a more elaborative tool-tip to each choice or do you all think the current suggestion is clear enough?

@@ -74,6 +74,7 @@ protected void createSpecificControls(Composite parent, FormToolkit toolkit, IAc
if (isBundle() && (formEditor instanceof ManifestEditor)) {
createLazyStart(parent, toolkit, actionBars);
createSingleton(parent, toolkit, actionBars, PDEUIMessages.PluginGeneralInfoSection_singleton);
createBundleShape(parent, toolkit, PDEUIMessages.PluginGeneralInfoSection_bundleshape);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By calling createBundleShape() here the Bundle-Shape buttons are only available for non-fragment bundles, but fragments can also have an explicit Bundle-Shape.
So this should called for all kind of Plug-in projects in a way that it is still at the right position.
So probably in GeneralInfoSection.createClient() after createSpecificControls() has been called.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @HannesWell ,
I have addressed all the review comments. Please have a look and let me know. (I am unable to select the checkboxes in the above comment.)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you. I'm a bit short in time today, but will have a look at this ASAP.
But I think we can submit this soon. :)

Three modes are supported: jar, dir and default.
First two are self-explanatory, third option removes the header
which is the default behavior.

Fixes: eclipse-pde#864

Co-authored-by: Hannes Wellmann <wellmann.hannes1@gmx.net>
Copy link
Member

@HannesWell HannesWell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the delay.
I adjusted the tool-tips to describe the consequences of each possible option, similiar to how it is described in the doc:
https://help.eclipse.org/latest/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Freference%2Fmisc%2Fbundle_manifest.html

With that this is ready for submission.
Thanks @alshamams for this contribution again.

@@ -1510,6 +1510,7 @@ PluginWorkingSet_deselectAll_label=Dese&lect All
PluginDevelopmentPage_presentation=Plug-in Manifest Editor Presentation
PluginGeneralInfoSection_lazyStart=Activate this plug-in when one of its classes is loaded
PluginGeneralInfoSection_singleton=This plug-in is a singleton
PluginGeneralInfoSection_bundleshape=Shape after P2 installation:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general we could re-think if this should be made more neutral, but this can be done in a follow-up.

Suggested change
PluginGeneralInfoSection_bundleshape=Shape after P2 installation:
PluginGeneralInfoSection_bundleshape=Shape after installation:

@HannesWell HannesWell merged commit 43ec146 into eclipse-pde:master Feb 11, 2024
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add support for Eclipse-BundleShape in Manifest-Editor
5 participants