You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@daffodil.apache.org by "stevedlawrence (via GitHub)" <gi...@apache.org> on 2024/01/23 15:53:17 UTC
[I] Option to include README in jar [daffodil-sbt]
stevedlawrence opened a new issue, #7:
URL: https://github.com/apache/daffodil-sbt/issues/7
Since we often distribute schemas as jars, it would be useful to include the README as well, since this file usually includes helpful things like usage and license information, which isn't necessarily in the schema files.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Option to include README in jar [daffodil-sbt]
Posted by "olabusayoT (via GitHub)" <gi...@apache.org>.
olabusayoT commented on issue #7:
URL: https://github.com/apache/daffodil-sbt/issues/7#issuecomment-2457377804
I wonder if we can also add build.sbt, since all of our schema projects rely on it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Option to include README in jar [daffodil-sbt]
Posted by "stevedlawrence (via GitHub)" <gi...@apache.org>.
stevedlawrence commented on issue #7:
URL: https://github.com/apache/daffodil-sbt/issues/7#issuecomment-1908478883
We should also include LICENSE/NOTICE files if they exist.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Option to include README in jar [daffodil-sbt]
Posted by "olabusayoT (via GitHub)" <gi...@apache.org>.
olabusayoT closed issue #7: Option to include README in jar
URL: https://github.com/apache/daffodil-sbt/issues/7
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Option to include README in jar [daffodil-sbt]
Posted by "olabusayoT (via GitHub)" <gi...@apache.org>.
olabusayoT commented on issue #7:
URL: https://github.com/apache/daffodil-sbt/issues/7#issuecomment-4961664159
Closing as wont-fix. We recommend adding mappings to the build.sbt as below
```
Seq(packageBin, packageSrc, packageDoc).map { task =>
Compile / task / mappings ++= Seq("COPYRIGHT.txt", "LICENSE.txt", "README.md")
.map{ name => (baseDirectory.value / name) -> name }
}
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Option to include README in jar [daffodil-sbt]
Posted by "mbeckerle (via GitHub)" <gi...@apache.org>.
mbeckerle commented on issue #7:
URL: https://github.com/apache/daffodil-sbt/issues/7#issuecomment-2458016061
If one adds a src/main/resources/doc directory with files in it, are those going to end up in a doc subdir in the jar, or does some special provision need to be made to get that to happen?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Option to include README in jar [daffodil-sbt]
Posted by "stevedlawrence (via GitHub)" <gi...@apache.org>.
stevedlawrence commented on issue #7:
URL: https://github.com/apache/daffodil-sbt/issues/7#issuecomment-2458115127
Yep, anything in src/main/resources ends up in the root of the jar, including any subdirectories. Nothing special needs to be done.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Option to include README in jar [daffodil-sbt]
Posted by "stevedlawrence (via GitHub)" <gi...@apache.org>.
stevedlawrence commented on issue #7:
URL: https://github.com/apache/daffodil-sbt/issues/7#issuecomment-2457424679
Possibly, though the layout of a jar is different than an SBT project. For example, it does not have a `src/main/resources` directory. So it isn't necessarily as simple as unziping a jar and running sbt, my guess is that isn't going to work. Note that we would also need to include plugins.bt since many build.sbt files rely on multiple plugins. More thought is probably needed to figure out how convert a jar to a buildable SBT project, or if another approach is needed (i.e. deliver the source repo with certain source/test files removed if necessary).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Option to include README in jar [daffodil-sbt]
Posted by "mbeckerle (via GitHub)" <gi...@apache.org>.
mbeckerle commented on issue #7:
URL: https://github.com/apache/daffodil-sbt/issues/7#issuecomment-2458145412
So perhaps all we need is guidelines that the README.md is for us, and user doc, rel-notes, instructions, whatever we want to include is just referenced from the README but lives under src/main/resources/doc ?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org