diff --git a/Changes b/Changes index 674514d..4f68fdd 100644 --- a/Changes +++ b/Changes @@ -1,8 +1,8 @@ Revision history for Perl extension PGXN::Manager 0.32.1 - - Updated `doc/spec.txt` to v1.0.1, from it new home in - https://github.com/pgxn/pgxn-meta-spec. + - Converged inline links in `doc/spec.txt` to reference links for + slightly better legibility as plain text. - Fixed import quoted version warning with Perl 5.40. - Fixed validation of rsync URLs in the mirror editor. - Added Content Security Policy notes to the README to ensure that diff --git a/doc/spec.txt b/doc/spec.txt index 62918ca..cce6fd0 100644 --- a/doc/spec.txt +++ b/doc/spec.txt @@ -6,93 +6,91 @@ PGXN Meta Spec - The PGXN distribution metadata specification Version ======= -1.0.1 +1.0.0 Synopsis ======== -``` json -{ - "name": "pgTAP", - "abstract": "Unit testing for PostgreSQL", - "description": "pgTAP is a suite of database functions that make it easy to write TAP-emitting unit tests in psql scripts or xUnit-style test functions.", - "version": "0.2.5", - "maintainer": [ - "David E. Wheeler ", - "pgTAP List " - ], - "license": { - "PostgreSQL": "https://www.postgresql.org/about/licence" - }, - "prereqs": { - "runtime": { - "requires": { - "plpgsql": 0, - "PostgreSQL": "8.0.0" - }, - "recommends": { - "PostgreSQL": "8.4.0" - } - } - }, - "provides": { - "pgtap": { - "file": "sql/pgtap.sql", - "docfile": "doc/pgtap.mmd", - "version": "0.2.4", - "abstract": "Unit testing assertions for PostgreSQL" - }, - "schematap": { - "file": "sql/schematap.sql", - "docfile": "doc/schematap.mmd", - "version": "0.2.4", - "abstract": "Schema testing assertions for PostgreSQL" - } - }, - "resources": { - "homepage": "https://pgtap.org/", - "bugtracker": { - "web": "https://github.com/theory/pgtap/issues" - }, - "repository": { - "url": "https://github.com/theory/pgtap.git", - "web": "https://github.com/theory/pgtap", - "type": "git" + { + "name": "pgTAP", + "abstract": "Unit testing for PostgreSQL", + "description": "pgTAP is a suite of database functions that make it easy to write TAP-emitting unit tests in psql scripts or xUnit-style test functions.", + "version": "0.2.5", + "maintainer": [ + "David E. Wheeler ", + "pgTAP List " + ], + "license": { + "PostgreSQL": "https://www.postgresql.org/about/licence" + }, + "prereqs": { + "runtime": { + "requires": { + "plpgsql": 0, + "PostgreSQL": "8.0.0" + }, + "recommends": { + "PostgreSQL": "8.4.0" + } + } + }, + "provides": { + "pgtap": { + "file": "sql/pgtap.sql", + "docfile": "doc/pgtap.mmd", + "version": "0.2.4", + "abstract": "Unit testing assertions for PostgreSQL" + }, + "schematap": { + "file": "sql/schematap.sql", + "docfile": "doc/schematap.mmd", + "version": "0.2.4", + "abstract": "Schema testing assertions for PostgreSQL" + } + }, + "resources": { + "homepage": "https://pgtap.org/", + "bugtracker": { + "web": "https://github.com/theory/pgtap/issues" + }, + "repository": { + "url": "https://github.com/theory/pgtap.git", + "web": "https://github.com/theory/pgtap", + "type": "git" + } + }, + "generated_by": "David E. Wheeler", + "meta-spec": { + "version": "1.0.0", + "url": "https://pgxn.org/meta/spec.txt" + }, + "tags": [ + "testing", + "unit testing", + "tap", + "tddd", + "test driven database development" + ] } - }, - "generated_by": "David E. Wheeler", - "meta-spec": { - "version": "1.0.0", - "url": "https://pgxn.org/meta/spec.txt" - }, - "tags": [ - "testing", - "unit testing", - "tap", - "tddd", - "test driven database development" - ] -} -``` Description =========== This document describes version 1.0.0 of the PGXN distribution metadata -specification, also known as the "PGXN Meta Spec." It is formatted using the -[Github Flavored Markdown] variant of [Markdown], and the canonical copy may -always be found at [master.pgxn.org/meta/spec.txt]. A generated HTML-formatted -copy found at [pgxn.org/spec/] may also be considered canonical. +specification, also known as the “PGXN Meta Spec.” It is formatted using the +[MultiMarkdown] variant of [Markdown], and the canonical copy may always be +found at [master.pgxn.org/meta/spec.txt]. A generated HTML-formatted copy +found at [pgxn.org/spec/] may also be considered canonical. This document is stable. Any revisions to this specification for typo -corrections and prose clarifications may be issued as "PGXN Meta Spec -1.0.*x*". These revisions will never change semantics or add or remove +corrections and prose clarifications may be issued as “PGXN Meta Spec +1.0.*x*”. These revisions will never change semantics or add or remove specified behavior. Distribution metadata describe important properties of PGXN distributions. -Distribution building tools should create a metadata file in accordance -with this specification and include it with the distribution for use by -automated tools that index, examine, package, or install PGXN distributions. +Distribution building tools should create a metadata file in accordance with +this specification and include it with the distribution for use by automated +tools that index, examine, package, or install PGXN distributions. Terminology =========== @@ -107,18 +105,18 @@ distribution extension : A reusable library of code contained in a single file or within files referenced by the [`CREATE EXTENSION` statement]. Extensions usually - contain one or more PostgreSQL objects --- such as data types, functions, - and operators --- and are often referred to by the name of a primary - object that can be mapped to the file name. For example, one might refer - to `pgTAP` instead of `sql/pgtap.sql`. + contain one or more PostgreSQL objects — such as data types, functions, + and operators — and are often referred to by the name of a primary object + that can be mapped to the file name. For example, one might refer to + `pgTAP` instead of `sql/pgtap.sql`. consumer : Code that reads a metadata file, deserializes it into a data structure in memory, or interprets a data structure of metadata elements. producer -: Code that constructs a metadata data structure, serializes into a byte - stream and/or writes it to disk. +: Code that constructs a metadata data structure, serializes into a + bytestream and/or writes it to disk. must, should, may, etc. : These terms are interpreted as described in [IETF RFC 2119]. @@ -160,8 +158,8 @@ to a List of length 1. Map --- -A *Map* is an unordered collection of zero or more data elements ("values"), -indexed by associated [String](#String) elements ("keys"). The Map’s value +A *Map* is an unordered collection of zero or more data elements (“values”), +indexed by associated [String](#String) elements (“keys”). The Map’s value elements may be of mixed types. License String @@ -214,9 +212,9 @@ describes valid keys within the [Map](#Map). Any keys not described in this specification document (whether top-level or within compound data structures described herein) are considered *custom keys* -and **must** begin with an "x" or "X" and be followed by an underscore; i.e.l, +and **must** begin with an “x” or “X” and be followed by an underscore; i.e. they must match the pattern: `/\Ax_/i`. If a custom key refers to a compound -data structure, subkeys within it do not need an "x_" or "X_" prefix. +data structure, subkeys within it do not need an “x_” or “X_” prefix. Consumers of metadata may ignore any or all custom keys. All other keys not described herein are invalid and should be ignored by consumers. Producers @@ -246,9 +244,7 @@ Required Fields Example: -``` json -"abstract": "Unit testing for PostgreSQL" -``` + "abstract": "Unit testing for PostgreSQL" (Spec 1) [required] {[String](#String)} @@ -258,25 +254,19 @@ This is a short description of the purpose of the distribution. Examples: -```json -"maintainer": "David E. Wheeler " -``` + "maintainer": "David E. Wheeler " -```json -"maintainer": [ - "David E. Wheeler ", - "Josh Berkus " -] -``` + "maintainer": [ + "David E. Wheeler ", + "Josh Berkus " + ] (Spec 1) [required] {[List](#List) of one or more [Strings](#String)} This [List](#List) indicates the person(s) to contact concerning the distribution. The preferred form of the contact string is: -``` -contact-name -``` + contact-name This field provides a general contact list independent of other structured fields provided within the [resources](#resources) field, such as @@ -293,26 +283,18 @@ author. Examples: -```json -"license": { - "PostgreSQL": "https://www.postgresql.org/about/licence" -} -``` + "license": { + "PostgreSQL": "https://www.postgresql.org/about/licence" + } -```json -"license": { - "Perl 5": "https://dev.perl.org/licenses/", - "BSD": "https://www.opensource.org/licenses/bsd-license.html" -} -``` + "license": { + "Perl 5": "https://dev.perl.org/licenses/", + "BSD": "https://www.opensource.org/licenses/bsd-license.html" + } -``` json -"license": "perl_5" -``` + "license": "perl_5" -``` json -"license": [ "apache_2_0", "mozilla_1_0" ] -``` + "license": [ "apache_2_0", "mozilla_1_0" ] (Spec 1) [required] {[Map](#Map) or [List](#List) of one or more [License Strings](#License.String)} @@ -372,22 +354,20 @@ All other strings are invalid in the license [List](#List). Example: -``` json -"provides": { - "pgtap": { - "file": "sql/pgtap.sql", - "docfile": "doc/pgtap.mmd", - "version": "0.2.4", - "abstract": "Unit testing assertions for PostgreSQL" - }, - "schematap": { - "file": "sql/schematap.sql", - "docfile": "doc/schematap.mmd", - "version": "0.2.4", - "abstract": "Schema testing assertions for PostgreSQL" - } -} -``` + "provides": { + "pgtap": { + "file": "sql/pgtap.sql", + "docfile": "doc/pgtap.mmd", + "version": "0.2.4", + "abstract": "Unit testing assertions for PostgreSQL" + }, + "schematap": { + "file": "sql/schematap.sql", + "docfile": "doc/schematap.mmd", + "version": "0.2.4", + "abstract": "Schema testing assertions for PostgreSQL" + } + } (Spec 1) [required] {[Map](#Map) of [Terms](#Term)} @@ -399,30 +379,31 @@ The keys of `provides` are [Terms](#Term) that name the extensions found within the distribution. The values are [Maps](#Map) with the following subkeys: -* **file**: The value must contain a relative file path from the root of the - distribution to the file containing the extension. The path **must be** - specified with unix conventions. Required. +file +: The value must contain a relative file path from the root of the + distribution to the file containing the extension. The path **must + be** specified with unix conventions. Required. -* **version**: This field contains a [Version](#Version) for the extension. - All extensions must have versions. Required. +version +: This field contains a [Version](#Version) for the extension. All + extensions must have versions. Required. -* **abstract**: A short [String](#String) value describing the extension. - Optional. +abstract +: A short [String](#String) value describing the extension. Optional. -* **docfile**: The value must contain a relative file path from the root of - the distribution to the file containing documentation for the extension. - The path **must be** specified with unix conventions. Optional. +docfile +: The value must contain a relative file path from the root of the + distribution to the file containing documentation for the extension. The + path **must be** specified with unix conventions. Optional. ### meta-spec ### Example: -``` json -"meta-spec": { - "version": "1.0.0", - "url": "https://pgxn.org/meta/spec.txt" -} -``` + "meta-spec": { + "version": "1.0.0", + "url": "https://pgxn.org/meta/spec.txt" + } (Spec 1) [required] {[Map](#Map)} @@ -433,25 +414,25 @@ possible and abort further metadata processing if the meta-spec The following keys are valid, but only `version` is required. -* **version**: This subkey gives the integer [Version](#Version) of the PGXN - Meta Spec against which the document was generated. +version +: This subkey gives the integer [Version](#Version) of the PGXN Meta Spec + against which the document was generated. -* **url**: This is a [URI](#URI) of the metadata specification document - corresponding to the given version. This is strictly for human-consumption - and should not impact the interpretation of the document. +url +: This is a [URI](#URI) of the metadata specification document corresponding + to the given version. This is strictly for human-consumption and should + not impact the interpretation of the document. ### name ### Example: -``` json -"name": "pgTAP" -``` + "name": "pgTAP" (Spec 1) [required] {[Term](#Term)} This field is the name of the distribution. This is usually the same as the -name of the "main extension" in the distribution, but may be completely +name of the “main extension” in the distribution, but may be completely unrelated to the extensions within the distribution. This value will be used in the distribution file name on PGXN. @@ -459,9 +440,7 @@ in the distribution file name on PGXN. Example: -``` json -"version": "1.3.6" -``` + "version": "1.3.6" (Spec 1) [required] {[Version](#Version)} @@ -469,15 +448,13 @@ This field gives the version of the distribution to which the metadata structure refers. Its value must be a [Version](#Version). Optional Fields ---------------- +-------------- ### description ### Example: -``` json -"description": "pgTAP is a suite of database functions that make it easy to write TAP-emitting unit tests in psql scripts or xUnit-style test functions." -``` + "description": "pgTAP is a suite of database functions that make it easy to write TAP-emitting unit tests in psql scripts or xUnit-style test functions." (Spec 1) [optional] {[String](#String)} @@ -488,24 +465,20 @@ distribution than the one provided by the `abstract` key. Example: -``` json -"generated_by": "Module::Build::PGXN version 0.42" -``` + "generated_by": "Module::Build::PGXN version 0.42" (Spec 1) [optional] {[String](#String)} This field indicates the tool that was used to create this metadata. There are no defined semantics for this field, but it is traditional to use a string in -the form "Software package version 1.23" or the maintainer’s name, if the file +the form “Software package version 1.23” or the maintainer’s name, if the file was generated by hand. ### tags ### Example: -``` json -"tags": [ "testing", "unit testing", "tap" ] -``` + "tags": [ "testing", "unit testing", "tap" ] (Spec 1) [optional] {[List](#List) of [Tags](#Tag)} @@ -515,12 +488,10 @@ A [List](#List) of keywords that describe this distribution. Example: -``` json -"no_index": { - "file": [ "src/file.sql" ], - "directory": [ "src/private" ], -} -``` + "no_index": { + "file": [ "src/file.sql" ], + "directory": [ "src/private" ], + } (Spec 1) [optional] {[Map](#Map)} @@ -530,42 +501,42 @@ indexing or search tools. Valid subkeys are as follows: -* **file**: A [List](#List) of relative paths to files. Paths **must be** - specified with unix conventions. +file +: A [List](#List) of relative paths to files. Paths **must be** specified + with unix conventions. -* **directory**: A [List](#List) of relative paths to directories. Paths - **must be** specified with unix conventions. +directory +: A [List](#List) of relative paths to directories. Paths **must be** + specified with unix conventions. ### prereqs ### Example: -``` json -"prereqs": { - "runtime": { - "requires": { - "PostgreSQL": "8.0.0", - "PostGIS": "1.5.0" - }, - "recommends": { - "PostgreSQL": "8.4.0" - }, - "suggests": { - "sha1": 0 - } - }, - "build": { - "requires": { - "prefix": 0 - } - }, - "test": { - "recommends": { - "pgTAP": 0 + "prereqs": { + "runtime": { + "requires": { + "PostgreSQL": "8.0.0", + "PostGIS": "1.5.0" + }, + "recommends": { + "PostgreSQL": "8.4.0" + }, + "suggests": { + "sha1": 0 + } + }, + "build": { + "requires": { + "prefix": 0 + } + }, + "test": { + "recommends": { + "pgTAP": 0 + } + } } - } -} -``` (Spec 1) [optional] {[Map](#Map)} @@ -573,7 +544,7 @@ This is a [Map](#Map) that describes all the prerequisites of the distribution. The keys are phases of activity, such as `configure`, `build`, `test`, or `runtime`. Values are [Maps](#Map) in which the keys name the type of prerequisite relationship such as `requires`, `recommends`, `suggests`, or -`conflicts`, and the values provide sets of prerequisite relations. The sets +"conflicts", and the values provide sets of prerequisite relations. The sets of relations **must** be specified as a [Map](#Map) of extension names to [Version Ranges](#Version.Ranges). @@ -584,53 +555,51 @@ section. Example: -``` json -"release_status": "stable" -``` + "release_status": "stable" (Spec 1) [optional] {[String](#String)} This field specifies the release status of this distribution. It **must** have one of the following values: -* **stable**: Indicates an ordinary, "final" release that should be indexed - by PGXN. +stable +: Indicates an ordinary, “final” release that should be indexed by PGXN. -* **testing**: Indicates a "beta" release that is substantially complete, - but has an elevated risk of bugs and requires additional testing. The - distribution should not be installed over a stable release without an - explicit request or other confirmation from a user. This release status - may also be used for "release candidate" versions of a distribution. +testing +: Indicates a “beta” release that is substantially complete, but has an + elevated risk of bugs and requires additional testing. The distribution + should not be installed over a stable release without an explicit request + or other confirmation from a user. This release status may also be used + for “release candidate” versions of a distribution. -* **unstable**: Indicates an "alpha" release that is under active - development, but has been released for early feedback or testing and may - be missing features or may have serious bugs. The distribution should not - be installed over a stable release without an explicit request or other - confirmation from a user. +unstable +: Indicates an “alpha” release that is under active development, but has + been released for early feedback or testing and may be missing features or + may have serious bugs. The distribution should not be installed over a + stable release without an explicit request or other confirmation from a + user. Consumers **may** use this field to determine how to index the distribution for PGXN or other repositories. If this field is not present, consumers -**may** assume that the distribution status is "stable." +**may** assume that the distribution status is “stable.” ### resources ### Example: -``` json -"resources": { - "homepage": "https://pgxn.org/", - "bugtracker": { - "web": "https://github.com/theory/pgtap/issues", - "mailto": "pgxn-bugs@example.com" - }, - "repository": { - "url": "git://github.com/theory/pgtap.git", - "web": "https://github.com/theory/pgtap/", - "type": "git" - }, - "x_twitter": "https://twitter.com/pgtap/" -} -``` + "resources": { + "homepage": "https://pgxn.org/", + "bugtracker": { + "web": "https://github.com/theory/pgtap/issues", + "mailto": "pgxn-bugs@example.com" + }, + "repository": { + "url": "git://github.com/theory/pgtap.git", + "web": "https://github.com/theory/pgtap/", + "type": "git" + }, + "x_twitter": "https://twitter.com/pgtap/" + } (Spec 1) [optional] {[Map](#Map)} @@ -638,24 +607,31 @@ This field describes resources related to this distribution. Valid subkeys include: -* **homepage**: A [URI](#URI) for the official home of this project on the - web. - -* **bugtracker**: This entry describes the bug tracking system for this distribution. It is - a [Map](#Map) with the following valid keys: - - * **web**: a [URI](#uri) pointing to a web front-end for the bug - tracker - * **mailto**: an email address to which bug reports can be sent - -* **repository**: This entry describes the source control repository for this distribution. - It is a [Map](#Map) with the following valid keys: - - * **url**: a [URI](#uri) pointing to the repository itself - * **web**: a [URI](#uri) pointing to a web front-end for the repository - * **type**: a lowercase string indicating the VCS used - - Because a URI like `https://myrepo.example.com/` is ambiguous as to type, +homepage +: A [URI](#URI) for the official home of this project on the web. + +bugtracker +: This entry describes the bug tracking system for this distribution. It is + a [Map](#Map) with the following valid keys:
+
web
+

