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

Properly define + document JKubeProjectAssembly behavior #94

Closed
manusa opened this issue Mar 5, 2020 · 1 comment · Fixed by #278
Closed

Properly define + document JKubeProjectAssembly behavior #94

manusa opened this issue Mar 5, 2020 · 1 comment · Fixed by #278

Comments

@manusa
Copy link
Member

manusa commented Mar 5, 2020

Description

As of now, JKubeProjectAssembly behavior is not aligned with Maven's Assemby Plugin behavior.

Behavior for filesets includes, excludes, filtered, etc. is opinionated and doesn't perform as described in https://maven.apache.org/plugins/maven-assembly-plugin/assembly.html#class_fileSet.
There are some fields missing too.

Same goes for file, repository, etc.

We should either properly document our API behavior or completely implement the behavior mimicking the one provided by Apache Maven Plugin.

Relates to:

@manusa manusa added this to the 1.0.0 milestone Apr 1, 2020
@manusa manusa added this to "Backlog" in Sprint #184 May 11, 2020
@manusa manusa moved this from "Backlog" to Planned in Sprint #184 May 13, 2020
@manusa manusa added this to "Backlog" in Sprint #185 Jun 1, 2020
@manusa manusa moved this from "Backlog" to Planned in Sprint #185 Jun 3, 2020
@manusa manusa added this to Backlog in Sprint #186 Jun 25, 2020
@manusa manusa moved this from Backlog to Planned in Sprint #186 Jun 25, 2020
@manusa manusa self-assigned this Jun 30, 2020
@manusa manusa moved this from Planned to In progress in Sprint #186 Jun 30, 2020
@manusa
Copy link
Member Author

manusa commented Jun 30, 2020

Actions to take:

fileSet - AssemblyFileSet

  • Discarded properties:
    • useDefaultExcludes
    • lineEnding
    • filtered
    • nonFilteredFileExtensions
  • Supported properties
    • outputDirectory
    • includes: To support java.nio.file.FileSystem#getPathMatcher glob syntax
    • excludes: To support java.nio.file.FileSystem#getPathMatcher glob syntax
    • fileMode
    • directoryMode
    • directory

file - AssemblyFile

  • Discarded properties:
    • sources
    • filtered
    • lineEnding
  • Supported properties
    • source
    • outputDirectory
    • destName

Possible consequences

After Maven decoupling some of the features provided by XML maven assemblies were lost and broken. Dropping this configuration fields will have no immediate consequence for JKube. However, projects migrating from FMP to JKube that made use of any of the predefined assemblies, or provided custom assemblies will be affected and will probably stop working unless their configurations are updated to be compatible with the new "Mavenless" approach.

@manusa manusa linked a pull request Jul 6, 2020 that will close this issue
12 tasks
@manusa manusa moved this from In progress to Review in Sprint #186 Jul 7, 2020
Sprint #186 automation moved this from Review to Done Jul 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Sprint #184
  
Planned
Sprint #185
  
Planned
Sprint #186
  
Done
Development

Successfully merging a pull request may close this issue.

1 participant