mbeckerle commented on a change in pull request #1: URL: https://github.com/apache/daffodil-schema.g8/pull/1#discussion_r583695443
########## File path: README.md ########## @@ -0,0 +1,65 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> + +# Apache Daffodil Schema Template Review comment: And here too. ########## File path: project/plugins.sbt ########## @@ -0,0 +1,18 @@ +// Licensed to the Apache Software Foundation (ASF) under one or more +// contributor license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright ownership. +// The ASF licenses this file to You under the Apache License, Version 2.0 +// (the "License"); you may not use this file except in compliance with +// the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +addSbtPlugin("org.foundweekends.giter8" %% "sbt-giter8" % "0.13.1") + +addSbtPlugin("org.musigma" % "sbt-rat" % "0.7.0") Review comment: If a user creates a DFDL schema project, does their schema now get ratchecks run on it? The user's schema isn't necessarily ASL licensed at all, so ratcheck seems inappropriate. I'm not opposed to having the plugin here, and encouraging use of the ASL license for these projects, but for example I don't think CI should be running ratcheck on user schema projects unless we are able to somehow detect the presence of the ASL license as having been selected (or at least not unselected) by the author of the schema project. ########## File path: NOTICE ########## @@ -0,0 +1,5 @@ +Apache Daffodil Schema Template Review comment: Suggest Apache Daffodil DFDL Schema Template ########## File path: .github/workflows/main.yml ########## @@ -0,0 +1,53 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: Daffodil Schema Template CI Review comment: Suggest Daffodil DFDL Schema Template CI ########## File path: src/main/g8/src/test/resources/$package$/$name__camel$/Test$name__Camel$.tdml ########## @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="UTF-8"?> +$! Review comment: why do so many of these files have "_Camel" in their template names? ########## File path: README.md ########## @@ -0,0 +1,65 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> + +# Apache Daffodil Schema Template + +This repository is a [Giter8] template for [Apache Daffodil] DFDL schemas. + +## Usage + +Install [SBT] and run the following command: + +``` +sbt new apache/daffodil-schema.g8 +``` + +This command prompts for various properties and creates a bare-bones directory +structure that follows the recommended [DFDL Schema Project Layout]. This +includes git and sbt configuration files, a basic DFDL schema file, and [TDML] +and test files. + +### Properties + +The following properties are used to configured the generated schema project: Review comment: DFDL schema ########## File path: README.md ########## @@ -0,0 +1,65 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> + +# Apache Daffodil Schema Template + +This repository is a [Giter8] template for [Apache Daffodil] DFDL schemas. + +## Usage + +Install [SBT] and run the following command: + +``` +sbt new apache/daffodil-schema.g8 +``` + +This command prompts for various properties and creates a bare-bones directory +structure that follows the recommended [DFDL Schema Project Layout]. This +includes git and sbt configuration files, a basic DFDL schema file, and [TDML] +and test files. + +### Properties + +The following properties are used to configured the generated schema project: + +<dl> + <dt>name</dt> + <dd> + the name of the file format, for example "jpeg" or "png" + </dd> + <dt>package</dt> + <dd> + the package namespace, for example "com.example" + </dd> + <dt>daffodil_version</dt> + <dd> + the version of Apache Daffodil to add as a dependency, defaults to the + latest release on maven central + </dd> +</dl> + +## License + +Apache Daffodil Schema Template is licensed under the [Apache License, v2.0]. Review comment: and here ########## File path: src/test/g8/test ########## @@ -0,0 +1,21 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at + +# http://www.apache.org/licenses/LICENSE-2.0 + +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# make sure the jar is built +> package +$ exists target/dfdl-format-0.1.0-SNAPSHOT.jar + +# make sure the tests pass +> test Review comment: Please add comment akin to what you just said, into the file, or if you prefer, into the README or somewhere. ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
