8000 KEYCLOAK-4950 by ASzc · Pull Request #4185 · keycloak/keycloak · GitHub
[go: up one dir, main page]

Skip to content

KEYCLOAK-4950 - #4185

Merged
stianst merged 4 commits into
keycloak:2.5.xfrom
ASzc:KEYCLOAK-4950
Jul 14, 2017
Merged

stianst merged 4 commits into
keycloak:2.5.xfrom
ASzc:KEYCLOAK-4950

Conversation

@ASzc
@ASzc ASzc commented May 23, 2017 •
Copy link
Copy Markdown
Contributor

Include license data from RH-SSO 7.1.0 release. Other branches can be updated later using the tools and configuration introduced here.

licenses.xml was manually collected with the assistance of some external scripts. The download-license-files.sh script is included for updating the local license copies when licenses.xml is changed.


PREVIOUSLY:
Generate licenses.xml and licenses.html using the same system as Wildfly/EAP, and include in the server-feature-pack under path content/docs/licenses-keycloak/

@ASzc
ASzc force-pushed the KEYCLOAK-4950 branch from 1bb30c9 to 467b25f Compare May 23, 2017 23:08
@stianst stianst self-assigned this May 24, 2017
@johnament
Copy link
Copy Markdown
Contributor

Does this also generate the licenses for the npm based UI code?

@ASzc
ASzc commented May 24, 2017
Copy link
Copy Markdown
Contributor Author

@johnament license-maven-plugin only uses information from the maven model, so any non-maven components of Keycloak will not be included. This is certainly just a first step.

@ASzc
ASzc changed the base branch from master to 3.1.x-rhsso June 14, 2017 19:33
@ASzc
ASzc commented Jun 14, 2017
Copy link
Copy Markdown
Contributor Author

I've changed the system to a manual data gathering process, for both Java and non-Java. The html is still generated at build-time.

I need to fix the xsl to include non-Java data, and to use the correct local license file path.

@ASzc
ASzc force-pushed the KEYCLOAK-4950 branch 2 times, most recently from c9fe4b6 to b02538d Compare June 15, 2017 15:24
@ASzc
ASzc commented Jun 15, 2017
Copy link
Copy Markdown
Contributor Author

I have updated the xsl to display the non-Java data in the html.

@ASzc
ASzc force-pushed the KEYCLOAK-4950 branch 2 times, most recently from c1daecf to 2e74e70 Compare June 16, 2017 13:19
@stianst
stianst commented Jun 27, 2017
Copy link
Copy Markdown
Contributor

Is this ready to go now?

8000

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 would imagine you pick the more liberal license here (Apache 2) over the more restrictive (GPLv2). This seems to indicate opposite.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The symbolic link here doesn't reflect any decision on which license Keycloak chooses to use for Select2. That project doesn't offer discrete license texts in its source code, so both license files have identical text, so they get symlinked for deduplication purposes.

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.

Looks like select2 is actually MIT from their website at least? https://select2.github.io/

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

That's true for the modern versions, but the version in use in 7.1.0 is licensed as ASL v2 or GPL v2. https://github.com/select2/select2/blob/3.4.1/LICENSE

@johnament johnament Jun 27, 2017 •
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.

It may be MIT in newer versions, but if the version used in here is this dual license thats fine. I think the confusing part is that this almost looks like a reflective link (A ->B, B -> A) so someone parsing the licenses may not be clear on the declaration.

I think tracking the upgrade separately makes sense as well, as this is a licensing headache from my POV (as one of the guys who have to consume these).

< 8000 p class="ml-1 mb-2 mt-2" data-show-on-error hidden> Sorry, something went wrong.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The way I would recommend reading the license data is to start with the xml or the html. Then, if additional information is desired for a particular component's license, either use the remote URL or access the local file. The regular filenames make it easy to programmatically find local files when processing the xml data. The symlinks avoid the bloat this regular naming scheme would otherwise cause.

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.

You should exclude the HTML markup from the TXT file.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

That would be a bug to file against Keycloak separately. I don't know why the license file is HTML. Beyond line-ending normalization, I don't think automatically changing any of the license texts is wise. Doing so could potentially change the meaning of the license.

@ASzc
ASzc changed the base branch from 3.1.x-rhsso to 2.5.x June 27, 2017 17:30
@ASzc
ASzc commented Jun 27, 2017
Copy link
Copy Markdown
Contributor Author

Re-targeted for the actual 7.1.x branch

@stianst stianst added the 2.5.x label Jul 10, 2017
ASzc added 2 commits July 11, 2017 16:38
licenses.xml was manually collected with the assistance of some external scripts. The download-license-files.sh script is included for updating the local license copies when licenses.xml is changed.

maven-resources-plugin must not be used for the individual license files, as it doesn't preserve symlinks. They are included directly by maven-assembly-plugin, which does preserve symlinks.

Properties like ${product.slot} and ${product.name.full} are not available in this branch, but should be used instead of the hardcoded values in pom.xml and assembly.xml when porting to master.
@stianst
stianst merged commit 536dc49 into keycloak:2.5.x Jul 14, 2017
@ASzc
ASzc commented Jul 20, 2017
Copy link
Copy Markdown
Contributor Author

Got the wrong directory for the adapters, new PR here.

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.

3 participants

0