Preliminary work for spin-off of Upplication/Amazon-S3-FileSystem-NIO2

[carlspring]

Task Description

This is the master task for creating a spin-off of Upplication/Amazon-S3-FileSystem-NIO2.

Tasks

• Change the licenses #2
• Re-indent the code #3
• Change the project's artifact coordinates #4
• Rename the packages to org.carlspring.cloud.storage.s3fs #5
• Set the maven-enforcer-plugin to require Maven 3.6.3 #6
• Update all Maven dependencies to their latest versions #7
• Update all Maven plugins to their latest versions #8
• Replace log4j with slf4j #9
• Remove all the unnecessary throws in method definitions #10
• Upgrade to the latest aws-java-sdk-s3 #11
• Migrate to JUnit 5.x #12
• Set up issue templates #14
• Set up pull requests templates #15
• Set up project labels #16
• Set up Github Actions #17
• Set up GitGuardian #18
• Set up Sonarcloud analysis #19
• Set up Snyk.io #20
• Set up badges #21
• Set up a project documentation site using mkdocs and publish it to github.io #22
  • Re-work the README.md #13
  • Add a code of conduct.
  • Add a CONTRIBUTING.md.
• Set up a tag for s3fs-nio on Stackoverflow ( )
• Inform people who might be interested about the project
  • Reach out to all of the contributors who:
    • Raised issues on Upplication/Amazon-S3-FileSystem-NIO2 (which are still open).
    • Raised pull requests on Upplication/Amazon-S3-FileSystem-NIO2 (which are still unmerged).
    • Created forks of Upplication/Amazon-S3-FileSystem-NIO2 in order to fix bits and pieces that were never acepted into the upstream(s).
      • elerch/Amazon-S3-FileSystem-NIO2
      • nextflow-io/nextflow-s3fs
      • S3 with Jzarr glencoesoftware/bioformats2raw#89
      • lasersonlab
  • Reach out to the folks at aws-sdk-java-v2 via S3: provide java.nio.FileSystem implementation aws/aws-sdk-java-v2#1388.
  • Create back-links from Stackoverflow

[oeph]

Is there any ETA for this? I'm highly interested in this library

[carlspring]

@oeph ,

Thank you for your interest!

We were hoping to have a version released by the end of the month (January/2021), but this has turned out to be a very busy January for me. It's mainly @ptirador and myself working on this project at the moment and we would be more than happy to get an extra set of helping hands, if you're up for it! :)

There are still a few important things that we would like to do before we cut a release. I've been busy re-working some code which will make things a lot easier to work with. We also have several follow-up tasks related to the migration from Amazon SDK v1 to v2 that are still outstanding and which we would like to have as part of 1.0.0.

Apart from this, we need to improve the site-based documentation. I have prepared a Spring-based "Hello, World!" (and we will need a few more example projects) but I would rather not push any of this before having finished the above-mentioned refactoring.

And, in addition to this, it appears that this Github repository will have to be moved into a Github Organization of its own so that we could have teams and other extras.

I estimate all this to take another month, or month an a half. This project is alive and kicking and is a priority for us. However, there is only so much one can do, with a daytime job as well. In the meantime, please, feel free to build it locally and try it out. Let us know, if you find any bugs, or have ideas for improvements. Pull requests are also more than welcome! :)

If you would like to help out, please get in touch with us and join our chat channel.

[carlspring]

@oeph ,

Thanks for your interest! We have now released version 1.0.0 to Maven Central (https://repo.maven.apache.org/maven2/).