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

merging changes from 1.3.0 Release to Master #474

Merged
merged 23 commits into from
Dec 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
8e25069
Version number update for potential release
sparkhi Nov 21, 2023
38ddaf3
[maven-release-plugin] prepare release 1.3.0-RC1
sparkhi Nov 22, 2023
2b10284
[maven-release-plugin] prepare for next development iteration
sparkhi Nov 22, 2023
56bb94b
Added ability to sign artifacts for release
sparkhi Nov 23, 2023
7b46804
[maven-release-plugin] prepare release 1.3.0-RC1-BETA
sparkhi Nov 23, 2023
4141084
[maven-release-plugin] prepare for next development iteration
sparkhi Nov 23, 2023
20d81e3
Added ability to sign artifacts for release
sparkhi Nov 23, 2023
b6a448f
[maven-release-plugin] prepare release 1.3.0-RC1
sparkhi Nov 23, 2023
4545454
[maven-release-plugin] rollback the release of 1.3.0-RC1
sparkhi Nov 23, 2023
e8315e1
[maven-release-plugin] prepare release 1.3.0-RC1-1
sparkhi Nov 23, 2023
16e588a
[maven-release-plugin] prepare for next development iteration
sparkhi Nov 23, 2023
cfdacce
Small instruction about running a release
sparkhi Nov 24, 2023
9de2172
details were missing from console in case of a schema failure
sparkhi Nov 28, 2023
451dab8
Merge pull request #466 from digital-preservation/global-directive-er…
sparkhi Nov 28, 2023
c6cbeb9
[maven-release-plugin] prepare release 1.3.0-RC2
sparkhi Nov 30, 2023
6dd9f98
[maven-release-plugin] prepare for next development iteration
sparkhi Nov 30, 2023
52728b6
Modifications to bundle 64 bit JRE so users can more heap memory
sparkhi Dec 1, 2023
da88650
Merge pull request #468 from digital-preservation/use-64-bit-jre-in-d…
sparkhi Dec 1, 2023
01dcd3a
[maven-release-plugin] prepare release 1.3.0-RC3
sparkhi Dec 1, 2023
0281755
[maven-release-plugin] prepare for next development iteration
sparkhi Dec 1, 2023
f0778ab
Updates to version numbers in ReadMe. Removed the docker section unti…
sparkhi Dec 13, 2023
e4b8754
[maven-release-plugin] prepare release 1.3.0
sparkhi Dec 13, 2023
2bdae6f
[maven-release-plugin] prepare for next development iteration
sparkhi Dec 13, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 3 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ built using the [Apache Maven](https://maven.apache.org/) build tool:

1. For use in other Java/Scala Applications, build by executing `mvn clean install`.
2. For the Command Line Interface or Swing GUI, build by executing `mvn clean package`.
3. For the Docker image (`nationalarchives/csv-validator:latest`), build by executing `mvn clean package -Pdocker`.


Maven Artifacts
Expand All @@ -42,7 +41,7 @@ If you wish to use the CSV Validator from your own Java project, we provide a na
<dependency>
<groupId>uk.gov.nationalarchives</groupId>
<artifactId>csv-validator-java-api</artifactId>
<version>1.2-RC4</version>
<version>1.3.0</version>
</dependency>
```

Expand Down Expand Up @@ -81,7 +80,7 @@ Likewise, if you wish to use the CSV Validator from your own Scala project, the
<dependency>
<groupId>uk.gov.nationalarchives</groupId>
<artifactId>csv-validator-core</artifactId>
<version>1.2-RC4</version>
<version>1.3.0</version>
</dependency>
```

Expand All @@ -91,26 +90,14 @@ An example of using the Scala API can be found in the class `uk.gov.nationalarch
`csv-validator-java-api` module. The Scala API at present gives much more control over the individual Schema Parsing and Validation Processor
than the Java API.

Docker Container (of CSV Validator Command Line Tool)
=====================================================
To see the options run:
```bash
docker run nationalarchives/csv-validator
```

Then for example, to validate `/tmp/my-data.csv` with `/tmp/my-schema.csvs` you would run:
```bash
docker run nationalarchives/csv-validator /tmp/my-data.csv /tmp/my-schema.csvs
```

Schema Examples
===============
Examples of CSV Schema can be found in the test cases of the `csv-validator-core` module. See the `*.csvs` files in [acceptance/](https://github.com/digital-preservation/csv-validator/tree/master/csv-validator-core/src/test/resources/uk/gov/nationalarchives/csv/validator/acceptance). Schemas used by the Digital Preservation department at The National Archives are also available in the `example-schemas` folder of the [csv-schema](https://github.com/digital-preservation/csv-schema) repository.


Current Limitations of the CSV Validator Tool
=============================================
The CSV Validator implements almost all of `CSV Schema 1.1` language, current limitations and missing functionality are:
The CSV Validator implements almost all of `CSV Schema 1.2 (Draft)` language, current limitations and missing functionality are:

* `DateExpr` is not yet fully implemented (may raise Schema check error).

Expand Down
2 changes: 1 addition & 1 deletion csv-validator-cmd/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<parent>
<groupId>uk.gov.nationalarchives</groupId>
<artifactId>csv-validator-parent</artifactId>
<version>1.2-SNAPSHOT</version>
<version>1.3.1-SNAPSHOT</version>
<relativePath>../csv-validator-parent</relativePath>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion csv-validator-core/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<parent>
<groupId>uk.gov.nationalarchives</groupId>
<artifactId>csv-validator-parent</artifactId>
<version>1.2-SNAPSHOT</version>
<version>1.3.1-SNAPSHOT</version>
<relativePath>../csv-validator-parent</relativePath>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion csv-validator-distribution/assembly-windows-with-jre.xml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
<id>bin-win32-with-jre</id>
<id>bin-win64-with-jre</id>
<formats>
<format>zip</format>
</formats>
Expand Down
9 changes: 4 additions & 5 deletions csv-validator-distribution/pom.xml
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>uk.gov.nationalarchives</groupId>
<artifactId>csv-validator-parent</artifactId>
<version>1.2-SNAPSHOT</version>
<version>1.3.1-SNAPSHOT</version>
<relativePath>../csv-validator-parent</relativePath>
</parent>
<artifactId>csv-validator-distribution</artifactId>
Expand All @@ -24,7 +23,7 @@
<goal>wget</goal>
</goals>
<configuration>
<url>https://github.com/adoptium/temurin11-binaries/releases/download/jdk-11.0.21%2B9/OpenJDK11U-jre_x86-32_windows_hotspot_11.0.21_9.zip</url>
<url>https://github.com/adoptium/temurin11-binaries/releases/download/jdk-11.0.21%2B9/OpenJDK11U-jre_x64_windows_hotspot_11.0.21_9.zip</url>
<unpack>false</unpack>
<outputDirectory>${project.build.directory}</outputDirectory>
</configuration>
Expand All @@ -44,7 +43,7 @@
</goals>
<configuration>
<target>
<unzip dest="${project.build.directory}/jre_tmp/" src="${project.build.directory}/OpenJDK11U-jre_x86-32_windows_hotspot_11.0.21_9.zip" />
<unzip dest="${project.build.directory}/jre_tmp/" src="${project.build.directory}/OpenJDK11U-jre_x64_windows_hotspot_11.0.21_9.zip" />
<move todir="${project.build.directory}/jre-windows/">
<fileset dir="${project.build.directory}/jre_tmp/jdk-11.0.21+9-jre/">
<include name="**/*" />
Expand Down
2 changes: 1 addition & 1 deletion csv-validator-java-api/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<parent>
<groupId>uk.gov.nationalarchives</groupId>
<artifactId>csv-validator-parent</artifactId>
<version>1.2-SNAPSHOT</version>
<version>1.3.1-SNAPSHOT</version>
<relativePath>../csv-validator-parent</relativePath>
</parent>

Expand Down
32 changes: 26 additions & 6 deletions csv-validator-parent/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<groupId>uk.gov.nationalarchives</groupId>
<artifactId>csv-validator-parent</artifactId>
<version>1.2-SNAPSHOT</version>
<version>1.3.1-SNAPSHOT</version>
<packaging>pom</packaging>

<name>csv-validator-parent</name>
Expand Down Expand Up @@ -81,14 +81,34 @@
</scm>

<profiles>

<!-- Default profile publishes to Maven Central -->
<!-- See: https://search.maven.org/search?q=a:csv-validator-core -->
<!-- this profile signs the jars before publishing, if the jars are not signed, the deployment to maven central fails -->
<!-- when doing a release, just run mvn release:perform -Prelease-sign-artifacts for this to work. It will ask for the -->
<!-- gpg passphrase when run. It assumes that you have a gpg key setup properly -->
<profile>
<id>default-release-repo</id>
<id>release-sign-artifacts</id>
<activation>
<activeByDefault>true</activeByDefault>
<property>
<name>performRelease</name>
<value>true</value>
</property>
</activation>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<executions>
<execution>
<id>sign-artifacts</id>
<phase>verify</phase>
<goals>
<goal>sign</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
<distributionManagement>
<snapshotRepository>
<id>sonatype-nexus-snapshot-staging</id>
Expand Down
2 changes: 1 addition & 1 deletion csv-validator-ui/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<parent>
<groupId>uk.gov.nationalarchives</groupId>
<artifactId>csv-validator-parent</artifactId>
<version>1.2-SNAPSHOT</version>
<version>1.3.1-SNAPSHOT</version>
<relativePath>../csv-validator-parent</relativePath>
</parent>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ object CsvValidatorUi extends SimpleSwingApplication {
case _ =>
}

CsvValidatorCmdApp.validate(
val cliResult = CsvValidatorCmdApp.validate(
TextFile(Paths.get(csvFilePath), csvEncoding, validateEncoding),
TextFile(Paths.get(csvSchemaFilePath), csvSchemaEncoding),
failOnFirstError,
Expand All @@ -161,12 +161,12 @@ object CsvValidatorUi extends SimpleSwingApplication {
trace = false,
progress,
rowCallback
)._2 match {
)

cliResult._2 match {
case SystemExitCodes.ValidCsv => toConsole("PASS")
case _ => toConsole("FAIL")
case _ => toConsole(cliResult._1)
}


}

/**
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>uk.gov.nationalarchives</groupId>
<artifactId>csv-validator-parent</artifactId>
<version>1.2-SNAPSHOT</version>
<version>1.3.1-SNAPSHOT</version>
<relativePath>csv-validator-parent</relativePath>
</parent>

Expand Down