Skip to content

[MJARSIGNER-63] Exposing certchain on site sign-goal documentation#14

Merged
slachiewicz merged 1 commit into
apache:masterfrom
schedin:MJARSIGNER-63_doc_certchain
Dec 16, 2023
Merged

[MJARSIGNER-63] Exposing certchain on site sign-goal documentation#14
slachiewicz merged 1 commit into
apache:masterfrom
schedin:MJARSIGNER-63_doc_certchain

Conversation

@schedin

@schedin schedin commented Dec 6, 2023

Copy link
Copy Markdown
Contributor

Making certchain not read-only so that the Maven site documentation will make is visible on https://maven.apache.org/plugins/maven-jarsigner-plugin/sign-mojo.html

elharo
elharo previously requested changes Dec 7, 2023

@elharo elharo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm not sure about this. If it should be read only, it should be read only. The docs are an after thought. Maybe the report or site plugin needs to be fixed to handle this?

@schedin

schedin commented Dec 7, 2023

Copy link
Copy Markdown
Contributor Author

I looked at https://maven.apache.org/plugin-tools/apidocs/org/apache/maven/plugins/annotations/Parameter.html#readonly() and my interpretation of this annotation parameter is that it exist for a use case it don't fully understand (usage of common POM elements).

My guess is that this readonly parameter is not related to Java attribute immutability. I'm also (mostly guessing) that the original author (@olamy ?) copy-pasted from the "wrong" thing. Perhaps from MavenProject/Settings/MavenSession? My assumption is that the intention is that the end-user should be able to configure this parameter in a <configuration> block. While reading the javadoc for readonly it looks like this should be false (or not defined, so it is false per default) for the indented use case of specifiying certchain.

@schedin schedin force-pushed the MJARSIGNER-63_doc_certchain branch from add3bc5 to 467bf50 Compare December 8, 2023 08:30
@schedin

schedin commented Dec 8, 2023

Copy link
Copy Markdown
Contributor Author

I have rebased this pull request on master.

@schedin schedin changed the title [MJARSIGNER-63] exposing certchain on site sign-goal documentation [MJARSIGNER-63] Exposing certchain on site sign-goal documentation Dec 8, 2023
@elharo

elharo commented Dec 8, 2023

Copy link
Copy Markdown
Contributor

@elharo

elharo commented Dec 8, 2023

Copy link
Copy Markdown
Contributor

It's possible that this should not have readonly=true. I don't have a real opinion on that. But let's make sure we're making conscious choice here and the PR title reflects what we're trying to do.

@schedin

schedin commented Dec 8, 2023

Copy link
Copy Markdown
Contributor Author

Even though readonly is not about documentation (primary), I feel that in this context (for this specific case and JIRA tickets) it is about documentation. In my comment in https://issues.apache.org/jira/projects/MJARSIGNER/issues/MJARSIGNER-63 I have provided a (rather long) example that shows that it is possible to set this parameter, even if it is readonly (or undocumented).

My opinion is that we (the community) should make a conscious choice to make sure that this parameter is configurable by the end-user (and also documented). I think this was the original intent of https://issues.apache.org/jira/projects/MJARSIGNER/issues/MJARSIGNER-53

@slachiewicz slachiewicz merged commit 54a204e into apache:master Dec 16, 2023
@jira-importer

Copy link
Copy Markdown

Resolve #108

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.

4 participants