Skip to content
Permalink
Browse files
Updates to make top level project
- Removes all instances of "incubating"
- Removes the DISCLAIMER file and dialog in windows installer
- Updates README to match doap description
- Rewrap daffodil-cli readme so it's more readable
- Update Windows installer background image to replace incubator logo
  with ASF logo
- Maks consistent version calculation for Windows--no need for a "build"
  version
- Update daffodil .ico to be a more modern format that Windows can
  resize properly

DAFFODIL-2470
  • Loading branch information
stevedlawrence committed Feb 19, 2021
1 parent 0a390f6 commit 8d5dbed4044f821bb1f904b3adacafa10228053c
Showing 22 changed files with 94 additions and 173 deletions.
@@ -17,7 +17,7 @@ name: SonarCloud Workflow
on: [push]
jobs:
sonarCloudTrigger:
if: github.repository == 'apache/incubator-daffodil'
if: github.repository == 'apache/daffodil'
name: SonarCloud Trigger
runs-on: ubuntu-latest
strategy:

This file was deleted.

2 KEYS
@@ -31,7 +31,7 @@ Developers:
Releases will be signed using one of the keys in this file. This file will
be available with the distributed Apache Daffodil releases at:

https://dist.apache.org/repos/dist/release/incubator/daffodil/KEYS
https://dist.apache.org/repos/dist/release/daffodil/KEYS

********************************************************************************

@@ -204,9 +204,9 @@

APACHE DAFFODIL SUBCOMPONENTS:

The Apache Daffodil (incubating) project contains subcomponents with separate
copyright notices and license terms. Your use of the source code for these
subcomponents is subject to the terms and conditions of the following licenses.
The Apache Daffodil project contains subcomponents with separate copyright
notices and license terms. Your use of the source code for these subcomponents
is subject to the terms and conditions of the following licenses.

This product bundles source from 'Passera', including all files under the
following directories:
@@ -16,21 +16,21 @@
-->

[<img src="https://daffodil.apache.org/assets/themes/apache/img/apache-daffodil-logo.svg" height="85" align="left" alt="Apache Daffodil"/>][Website]
[<img src="https://img.shields.io/github/workflow/status/apache/incubator-daffodil/Daffodil%20CI/master.svg" align="right"/>][GitHub Actions]
[<img src="https://img.shields.io/github/workflow/status/apache/daffodil/Daffodil%20CI/master.svg" align="right"/>][GitHub Actions]
<br clear="right" />
[<img src="https://img.shields.io/codecov/c/github/apache/incubator-daffodil/master.svg" align="right"/>][CodeCov]
[<img src="https://img.shields.io/codecov/c/github/apache/daffodil/master.svg" align="right"/>][CodeCov]
<br clear="right" />
[<img src="https://img.shields.io/maven-central/v/org.apache.daffodil/daffodil-core_2.12.svg?color=brightgreen&label=version" align="right"/>][Releases]
<br clear="both" />

Apache Daffodil (incubating) is the open source implementation of the [Data Format
Description Language (DFDL)], a specification created by the [Open Grid Forum]. DFDL is
capable of describing many data formats, including textual and binary, commercial
record-oriented, scientific and numeric, modern and legacy, and many industry standards.
It leverages XML technology and concepts, using a subset of W3C XML schema type system and
annotations to describe such data. Daffodil uses this description to parse data into an
infoset represented as XML or JSON, easily capable of ingestion, validation, and
transformation.
Apache Daffodil is an open-source implementation of the [DFDL specification]
that uses DFDL data descriptions to parse fixed format data into an infoset.
This infoset is commonly converted into XML or JSON to enable the use of
well-established XML or JSON technologies and libraries to consume, inspect,
and manipulate fixed format data in existing solutions. Daffodil is also
capable of serializing or "unparsing" data back to the original data format.
The DFDL infoset can also be converted directly to/from the data structures
carried by data processing frameworks so as to bypass any XML/JSON overheads.

For more information about Daffodil, see https://daffodil.apache.org/.