a URI pointing to a web front-end for the bug + tracker

+
mailto
+

an email address to which bug reports can be sent

+
+ +repository +: This entry describes the source control repository for this distribution. + It is a [Map](#Map) with the following valid keys:
+
url
+

a URI pointing to the repository itself

+
web
+

a URI pointing to a web front-end for the repository

+
type
+

a lowercase string indicating the VCS used

+
+ +: Because a URI like `https://myrepo.example.com/` is ambiguous as to type, producers should provide a `type` whenever a `url` key is given. The `type` field should be the name of the most common program used to work with the repository, e.g. git, svn, cvs, darcs, bzr or hg. @@ -670,12 +646,11 @@ This section defines the [Version](#Version) type, used by several fields in the PGXN Meta Spec. Version numbers must be treated as strings, and adhere to the [Semantic -Versioning 2.0.0 Specification][semver]. Semantic versions take a -dotted-integer format consisting of three positive integers separated by full -stop characters (i.e. "dots", "periods" or "decimal points"). A "pre-release -version" *may* be denoted by appending a dash followed by an arbitrary ASCII -string immediately following the patch version. Please see [the -specification][semver] for all details on the format. +Versioning Specification]. Semantic versions take a dotted-integer format +consisting of three positive integers separated by full stop characters (i.e. +“dots”, “periods” or “decimal points”). A “special version” *may* be denoted +by appending an arbitrary ASCII string immediately following the patch +version. Please see [the specification] for all details on the format. Version Ranges -------------- @@ -685,7 +660,7 @@ extension that may be required as a prerequisite. This section details the [Version Range](#Version.Range) type used to provide this information. The simplest format for a Version Range is just the version number itself, -e.g. `2.4.0`. This means that **at least** version 2.4.0 must be present. To +e.g. `2.4.0`. This means that **at least**version 2.4.0 must be present. To indicate that **any** version of a prerequisite is okay, even if the prerequisite doesn’t define a version at all, use the version `0`. @@ -713,15 +688,13 @@ and *Relationships* that indicate how prerequisites should be resolved. For example, to specify that `pgtap` is required during the `test` phase, this entry would appear in the distribution metadata: -``` json -"prereqs": { - "test": { - "requires": { - "pgtap": 0 + "prereqs": { + "test": { + "requires": { + "pgtap": 0 + } + } } - } -} -``` Note that the `prereqs` key may not be used to specify prerequisites distributed outside PGXN or the PostgreSQL core and its contrib extensions. @@ -748,25 +721,32 @@ phases. ----------------|--------------------------------- make install | runtime -* **configure**: The configure phase occurs before any dynamic configuration - has been attempted. Extensions required by the configure phase **must** be +
+ +configure +: The configure phase occurs before any dynamic configuration has been + attempted. Extensions required by the configure phase **must** be available for use before the distribution building tool has been executed. -* **build**: The build phase is when the distribution’s source code is - compiled (if necessary) and otherwise made ready for installation. +build +: The build phase is when the distribution’s source code is compiled (if + necessary) and otherwise made ready for installation. -* **test**: The test phase is when the distribution’s automated test suite - is run. Any extension needed only for testing and not for subsequent use - should be listed here. +test +: The test phase is when the distribution’s automated test suite is run. Any + extension needed only for testing and not for subsequent use should be + listed here. -* **runtime**: The runtime phase refers not only to when the distribution’s - contents are installed, but also to its continued use. Any extension that - is a prerequisite for regular use of this distribution should be indicated +runtime +: The runtime phase refers not only to when the distribution’s contents are + installed, but also to its continued use. Any extension that is a + prerequisite for regular use of this distribution should be indicated here. -* **develop**: The develop phase’s prereqs are extensions needed to work on - the distribution’s source code as its maintainer does. These tools might - be needed to build a release tarball, to run maintainer-only tests, or to +develop +: The develop phase’s prereqs are extensions needed to work on the + distribution’s source code as its maintainer does. These tools might be + needed to build a release tarball, to run maintainer-only tests, or to perform other tasks related to developing new versions of the distribution. @@ -785,6 +765,7 @@ suggests of the described distribution. conflicts + : These dependencies cannot be installed when the phase is in operation. This is a very rare situation, and the conflicts relationship should be used with great caution, or not at all. @@ -808,18 +789,18 @@ mappings: Extension | Version | Distribution ------------|---------|------------------ - pgtap | 0.25.0 | pgtap-0.25.0.zip - schematap | 0.25.0 | pgtap-0.25.0.zip - functap | 0.18.1 | pgtap-0.18.1.zip + pgtap | 0.25.0 | pgTAP-0.25.0.zip + schematap | 0.25.0 | pgTAP-0.25.0.zip + functap | 0.18.1 | pgTAP-0.18.1.zip -Note that functap was removed from the pgtap distribution sometime after -0.18.1. Consider the case where pgtap 0.25.0 is installed. If a distribution -specified "functap" as a prerequisite, it could result in -`pgtap-0.18.1.tar.gz` being installed, overwriting any files from -`pgtap-0.25.0.zip`. +Note that functap was removed from the pgTAP distribution sometime after +0.18.1. Consider the case where pgTAP 0.25.0 is installed. If a distribution +specified “functap” as a prerequisite, it could result in +`pgTAP-0.18.1.tar.gz` being installed, overwriting any files from +`pgTAP-0.25.0.zip`. Consumers of metadata **should** test whether prerequisites would result in -installed module files being "downgraded" to an older version and **may** warn +installed module files being “downgraded” to an older version and **may** warn users or ignore the prerequisite that would cause such a result. Serialization @@ -834,29 +815,27 @@ Notes For Implementors Comparing Version Numbers ------------------------- -Following the [Semantic Versioning 2.0.0 Spec][semver], version numbers -**must** be strictly compared by splitting the [Version](#Version) string on -full stop characters (i.e. "dots", "periods" or "decimal points") and -comparing each of the three parts as integers. If a dash and prerelease ASCII -string has been appended to the third number, it will be extracted and -compared in ASCII-betical order, and in any event will be considered to be -less than an un-encumbered third integer of the same value. Some examples: - -``` -0.12.1 < 0.12.2 -1.42.0 > 1.41.99 -2.0.0 > 1.999.999 -2.0.0alpha3 < 2.0.0beta1 -2.0.0beta < 2.0.0 -``` +Following the [Semantic Versioning Spec], version numbers **must** be strictly +compared by splitting the [Version](#Version) string on full stop characters +(i.e. “dots”, “periods” or “decimal points”) and comparing each of the three +parts as integers. If an ASCII string has been appended to the third number, +it will be extracted and compared in ASCII-betical order, and in any event +will be considered to be less than an un-encumbered third integer of the same +value. Some examples: + + 0.12.1 < 0.12.2 + 1.42.0 > 1.41.99 + 2.0.0 > 1.999.999 + 2.0.0alpha3 < 2.0.0beta1 + 2.0.0beta < 2.0.0 See Also ======== -* [CPAN Meta Spec] -* [PGXN] -* [JSON] -* [Semantic Versioning 2.0.0][semver] +* [CPAN Meta Spec](https://metacpan.org/pod/CPAN::Meta::Spec) +* [PGXN](https://www.pgxn.org/) +* [JSON](https://json.org/) +* [Semantic Versioning](https://semver.org/) Contributors ============