Skip to content

Commit

Permalink
update changelog an documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bdewein committed Jun 20, 2024
1 parent bbd6c8d commit 2c7ee61
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 12 deletions.
9 changes: 6 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,30 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-->

## UNRELEASED
## 2024-06-20

This release is compatible with XRechnung ?.?.?
This release is compatible with XRechnung 3.0.x

**Because of new CII-SR-461 and CII-SR-462 (as part of CEN Rules version 1.3.12) and increase of CII-SR-452 and CII-SR-454 error levels it might break your validation and business workflow. Please evaluate impact!**

### Added

* Using [CEN Schematron Rules 1.3.12](https://github.com/ConnectingEurope/eInvoicing-EN16931/releases/tag/validation-1.3.12)
* CEN unexpected test on decimal places in BT-131 "Invoice line net amount" in CII
* CEN unexpected tests on BR-AE-02, BR-AE-03, and BR-AE-04 with BT-32 and no BT-31 in CII
* Unit tests for CII-SR-461 and CII-SR-462 - multiple BT-7 "Value added tax point date" and BT-8 "Value added tax point date code" in CII

### Changed

* Using [CEN Schematron Rules 1.3.12](https://github.com/ConnectingEurope/eInvoicing-EN16931/releases/tag/validation-1.3.12)
* Using [XRechnung Schematron 2.1.0](https://github.com/itplr-kosit/xrechnung-schematron/releases/tag/release-2.1.0)
* Using [XRechnung Testsuite 2024-06-20](https://github.com/itplr-kosit/xrechnung-testsuite/releases/tag/release-2024-06-20)
* set CII-SR-452 customLevel to "error" to enforce correct cardinality of BT-9 "Payment due date" and BT-20 "Payment terms" in CII
* set CII-SR-454 customLevel to "error" to enforce exactly one BG-30 "Line VAT information" within BG-25 "Invoice line" in CII
* tests on BR-AE-02, BR-AE-03, and BR-AE-04 moved from `src/test/unexpected` to `src/test/cen-unit-tests`
* tests `cen-unit-test/cii-br-s-08-rounding-rule.xml` and `unexpected/br-co-23-reason-codes.xml` to comply with BR-CL-23
* tests `cen-unit-test/cii-br-e-10-test.xml` and `cen-unit-test/cii-br-e-10-test-2.xml` to comply with CII-SR-461


## 2023-11-15

This release is compatible with XRechnung 3.0.x
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ For further technical information see the specific pages [on usage](docs/usage.m

## Releases

Each [release](https://github.com/itplr-kosit/validator-configuration-xrechnung/releases) contains all necessary XML Schema and Schematron rules to validate UBL and CII invoice XML documents for conformity with [CIUS and Extension XRechnung](https://www.xoev.de/xrechnung-16828).
Each [release](https://github.com/itplr-kosit/validator-configuration-xrechnung/releases) contains all necessary XML Schema and Schematron rules to validate UBL and CII invoice XML documents for conformity with [CIUS and Extension XRechnung](https://xeinkauf.de/xrechnung/versionen-und-bundles/).

In particular this Validator Configuration integrates the following third-party artifacts:

Expand All @@ -21,4 +21,4 @@ In particular this Validator Configuration integrates the following third-party

The git master branch always has the latest code. Since March 2018 new releases have the following naming and versioning scheme:

The source code gets tagged with `release-${release-date}` and distributions get the name `validator-configuration-xrechnung_${xrechnung-version}_${release-date}` e.g. `validator-configuration-xrechnung_3.0.1_2023-09-22.zip`
The source code gets tagged with `release-${release-date}` and distributions get the name `validator-configuration-xrechnung_${xrechnung-version}_${release-date}` e.g. `validator-configuration-xrechnung_3.0.2_2024-06-20.zip`
10 changes: 5 additions & 5 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,14 @@ The following example demonstrates how to use a different CEN Schematron release

```shell
ant clean dist \
-Dcen.rules.version=1.3.11
-Dcen.rules.version=1.3.12
```

The following example demonstrates how to use a different CEN Schematron release, downloaded from the CEN GitHub repository:

```shell
ant clean dist \
-Dcen.rules.version=1.3.11 \
-Dcen.rules.version=1.3.12 \
```

To test with the latest SNAPSHOT versions of the CEN rules, add the following property to the Ant call:
Expand Down Expand Up @@ -203,15 +203,15 @@ If you want to skip tests call `ant dist-only`.
```

* Tag the last commit according to the following naming rule:
`release-${date-of-scheduled-release-e.g. 2023-11-15}`
`release-${date-of-scheduled-release-e.g. 2024-06-20}`
e.g.
`git tag release-2023-11-15 && git push origin release-2023-11-15`
`git tag release-2024-06-20 && git push origin release-2024-06-20`

### Publish

* Draft a new release at https://github.com/itplr-kosit/validator-configuration-xrechnung/releases/new
* Choose the git tag
* Add a release title of the following scheme: `Validator Configuration 2023-11-15 compatible with XRechnung 3.0.x`.
* Add a release title of the following scheme: `Validator Configuration 2024-06-20 compatible with XRechnung 3.0.x`.
* Copy & paste the high quality changelog entries for this release from CHANGELOG.md.
* Upload distribution zip and tick mark this release as a `pre-release`.

Expand Down
4 changes: 2 additions & 2 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ In an empty directory:
# download validator
curl -L "https://github.com/itplr-kosit/validator/releases/download/v1.5.0/validator-1.5.0-distribution.zip" --output validator.zip

# download configuration (for 3.0.1)
curl -L "https://github.com/itplr-kosit/validator-configuration-xrechnung/releases/download/release-2023-11-15/validator-configuration-xrechnung_3.0.1_2023-11-15.zip" --output validator-configuration.zip
# download configuration (for 3.0.2)
curl -L "https://github.com/itplr-kosit/validator-configuration-xrechnung/releases/download/release-2024-06-20/validator-configuration-xrechnung_3.0.2_2024-06-20.zip" --output validator-configuration.zip

# download one most recent test document
curl -L "https://raw.githubusercontent.com/itplr-kosit/xrechnung-testsuite/master/src/test/business-cases/standard/01.01a-INVOICE_ubl.xml" --output ubl.xml
Expand Down

0 comments on commit 2c7ee61

Please sign in to comment.