@@ -100,28 +100,18 @@ users@daffodil.apache.org mailing lists. Bugs can be reported via the [Daffodil

Apache Daffodil is licensed under the [Apache License, v2.0].

## Disclaimer

Apache Daffodil is an effort undergoing incubation at The Apache Software Foundation
(ASF), sponsored by the Incubator PMC. Incubation is required of all newly accepted
projects until a further review indicates that the infrastructure, communications, and
decision making process have stabilized in a manner consistent with other successful ASF
projects. While incubation status is not necessarily a reflection of the completeness or
stability of the code, it does indicate that the project has yet to be fully endorsed by
the ASF.




[Apache License, v2.0]: https://www.apache.org/licenses/LICENSE-2.0
[Apache RAT]: https://creadur.apache.org/rat/
[CodeCov]: https://codecov.io/gh/apache/incubator-daffodil/
[CodeCov]: https://codecov.io/gh/apache/daffodil/
[Command Line Interface]: https://daffodil.apache.org/cli/
[Daffodil JIRA]: https://issues.apache.org/jira/projects/DAFFODIL
[Data Format Description Language (DFDL)]: http://www.ogf.org/dfdl
[DFDL specification]: http://www.ogf.org/dfdl
[Open Grid Forum]: http://www.ogf.org
[Releases]: http://daffodil.apache.org/releases/
[SBT]: http://www.scala-sbt.org
[Github Actions]: https://github.com/apache/incubator-daffodil/actions?query=branch%3Amaster+
[Github Actions]: https://github.com/apache/daffodil/actions?query=branch%3Amaster+
[Website]: https://daffodil.apache.org
[sbt-scoverage]: https://github.com/scoverage/sbt-scoverage
@@ -151,12 +151,11 @@ lazy val commonSettings = Seq(
pomIncludeRepository in ThisBuild := { _ => false },
scmInfo := Some(
ScmInfo(
browseUrl = url("https://gitbox.apache.org/repos/asf/incubator-daffodil.git"),
connection = "scm:git:https://gitbox.apache.org/repos/asf/incubator-daffodil.git"
browseUrl = url("https://github.com/apache/daffodil"),
connection = "scm:git:https://github.com/apache/daffodil"
)
),
licenses := Seq("Apache License, Version 2.0" -> url("https://www.apache.org/licenses/LICENSE-2.0")),
mappings in (Compile, packageBin) += baseDirectory.value / ".." / "DISCLAIMER" -> "META-INF/DISCLAIMER",
homepage := Some(url("https://daffodil.apache.org")),
unmanagedBase := baseDirectory.value / "lib" / "jars",
sourceManaged := baseDirectory.value / "src_managed",
@@ -291,14 +290,14 @@ lazy val ratSettings = Seq(
lazy val unidocSettings = Seq(
unidocProjectFilter in (ScalaUnidoc, unidoc) := inProjects(sapi, udf),
scalacOptions in (ScalaUnidoc, unidoc) := Seq(
"-doc-title", "Apache Daffodil (incubating) " + version.value + " Scala API",
"-doc-title", "Apache Daffodil " + version.value + " Scala API",
"-doc-root-content", (baseDirectory in sapi).value + "/root-doc.txt"
),

unidocProjectFilter in (JavaUnidoc, unidoc) := inProjects(japi, udf),
javacOptions in (JavaUnidoc, unidoc) := Seq(
"-windowtitle", "Apache Daffodil (incubating) " + version.value + " Java API",
"-doctitle", "<h1>Apache Daffodil (incubating) " + version.value + " Java API</h1>",
"-windowtitle", "Apache Daffodil " + version.value + " Java API",
"-doctitle", "<h1>Apache Daffodil " + version.value + " Java API</h1>",
"-notimestamp",
"-quiet",
),
@@ -116,9 +116,9 @@ echo

REPO_ROOT=`pwd`

DAFFODIL_REPO="incubator-daffodil"
DAFFODIL_SITE_REPO="incubator-daffodil-site"
DAFFODIL_DIST="incubator-daffodil-dist"
DAFFODIL_REPO="daffodil"
DAFFODIL_SITE_REPO="daffodil-site"
DAFFODIL_DIST="daffodil-dist"

echo "Cloning repos..."

@@ -129,8 +129,8 @@ echo
echo git clone ssh://git@github.com/apache/$DAFFODIL_SITE_REPO.git
git clone ssh://git@github.com/apache/$DAFFODIL_SITE_REPO.git

echo svn checkout https://dist.apache.org/repos/dist/dev/incubator/daffodil $DAFFODIL_DIST
svn checkout https://dist.apache.org/repos/dist/dev/incubator/daffodil $DAFFODIL_DIST
echo svn checkout https://dist.apache.org/repos/dist/dev/daffodil $DAFFODIL_DIST
svn checkout https://dist.apache.org/repos/dist/dev/daffodil $DAFFODIL_DIST

pushd $REPO_ROOT/$DAFFODIL_REPO &> /dev/null

@@ -187,7 +187,7 @@ find $DAFFODIL_DIST_DIR -maxdepth 1 -name $VERSION-\* -exec svn delete --force {

echo "Installing Source and Convenience Binaries..."
mkdir -p $DAFFODIL_RELEASE_DIR/{src,bin}/
git archive --format=zip --prefix=apache-daffodil-$VERSION-incubating-src/ HEAD > $DAFFODIL_RELEASE_DIR/src/apache-daffodil-$VERSION-incubating-src.zip
git archive --format=zip --prefix=apache-daffodil-$VERSION-src/ HEAD > $DAFFODIL_RELEASE_DIR/src/apache-daffodil-$VERSION-src.zip
cp daffodil-cli/target/universal/apache-daffodil-*.tgz $DAFFODIL_RELEASE_DIR/bin/
cp daffodil-cli/target/universal/apache-daffodil-*.zip $DAFFODIL_RELEASE_DIR/bin/
cp daffodil-cli/target/rpm/RPMS/noarch/apache-daffodil-*.rpm $DAFFODIL_RELEASE_DIR/bin/
@@ -259,7 +259,7 @@ else
cat << EOF > /root/complete-release
#!/bin/bash
set -x
cd $DAFFODIL_DIST_DIR && svn ci --username $APACHE_USERNAME -m 'Staging Apache Daffodil (incubating) $VERSION-$PRE_RELEASE'
cd $DAFFODIL_DIST_DIR && svn ci --username $APACHE_USERNAME -m 'Staging Apache Daffodil $VERSION-$PRE_RELEASE'
cd $DAFFODIL_REPO_DIR && git push origin v$VERSION-$PRE_RELEASE
cd $DAFFODIL_SITE_DIR && git push origin master
EOF
@@ -15,11 +15,18 @@
limitations under the License.
-->

# Apache Daffodil (incubating)
# Apache Daffodil

## Introduction

Apache Daffodil (incubating) is the open source implementation of the [Data Format Description Language (DFDL)](http://www.ogf.org/dfdl), a specification created by the [Open Grid Forum](http://www.ogf.org). DFDL is capable of describing many data formats, including textual and binary, commercial record-oriented, scientific and numeric, modern and legacy, and many industry standards. It leverages XML technology and concepts, using a subset of W3C XML schema type system and annotations to describe such data. Daffodil uses this description to parse data into an infoset represented as XML or JSON, easily capable of ingestion, validation, and transformation.
Apache Daffodil is an open-source implementation of the DFDL specification
that uses DFDL data descriptions to parse fixed format data into an infoset.
This infoset is commonly converted into XML or JSON to enable the use of
well-established XML or JSON technologies and libraries to consume, inspect,
and manipulate fixed format data in existing solutions. Daffodil is also
capable of serializing or "unparsing" data back to the original data format.
The DFDL infoset can also be converted directly to/from the data structures
carried by data processing frameworks so as to bypass any XML/JSON overheads.

For more information about Daffodil, see https://daffodil.apache.org/.

@@ -41,23 +48,33 @@ To execute Daffodil on Windows:
$ .\bin\daffodil.bat [options]
```

Use the `--help` option or see the [Command Line Interface](https://daffodil.apache.org/cli/) documentation for details on its usage.
Use the `--help` option or see the [Command Line Interface](https://daffodil.apache.org/cli/)
documentation for details on its usage.

### Debugging

Daffodil comes with a built-in interactive debugger, allowing the user to pause parse/unparse and inspect various aspects of the state. To enable the interactive debugger, supply the global -d option when parsing or unparsing, for example:
Daffodil comes with a built-in interactive debugger, allowing the user to pause
parse/unparse and inspect various aspects of the state. To enable the
interactive debugger, supply the global -d option when parsing or unparsing,
for example:

```bash
$ ./bin/daffodil -d parse --schema <path/to/schema.dfdl.xsd> input-file
```

When running the debugger, the user is provided with a command prompt, at which point the user can execute debugger commands to control the debugger and inspect state. Type `help` at the command prompt to get information on the debugger commands, or `help <command>` to get information about a specific command.
When running the debugger, the user is provided with a command prompt, at which
point the user can execute debugger commands to control the debugger and
inspect state. Type `help` at the command prompt to get information on the
debugger commands, or `help <command>` to get information about a specific
command.

See the [Interactive Debugger](https://daffodil.apache.org/debugger/) page for its detailed usage.

## Getting Help

For questions, we can be reached at the dev@daffodil.apache.org or users@daffodil.apache.org mailing lists. Bugs can be reported via the [Daffodil JIRA](https://issues.apache.org/jira/projects/DAFFODIL).
For questions, we can be reached at the dev@daffodil.apache.org or
users@daffodil.apache.org mailing lists. Bugs can be reported via the
[Daffodil JIRA](https://issues.apache.org/jira/projects/DAFFODIL).

## License

@@ -204,9 +204,9 @@

APACHE DAFFODIL SUBCOMPONENTS:

The Apache Daffodil (incubating) project contains subcomponents with separate
copyright notices and license terms. Your use of the source code for these
subcomponents is subject to the terms and conditions of the following licenses.
The Apache Daffodil project contains subcomponents with separate copyright
notices and license terms. Your use of the source code for these subcomponents
is subject to the terms and conditions of the following licenses.

This product bundles compiled source from 'Passera', including the following
files:
@@ -30,15 +30,14 @@ enablePlugins(WindowsPlugin)

executableScriptName := "daffodil"

packageName in Universal := "apache-daffodil-" + version.value + "-incubating-bin" //tarball name
packageName in Universal := "apache-daffodil-" + version.value + "-bin" //tarball name
packageName in Linux := executableScriptName.value
packageName in Rpm := "apache-" + executableScriptName.value
packageName in Windows := executableScriptName.value

mappings in Universal ++= Seq(
baseDirectory.value / "bin.LICENSE" -> "LICENSE",
baseDirectory.value / "bin.NOTICE" -> "NOTICE",
baseDirectory.value / ".." / "DISCLAIMER" -> "DISCLAIMER",
baseDirectory.value / "README.md" -> "README.md",
)

@@ -51,17 +50,17 @@ rpmVendor := "Apache Daffodil"

packageArchitecture in Rpm := "noarch"

packageSummary in Rpm := "Open source implementation of the Data Format Description Language (DFDL)"
packageSummary in Rpm := "Open-source implementation of the Data Format Description Language (DFDL)"

packageDescription in Rpm := """
Apache Daffodil (incubating) is the open source implementation of the Data
Format Description Language (DFDL), a specification created by the Open Grid
Forum. DFDL is capable of describing many data formats, including textual and
binary, commercial record-oriented, scientific and numeric, modern and legacy,
and many industry standards. It leverages XML technology and concepts, using a
subset of W3C XML schema type system and annotations to describe such data.
Daffodil uses this description to parse data into an XML infoset for ingestion
and validation.
Apache Daffodil is an open-source implementation of the DFDL specification
that uses DFDL data descriptions to parse fixed format data into an infoset.
This infoset is commonly converted into XML or JSON to enable the use of
well-established XML or JSON technologies and libraries to consume, inspect,
and manipulate fixed format data in existing solutions. Daffodil is also
capable of serializing or "unparsing" data back to the original data format.
The DFDL infoset can also be converted directly to/from the data structures
carried by data processing frameworks so as to bypass any XML/JSON overheads.
""".trim

// The below is a hack. The sbt native packager plugin does not provide a way
@@ -81,7 +80,7 @@ packageDescription in Rpm := (packageDescription in Rpm).value + """
version in Rpm := {
val parts = version.value.split("-", 2)
val ver = parts(0) // removes snapshot if it exists
ver + ".incubating"
ver
}

rpmRelease := {
@@ -115,24 +114,15 @@ name in Windows := "Daffodil"
// into the WiX productName field. Another strange choice.
packageSummary in Windows := "Daffodil"

// The Windows packager SBT plug-in limits the length of the
// packageDescription field to a single line. Originally this was a
// full paragraph, as seen in the RPM section, above.
packageDescription in Windows := """Apache Daffodil (incubating) is the open source implementation of the Data Format Description Language (DFDL)""".trim

// Calculate the version number dynamically and pass it in.
// Windows permits up to four numeric values (e.g. 2.1.5.1820)
// where the numbers represent major, minor, patch and build
// respectively. In RPM packaging we add 'incubating', but
// Windows will barf on this. Here we suffix a zero (0) build
// number for snapshot/development/debug builds. A one (1)
// in the build number could be used to differentiate official
// production builds that are destined for release.
version in Windows := {
val parts = version.value.split("-", 2)
val ver = parts(0) // removes snapshot if it exists
ver + ".0"
}
// The Windows packager SBT plug-in limits the length of the packageDescription
// field to a single line. Use the short packageSummary from the RPM config.
packageDescription in Windows := (packageSummary in Rpm).value

// Use the same version number as in the rpm, which has SNAPSHOT removed if it
// exists. Windows version numbers has no concept of a "snapshot build", only
// major, minor, patch, and build. So Windows MSI versions do not differentiate
// between snapshots and non-snapshots.
version in Windows := (version in Rpm).value

// Required and critical GUIDs. Ironically the ProductId is unique
// to a given release, but UpgradeId must NEVER change! This may
@@ -180,11 +170,11 @@ wixProductLicense := {
writer.close
Option(targetLicense)
}

// Use the wixFiles variable to add in the Daffodil-specific dialog
// boxes and sequence.
wixFiles ++= Seq(
(sourceDirectory in Windows).value / "WixUI_Daffodil.wxs",
(sourceDirectory in Windows).value / "DisclaimerDlg_Daffodil.wxs"
)

// The SBT Native Packager plug-in assumes that we want to give the user
@@ -222,8 +212,8 @@ wixProductConfig := {

// Define icons (ID should not be longer than 18 chars and must end with ".exe")
val icon = Seq(
<Icon Id="Icon.exe" SourceFile={ ((sourceDirectory in Windows).value / "apache-daffodil.ico").toString } />,
<Property Id="ARPPRODUCTICON" Value="Icon.exe" />
<Icon Id="Daffodil.ico" SourceFile={ ((sourceDirectory in Windows).value / "apache-daffodil.ico").toString } />,
<Property Id="ARPPRODUCTICON" Value="Daffodil.ico" />
)

// String together the additional XML around the generated directory and file lists.
@@ -271,7 +271,7 @@ class CLIConf(arguments: Array[String]) extends scallop.ScallopConf(arguments)
uri.getOrElse(throw new Exception("Could not find file or resource %s" format s))
})

printedName = "Apache Daffodil (incubating)"
printedName = "Apache Daffodil"

helpWidth(76)

0 comments on commit 8d5dbed

Please sign in to comment.