Skip to content

Commit

Permalink
going through release checklist, mostly updating versions
Browse files Browse the repository at this point in the history
  • Loading branch information
nmerket committed Aug 3, 2018
1 parent 7019061 commit 053e33d
Show file tree
Hide file tree
Showing 11 changed files with 16 additions and 15 deletions.
2 changes: 1 addition & 1 deletion examples/audit.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<HPXML xmlns="http://hpxmlonline.com/2014/6" schemaVersion="2.2.1">
<HPXML xmlns="http://hpxmlonline.com/2014/6" schemaVersion="2.3">
<XMLTransactionHeaderInformation>
<XMLType/>
<XMLGeneratedBy>Super-duper audit software v1.0</XMLGeneratedBy>
Expand Down
2 changes: 1 addition & 1 deletion examples/bpi2101.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<HPXML xmlns="http://hpxmlonline.com/2014/6" schemaVersion="2.2.1">
<HPXML xmlns="http://hpxmlonline.com/2014/6" schemaVersion="2.3">
<XMLTransactionHeaderInformation>
<XMLType>BPI-2101</XMLType>
<XMLGeneratedBy>Noel</XMLGeneratedBy>
Expand Down
2 changes: 1 addition & 1 deletion examples/upgrade.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<HPXML xmlns="http://hpxmlonline.com/2014/6" schemaVersion="2.2.1">
<HPXML xmlns="http://hpxmlonline.com/2014/6" schemaVersion="2.3">
<XMLTransactionHeaderInformation>
<XMLType/>
<XMLGeneratedBy>Joe</XMLGeneratedBy>
Expand Down
4 changes: 2 additions & 2 deletions guide/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@
# built documents.
#
# The short X.Y version.
version = '2.2' # should match hpxml version
version = '2.3' # should match hpxml version
# The full version, including alpha/beta/rc tags.
release = '2.2'
release = '2.3'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
2 changes: 1 addition & 1 deletion guide/source/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The HPXML Working Group can be a valuable resource for program administrators, i
Versioning
==========

The HPXML schema follows the `Semantic Versioning 2.0 specification <http://semver.org/>`_. The version numbers follow a pattern of Major, Minor, and Patch (e.g., 2.1.0). The major version number is incremented when the schemas are changed in a manner that is incompatible with previous versions. Examples of changes that require a major version change include renaming elements, removing elements, moving elements, and removing enumerations.
The HPXML schema follows the `Semantic Versioning 2.0 specification <http://semver.org/>`_. The version numbers follow a pattern of Major, Minor, and Patch (e.g., 2.3.0). The major version number is incremented when the schemas are changed in a manner that is incompatible with previous versions. Examples of changes that require a major version change include renaming elements, removing elements, moving elements, and removing enumerations.

The minor version number is incremented when the schemas are changed in a manner that is backwards compatible with previous versions that share the same major version. In other words, a document created in a previous version of the schema will also validate against the new schema. Examples of changes that require a minor version change include adding elements, adding enumerations, and changing the annotation in the schema for an element.

Expand Down
4 changes: 2 additions & 2 deletions guide/source/software_developer/references.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ simple example of this is how a window can reference the wall to which it is att
:emphasize-lines: 19,25
<?xml version="1.0" encoding="UTF-8"?>
<HPXML xmlns="http://hpxmlonline.com/2014/6" schemaVersion="2.2">
<HPXML xmlns="http://hpxmlonline.com/2014/6" schemaVersion="2.3">
<XMLTransactionHeaderInformation>
<XMLType></XMLType>
<XMLGeneratedBy></XMLGeneratedBy>
Expand Down Expand Up @@ -91,7 +91,7 @@ to have a way to indicate that they are the same item.
:emphasize-lines: 19,34
<?xml version="1.0" encoding="UTF-8"?>
<HPXML xmlns="http://hpxmlonline.com/2014/6" schemaVersion="2.2">
<HPXML xmlns="http://hpxmlonline.com/2014/6" schemaVersion="2.3">
<XMLTransactionHeaderInformation>
<XMLType></XMLType>
<XMLGeneratedBy></XMLGeneratedBy>
Expand Down
2 changes: 1 addition & 1 deletion guide/source/software_developer/usecases/example1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<HPXML xmlns="http://hpxmlonline.com/2014/6"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://hpxmlonline.com/2014/6 ../schemas/HPXML.xsd"
schemaVersion="2.2">
schemaVersion="2.3">
<XMLTransactionHeaderInformation>
<XMLType></XMLType>
<XMLGeneratedBy></XMLGeneratedBy>
Expand Down
6 changes: 3 additions & 3 deletions guide/source/software_developer/versioning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Versioning

The HPXML schemas follow the `Semantic Versioning v2.0 <http://semver.org/>`_
specification. The version numbers follow a pattern of :ref:`major-version`.
:ref:`minor-version`. :ref:`patch-version` (i.e. 2.2.0).
:ref:`minor-version`. :ref:`patch-version` (i.e. 2.3.0).

The first element of ``HPXML.xsd`` will indicate the version of the schema via
the ``version`` attribute. Note that when referencing a version, the patch
Expand All @@ -12,15 +12,15 @@ number is assumed to be zero if it is omitted.
.. code-block:: xml
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://hpxmlonline.com/2014/6"
targetNamespace="http://hpxmlonline.com/2014/6" elementFormDefault="qualified" version="2.2">
targetNamespace="http://hpxmlonline.com/2014/6" elementFormDefault="qualified" version="2.3">
Additionally, starting with version 2.0, the version of the schema used is
required in the ``schemaVersion`` attribute on the root element of every
document.

.. code-block:: xml
<HPXML xmlns="http://hpxmlonline.com/2014/6" schemaVersion="2.2">
<HPXML xmlns="http://hpxmlonline.com/2014/6" schemaVersion="2.3">
.. _major-version:

Expand Down
2 changes: 1 addition & 1 deletion schemas/BaseElements.xsd
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://hpxmlonline.com/2014/6"
targetNamespace="http://hpxmlonline.com/2014/6" elementFormDefault="qualified" version="2.2.1">
targetNamespace="http://hpxmlonline.com/2014/6" elementFormDefault="qualified" version="2.3">
<xs:include schemaLocation="HPXMLDataTypes.xsd"/>
<xs:element name="XMLTransactionHeaderInformation">
<xs:annotation>
Expand Down
2 changes: 1 addition & 1 deletion schemas/HPXML.xsd
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://hpxmlonline.com/2014/6"
targetNamespace="http://hpxmlonline.com/2014/6" elementFormDefault="qualified" version="2.2.1">
targetNamespace="http://hpxmlonline.com/2014/6" elementFormDefault="qualified" version="2.3">
<xs:include schemaLocation="BaseElements.xsd"/>


Expand Down
3 changes: 2 additions & 1 deletion schemas/HPXMLDataTypes.xsd
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://hpxmlonline.com/2014/6"
targetNamespace="http://hpxmlonline.com/2014/6" elementFormDefault="qualified" version="2.2.1">
targetNamespace="http://hpxmlonline.com/2014/6" elementFormDefault="qualified" version="2.3">
<!-- Value Lists -->
<!--Address Information Below-->
<xs:simpleType name="schemaVersionType">
Expand All @@ -9,6 +9,7 @@
<xs:enumeration value="2.1"/>
<xs:enumeration value="2.2"/>
<xs:enumeration value="2.2.1"/>
<xs:enumeration value="2.3"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="AddressTypeCode">
Expand Down

0 comments on commit 053e33d

Please sign in to comment.