Added initial code for w3c recomendation
This commit is contained in:
parent
975146d983
commit
d5c3441235
12 changed files with 697 additions and 282 deletions
98
CHANGELOG.md
98
CHANGELOG.md
|
@ -1,99 +1,5 @@
|
|||
# Changelog
|
||||
|
||||
## 2.2.0
|
||||
## 3.0.0
|
||||
|
||||
* When a post has an `image_header` parameter this image is set as an attachment
|
||||
to ActivityPub posts
|
||||
* Fixed some poor CSS rendering for quote-box.
|
||||
* The `figure` shortcode will now make images clickable to see the full size.
|
||||
* The tags page now renders categories as the the title instead of the slug
|
||||
name.
|
||||
* Added additional argument to `example` shortcode to turn off the copy button.
|
||||
* Fixed pseudocode not rendering properly due to element `p` overflow setting.
|
||||
* Added the ability for the `git-heatmap` to combine activity from multiple
|
||||
sources.
|
||||
* Fixed `DEADLINE_EXCEEDED` error which occasionally occured when calling
|
||||
sendNote.
|
||||
* Fixed style for gitlab-heatmap partial to match overall theme.
|
||||
* Fixed `Uncaught ReferenceError: ga is not defined` error in web console.
|
||||
* Added W3C specification styling for writing W3C recomendations directly.
|
||||
|
||||
## 2.1.0
|
||||
|
||||
* Card shortcode will not longer render the horizontal rule when there is no
|
||||
bottom text to render.
|
||||
* Added several shortcodes and CSS for rendering info-fields, for example for
|
||||
contact info. See `info-entry.html`, `info-field.html`, `info-key.html` and
|
||||
`info-value.html` under the `/layouts/shortcodes/` directory.
|
||||
* Added the `container-split` short code which will split a container into two
|
||||
columns.
|
||||
* Removed significant portions of unused CSS to load quicker.
|
||||
* Improved responsive aspects of the CSS.
|
||||
* Several root settings in `/hugo.toml` were being overridden such as `paginate`
|
||||
these should now be fixed.
|
||||
* Fixed the CSS so the `navbar` wont overflow under very low resolutions.
|
||||
* Fixed certain text inside `<p>` tags overflowing and distorting the layout.
|
||||
* Updated CSS for `blockquote` and fonts to be more readable.
|
||||
* Added additional parameter to `tab` shortcode allowing the `copy` button to be
|
||||
hidden.
|
||||
|
||||
## 2.0.0
|
||||
|
||||
* Removed content folder and moved out the Fedipage site into a separate repo.
|
||||
This should make it easier for people who use this site to update from the
|
||||
upstream here without needing to worry about conflicts due to content.
|
||||
* Fixed links at the bottom of posts that direct people to the gitlab page for
|
||||
the post.
|
||||
* Card shortcodes no longer need to be linkable. By leaving the url argument as
|
||||
an empty string it will not render as a clickable link.
|
||||
* Fixed microblog submenu so it no longer extends past bottom of the page.
|
||||
* Made `/layout/top_list_generic` site generic, it no longer mentions Fedipage.
|
||||
* Made the `/layout/menu/html` dynamic so now there is no need to edit it when
|
||||
you customize sections.
|
||||
* Created type `page` and moved `/content/_index.md` to be that type. This
|
||||
breaks backwards compatibility therefore we must bump major version
|
||||
according to semantic versioning.
|
||||
* Minor improvement to CSS so `page` types dont get clipped by the menu header.
|
||||
* Added a container shortcode for use on `page` types to get left and right
|
||||
margins.
|
||||
* Adding new sections is now almost completely dynamic and requires much less
|
||||
modification of code. See updated `README.me`.
|
||||
* Added MathJax support for rendering Latex and math.
|
||||
* Added support for PseudocodeJS for rendering beautiful, standard, pseudocode.
|
||||
* Table of contents will now render if frontmatter `toc` is set to `true`.
|
||||
* Fixed a bug where backslashes in the summary of a post could break ActivityPub
|
||||
JSON endpoints.
|
||||
* Fixed the paginator next and previous links, they were assigned backwards.
|
||||
* Added a shortcode to render a GitLab based activity heatmap calander.
|
||||
* Added `cal-heatmap` support along with `D3.js` and several related extensions.
|
||||
* Opened up CORS headers since a static site shouldnt need any CORS protections.
|
||||
* Added a `quote-box` shortcode useful for displaying pretty quotes.
|
||||
* Improved the `tabs` shortcode so the title can be left off and it wont render
|
||||
a black empty square.
|
||||
|
||||
## 1.1.0
|
||||
|
||||
* Added the ability for Mastodon instances to find the associated post when
|
||||
searching for the link in the search bar.
|
||||
* Fixed bad id in `/followers` ActivityPub endpoint.
|
||||
* Created activity and status pages for each page independent from the outbox.
|
||||
* Added header link alternates specifying the dual mime type of pages.
|
||||
* In the comment section for a page if a user doesnt have a profile picture
|
||||
setup it will now default to a generic avatar rather than render text.
|
||||
* Removed image alt text when rendering page comments. If an image profile link
|
||||
was broken the rendered text would not look right.
|
||||
* The `activity` and `status` endpoints, when called with no extension, now
|
||||
return the correct `content-type` in header.
|
||||
* Fixed a bug where notifications of newly created posts would get resent
|
||||
periodically.
|
||||
* Now uses publication date set in post frontmatter when available otherwise
|
||||
will set the current date when sent out to followers.
|
||||
|
||||
## 1.0.1
|
||||
|
||||
* Summary text in ActivityPub Posts did not properly render new lines and other
|
||||
formatting. It should now render most basic formatting properly.
|
||||
|
||||
## 1.0.0
|
||||
|
||||
* Initial release
|
||||
* Initial release.
|
|
@ -1,7 +1,3 @@
|
|||
## Current Project Lead
|
||||
|
||||
* [Jeffrey Phillips Freeman](http://JeffreyFreeman.me) - Founder and maintainer of the project.
|
||||
|
||||
## Contributors
|
||||
|
||||
* [Paul Kinland](https://paul.kinlan.me) - Adapted and heavily modified some of his code.
|
||||
|
|
532
LICENSE
532
LICENSE
|
@ -1,201 +1,395 @@
|
|||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
Attribution 4.0 International
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
=======================================================================
|
||||
|
||||
1. Definitions.
|
||||
Creative Commons Corporation ("Creative Commons") is not a law firm and
|
||||
does not provide legal services or legal advice. Distribution of
|
||||
Creative Commons public licenses does not create a lawyer-client or
|
||||
other relationship. Creative Commons makes its licenses and related
|
||||
information available on an "as-is" basis. Creative Commons gives no
|
||||
warranties regarding its licenses, any material licensed under their
|
||||
terms and conditions, or any related information. Creative Commons
|
||||
disclaims all liability for damages resulting from their use to the
|
||||
fullest extent possible.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
Using Creative Commons Public Licenses
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
Creative Commons public licenses provide a standard set of terms and
|
||||
conditions that creators and other rights holders may use to share
|
||||
original works of authorship and other material subject to copyright
|
||||
and certain other rights specified in the public license below. The
|
||||
following considerations are for informational purposes only, are not
|
||||
exhaustive, and do not form part of our licenses.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
Considerations for licensors: Our public licenses are
|
||||
intended for use by those authorized to give the public
|
||||
permission to use material in ways otherwise restricted by
|
||||
copyright and certain other rights. Our licenses are
|
||||
irrevocable. Licensors should read and understand the terms
|
||||
and conditions of the license they choose before applying it.
|
||||
Licensors should also secure all rights necessary before
|
||||
applying our licenses so that the public can reuse the
|
||||
material as expected. Licensors should clearly mark any
|
||||
material not subject to the license. This includes other CC-
|
||||
licensed material, or material used under an exception or
|
||||
limitation to copyright. More considerations for licensors:
|
||||
wiki.creativecommons.org/Considerations_for_licensors
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
Considerations for the public: By using one of our public
|
||||
licenses, a licensor grants the public permission to use the
|
||||
licensed material under specified terms and conditions. If
|
||||
the licensor's permission is not necessary for any reason--for
|
||||
example, because of any applicable exception or limitation to
|
||||
copyright--then that use is not regulated by the license. Our
|
||||
licenses grant only permissions under copyright and certain
|
||||
other rights that a licensor has authority to grant. Use of
|
||||
the licensed material may still be restricted for other
|
||||
reasons, including because others have copyright or other
|
||||
rights in the material. A licensor may make special requests,
|
||||
such as asking that all changes be marked or described.
|
||||
Although not required by our licenses, you are encouraged to
|
||||
respect those requests where reasonable. More considerations
|
||||
for the public:
|
||||
wiki.creativecommons.org/Considerations_for_licensees
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
=======================================================================
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
Creative Commons Attribution 4.0 International Public License
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
By exercising the Licensed Rights (defined below), You accept and agree
|
||||
to be bound by the terms and conditions of this Creative Commons
|
||||
Attribution 4.0 International Public License ("Public License"). To the
|
||||
extent this Public License may be interpreted as a contract, You are
|
||||
granted the Licensed Rights in consideration of Your acceptance of
|
||||
these terms and conditions, and the Licensor grants You such rights in
|
||||
consideration of benefits the Licensor receives from making the
|
||||
Licensed Material available under these terms and conditions.
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
Section 1 -- Definitions.
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
a. Adapted Material means material subject to Copyright and Similar
|
||||
Rights that is derived from or based upon the Licensed Material
|
||||
and in which the Licensed Material is translated, altered,
|
||||
arranged, transformed, or otherwise modified in a manner requiring
|
||||
permission under the Copyright and Similar Rights held by the
|
||||
Licensor. For purposes of this Public License, where the Licensed
|
||||
Material is a musical work, performance, or sound recording,
|
||||
Adapted Material is always produced where the Licensed Material is
|
||||
synched in timed relation with a moving image.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
b. Adapter's License means the license You apply to Your Copyright
|
||||
and Similar Rights in Your contributions to Adapted Material in
|
||||
accordance with the terms and conditions of this Public License.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
c. Copyright and Similar Rights means copyright and/or similar rights
|
||||
closely related to copyright including, without limitation,
|
||||
performance, broadcast, sound recording, and Sui Generis Database
|
||||
Rights, without regard to how the rights are labeled or
|
||||
categorized. For purposes of this Public License, the rights
|
||||
specified in Section 2(b)(1)-(2) are not Copyright and Similar
|
||||
Rights.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
d. Effective Technological Measures means those measures that, in the
|
||||
absence of proper authority, may not be circumvented under laws
|
||||
fulfilling obligations under Article 11 of the WIPO Copyright
|
||||
Treaty adopted on December 20, 1996, and/or similar international
|
||||
agreements.
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
e. Exceptions and Limitations means fair use, fair dealing, and/or
|
||||
any other exception or limitation to Copyright and Similar Rights
|
||||
that applies to Your use of the Licensed Material.
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
f. Licensed Material means the artistic or literary work, database,
|
||||
or other material to which the Licensor applied this Public
|
||||
License.
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
g. Licensed Rights means the rights granted to You subject to the
|
||||
terms and conditions of this Public License, which are limited to
|
||||
all Copyright and Similar Rights that apply to Your use of the
|
||||
Licensed Material and that the Licensor has authority to license.
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
h. Licensor means the individual(s) or entity(ies) granting rights
|
||||
under this Public License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
i. Share means to provide material to the public by any means or
|
||||
process that requires permission under the Licensed Rights, such
|
||||
as reproduction, public display, public performance, distribution,
|
||||
dissemination, communication, or importation, and to make material
|
||||
available to the public including in ways that members of the
|
||||
public may access the material from a place and at a time
|
||||
individually chosen by them.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
j. Sui Generis Database Rights means rights other than copyright
|
||||
resulting from Directive 96/9/EC of the European Parliament and of
|
||||
the Council of 11 March 1996 on the legal protection of databases,
|
||||
as amended and/or succeeded, as well as other essentially
|
||||
equivalent rights anywhere in the world.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
k. You means the individual or entity exercising the Licensed Rights
|
||||
under this Public License. Your has a corresponding meaning.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
Section 2 -- Scope.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
a. License grant.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
1. Subject to the terms and conditions of this Public License,
|
||||
the Licensor hereby grants You a worldwide, royalty-free,
|
||||
non-sublicensable, non-exclusive, irrevocable license to
|
||||
exercise the Licensed Rights in the Licensed Material to:
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
a. reproduce and Share the Licensed Material, in whole or
|
||||
in part; and
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
b. produce, reproduce, and Share Adapted Material.
|
||||
|
||||
Copyright {yyyy} {name of copyright owner}
|
||||
2. Exceptions and Limitations. For the avoidance of doubt, where
|
||||
Exceptions and Limitations apply to Your use, this Public
|
||||
License does not apply, and You do not need to comply with
|
||||
its terms and conditions.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
3. Term. The term of this Public License is specified in Section
|
||||
6(a).
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
4. Media and formats; technical modifications allowed. The
|
||||
Licensor authorizes You to exercise the Licensed Rights in
|
||||
all media and formats whether now known or hereafter created,
|
||||
and to make technical modifications necessary to do so. The
|
||||
Licensor waives and/or agrees not to assert any right or
|
||||
authority to forbid You from making technical modifications
|
||||
necessary to exercise the Licensed Rights, including
|
||||
technical modifications necessary to circumvent Effective
|
||||
Technological Measures. For purposes of this Public License,
|
||||
simply making modifications authorized by this Section 2(a)
|
||||
(4) never produces Adapted Material.
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
5. Downstream recipients.
|
||||
|
||||
a. Offer from the Licensor -- Licensed Material. Every
|
||||
recipient of the Licensed Material automatically
|
||||
receives an offer from the Licensor to exercise the
|
||||
Licensed Rights under the terms and conditions of this
|
||||
Public License.
|
||||
|
||||
b. No downstream restrictions. You may not offer or impose
|
||||
any additional or different terms or conditions on, or
|
||||
apply any Effective Technological Measures to, the
|
||||
Licensed Material if doing so restricts exercise of the
|
||||
Licensed Rights by any recipient of the Licensed
|
||||
Material.
|
||||
|
||||
6. No endorsement. Nothing in this Public License constitutes or
|
||||
may be construed as permission to assert or imply that You
|
||||
are, or that Your use of the Licensed Material is, connected
|
||||
with, or sponsored, endorsed, or granted official status by,
|
||||
the Licensor or others designated to receive attribution as
|
||||
provided in Section 3(a)(1)(A)(i).
|
||||
|
||||
b. Other rights.
|
||||
|
||||
1. Moral rights, such as the right of integrity, are not
|
||||
licensed under this Public License, nor are publicity,
|
||||
privacy, and/or other similar personality rights; however, to
|
||||
the extent possible, the Licensor waives and/or agrees not to
|
||||
assert any such rights held by the Licensor to the limited
|
||||
extent necessary to allow You to exercise the Licensed
|
||||
Rights, but not otherwise.
|
||||
|
||||
2. Patent and trademark rights are not licensed under this
|
||||
Public License.
|
||||
|
||||
3. To the extent possible, the Licensor waives any right to
|
||||
collect royalties from You for the exercise of the Licensed
|
||||
Rights, whether directly or through a collecting society
|
||||
under any voluntary or waivable statutory or compulsory
|
||||
licensing scheme. In all other cases the Licensor expressly
|
||||
reserves any right to collect such royalties.
|
||||
|
||||
|
||||
Section 3 -- License Conditions.
|
||||
|
||||
Your exercise of the Licensed Rights is expressly made subject to the
|
||||
following conditions.
|
||||
|
||||
a. Attribution.
|
||||
|
||||
1. If You Share the Licensed Material (including in modified
|
||||
form), You must:
|
||||
|
||||
a. retain the following if it is supplied by the Licensor
|
||||
with the Licensed Material:
|
||||
|
||||
i. identification of the creator(s) of the Licensed
|
||||
Material and any others designated to receive
|
||||
attribution, in any reasonable manner requested by
|
||||
the Licensor (including by pseudonym if
|
||||
designated);
|
||||
|
||||
ii. a copyright notice;
|
||||
|
||||
iii. a notice that refers to this Public License;
|
||||
|
||||
iv. a notice that refers to the disclaimer of
|
||||
warranties;
|
||||
|
||||
v. a URI or hyperlink to the Licensed Material to the
|
||||
extent reasonably practicable;
|
||||
|
||||
b. indicate if You modified the Licensed Material and
|
||||
retain an indication of any previous modifications; and
|
||||
|
||||
c. indicate the Licensed Material is licensed under this
|
||||
Public License, and include the text of, or the URI or
|
||||
hyperlink to, this Public License.
|
||||
|
||||
2. You may satisfy the conditions in Section 3(a)(1) in any
|
||||
reasonable manner based on the medium, means, and context in
|
||||
which You Share the Licensed Material. For example, it may be
|
||||
reasonable to satisfy the conditions by providing a URI or
|
||||
hyperlink to a resource that includes the required
|
||||
information.
|
||||
|
||||
3. If requested by the Licensor, You must remove any of the
|
||||
information required by Section 3(a)(1)(A) to the extent
|
||||
reasonably practicable.
|
||||
|
||||
4. If You Share Adapted Material You produce, the Adapter's
|
||||
License You apply must not prevent recipients of the Adapted
|
||||
Material from complying with this Public License.
|
||||
|
||||
|
||||
Section 4 -- Sui Generis Database Rights.
|
||||
|
||||
Where the Licensed Rights include Sui Generis Database Rights that
|
||||
apply to Your use of the Licensed Material:
|
||||
|
||||
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
|
||||
to extract, reuse, reproduce, and Share all or a substantial
|
||||
portion of the contents of the database;
|
||||
|
||||
b. if You include all or a substantial portion of the database
|
||||
contents in a database in which You have Sui Generis Database
|
||||
Rights, then the database in which You have Sui Generis Database
|
||||
Rights (but not its individual contents) is Adapted Material; and
|
||||
|
||||
c. You must comply with the conditions in Section 3(a) if You Share
|
||||
all or a substantial portion of the contents of the database.
|
||||
|
||||
For the avoidance of doubt, this Section 4 supplements and does not
|
||||
replace Your obligations under this Public License where the Licensed
|
||||
Rights include other Copyright and Similar Rights.
|
||||
|
||||
|
||||
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
|
||||
|
||||
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
|
||||
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
|
||||
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
|
||||
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
|
||||
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
|
||||
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
|
||||
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
|
||||
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
|
||||
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
|
||||
|
||||
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
|
||||
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
|
||||
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
|
||||
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
|
||||
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
|
||||
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
|
||||
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
|
||||
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
|
||||
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
|
||||
|
||||
c. The disclaimer of warranties and limitation of liability provided
|
||||
above shall be interpreted in a manner that, to the extent
|
||||
possible, most closely approximates an absolute disclaimer and
|
||||
waiver of all liability.
|
||||
|
||||
|
||||
Section 6 -- Term and Termination.
|
||||
|
||||
a. This Public License applies for the term of the Copyright and
|
||||
Similar Rights licensed here. However, if You fail to comply with
|
||||
this Public License, then Your rights under this Public License
|
||||
terminate automatically.
|
||||
|
||||
b. Where Your right to use the Licensed Material has terminated under
|
||||
Section 6(a), it reinstates:
|
||||
|
||||
1. automatically as of the date the violation is cured, provided
|
||||
it is cured within 30 days of Your discovery of the
|
||||
violation; or
|
||||
|
||||
2. upon express reinstatement by the Licensor.
|
||||
|
||||
For the avoidance of doubt, this Section 6(b) does not affect any
|
||||
right the Licensor may have to seek remedies for Your violations
|
||||
of this Public License.
|
||||
|
||||
c. For the avoidance of doubt, the Licensor may also offer the
|
||||
Licensed Material under separate terms or conditions or stop
|
||||
distributing the Licensed Material at any time; however, doing so
|
||||
will not terminate this Public License.
|
||||
|
||||
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
|
||||
License.
|
||||
|
||||
|
||||
Section 7 -- Other Terms and Conditions.
|
||||
|
||||
a. The Licensor shall not be bound by any additional or different
|
||||
terms or conditions communicated by You unless expressly agreed.
|
||||
|
||||
b. Any arrangements, understandings, or agreements regarding the
|
||||
Licensed Material not stated herein are separate from and
|
||||
independent of the terms and conditions of this Public License.
|
||||
|
||||
|
||||
Section 8 -- Interpretation.
|
||||
|
||||
a. For the avoidance of doubt, this Public License does not, and
|
||||
shall not be interpreted to, reduce, limit, restrict, or impose
|
||||
conditions on any use of the Licensed Material that could lawfully
|
||||
be made without permission under this Public License.
|
||||
|
||||
b. To the extent possible, if any provision of this Public License is
|
||||
deemed unenforceable, it shall be automatically reformed to the
|
||||
minimum extent necessary to make it enforceable. If the provision
|
||||
cannot be reformed, it shall be severed from this Public License
|
||||
without affecting the enforceability of the remaining terms and
|
||||
conditions.
|
||||
|
||||
c. No term or condition of this Public License will be waived and no
|
||||
failure to comply consented to unless expressly agreed to by the
|
||||
Licensor.
|
||||
|
||||
d. Nothing in this Public License constitutes or may be interpreted
|
||||
as a limitation upon, or waiver of, any privileges and immunities
|
||||
that apply to the Licensor or You, including from the legal
|
||||
processes of any jurisdiction or authority.
|
||||
|
||||
|
||||
=======================================================================
|
||||
|
||||
Creative Commons is not a party to its public
|
||||
licenses. Notwithstanding, Creative Commons may elect to apply one of
|
||||
its public licenses to material it publishes and in those instances
|
||||
will be considered the “Licensor.” The text of the Creative Commons
|
||||
public licenses is dedicated to the public domain under the CC0 Public
|
||||
Domain Dedication. Except for the limited purpose of indicating that
|
||||
material is shared under a Creative Commons public license or as
|
||||
otherwise permitted by the Creative Commons policies published at
|
||||
creativecommons.org/policies, Creative Commons does not authorize the
|
||||
use of the trademark "Creative Commons" or any other trademark or logo
|
||||
of Creative Commons without its prior written consent including,
|
||||
without limitation, in connection with any unauthorized modifications
|
||||
to any of its public licenses or any other arrangements,
|
||||
understandings, or agreements concerning use of licensed material. For
|
||||
the avoidance of doubt, this paragraph does not form part of the
|
||||
public licenses.
|
||||
|
||||
Creative Commons may be contacted at creativecommons.org.
|
||||
|
|
13
NOTICE
13
NOTICE
|
@ -1,13 +0,0 @@
|
|||
Copyright (c) 2023 - present Jeffrey Phillips Freeman. and other contributors
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
30
content/_about.md
Normal file
30
content/_about.md
Normal file
|
@ -0,0 +1,30 @@
|
|||
---
|
||||
date: '2023-10-06T06:54:34'
|
||||
title: About
|
||||
draft: false
|
||||
type: page
|
||||
---
|
||||
|
||||
{{<container>}}
|
||||
In the world of software management there exists a dreaded place called "dependency hell." The bigger your system grows and the more packages you integrate into your software, the more likely you are to find yourself, one day, in this pit of despair.
|
||||
|
||||
In systems with many dependencies, releasing new package versions can quickly become a nightmare. If the dependency specifications are too tight, you are in danger of version lock (the inability to upgrade a package without having to release new versions of every dependent package). If dependencies are specified too loosely, you will inevitably be bitten by version promiscuity (assuming compatibility with more future versions than is reasonable). Dependency hell is where you are when version lock and/or version promiscuity prevent you from easily and safely moving your project forward.
|
||||
|
||||
As a solution to this problem, we propose a simple set of rules andrequirements that dictate how version numbers are assigned and incremented. These rules are based on but not necessarily limited to pre-existing widespread common practices in use in both closed and open-source software. This system has been adapted for any kind of artifact: api, GUI application, database schema, semantic ontologies, documentation, client libraries, and more. You communicate changes to the software with specific increments to your version number. Consider a version format of X.Y.Z (Major.Minor.Patch). Bug fixes that do not add new features increment the patch version, backward compatible additions, changes, and features increment the minor version, and backward incompatible changes increment the major version.
|
||||
|
||||
We call this system "Semantic Versioning." Under this scheme, version numbers and the way they change convey meaning about the underlying code and what has been modified from one version to the next.
|
||||
|
||||
> Philosophy: Documentation defines expected behavior
|
||||
{.is-info}
|
||||
|
||||
# Why Use Semantic Versioning?
|
||||
|
||||
This is not a new or revolutionary idea. In fact, you probably do somethingclose to this already. The problem is that "close" isn't good enough. Withoutcompliance to some sort of formal specification, version numbers areessentially useless for dependency management. By giving a name and cleardefinition to the above ideas, it becomes easy to communicate your intentionsto the users of your software. Once these intentions are clear, flexible (butnot too flexible) dependency specifications can finally be made.
|
||||
|
||||
A simple example will demonstrate how Semantic Versioning can make dependencyhell a thing of the past. Consider a library called "Firetruck." It requires aSemantically Versioned package named "Ladder." At the time that Firetruck iscreated, Ladder is at version 3.1.0. Since Firetruck uses some functionalitythat was first introduced in 3.1.0, you can safely specify the Ladderdependency as greater than or equal to 3.1.0 but less than 4.0.0. Now, whenLadder version 3.1.1 and 3.2.0 become available, you can release them to yourpackage management system and know that they will be compatible with existingdependent software.
|
||||
|
||||
As a responsible developer you will, of course, want to verify that anypackage upgrades function as advertised. The real world is a messy place;there's nothing we can do about that but be vigilant. What you can do is letSemantic Versioning provide you with a sane way to release and upgradepackages without having to roll new versions of dependent packages, saving youtime and hassle.
|
||||
|
||||
If all of this sounds desirable, all you need to do to start using SemanticVersioning is to declare that you are doing so and then follow the rules. Linkto this website from your README so others know the rules and can benefit from them.
|
||||
|
||||
{{</container>}}
|
33
content/_backus.md
Normal file
33
content/_backus.md
Normal file
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
date: '2023-10-06T06:54:34'
|
||||
title: Backus–Naur
|
||||
draft: false
|
||||
type: page
|
||||
---
|
||||
|
||||
{{<container>}}
|
||||
# Backus–Naur Form Grammar for Valid SemVer Versions
|
||||
|
||||
```
|
||||
<valid semver> ::= <version core> | <version core> "-" <pre-release> | <version core> "+" <build> | <version core> "-" <pre-release> "+" <build>
|
||||
<version core> ::= <major> "." <minor> "." <patch>
|
||||
<major> ::= <numeric identifier>
|
||||
<minor> ::= <numeric identifier>
|
||||
<patch> ::= <numeric identifier>
|
||||
<pre-release> ::= <dot-separated pre-release identifiers>
|
||||
<dot-separated pre-release identifiers> ::= <pre-release identifier> | <pre-release identifier> "." <dot-separated pre-release identifiers>
|
||||
<build> ::= <dot-separated build identifiers>
|
||||
<dot-separated build identifiers> ::= <build identifier> | <build identifier> "." <dot-separated build identifiers>
|
||||
<pre-release identifier> ::= <alphanumeric identifier> | <numeric identifier>
|
||||
<build identifier> ::= <alphanumeric identifier> | <digits>
|
||||
<alphanumeric identifier> ::= <non-digit> | <non-digit> <identifier characters> | <identifier characters> <non-digit> | <identifier characters> <non-digit> <identifier characters>
|
||||
<numeric identifier> ::= "0" | <positive digit> | <positive digit> <digits>
|
||||
<identifier characters> ::= <identifier character> | <identifier character> <identifier characters>
|
||||
<identifier character> ::= <digit> | <non-digit>
|
||||
<non-digit> ::= <letter> | "-"
|
||||
<digits> ::= <digit> | <digit> <digits>
|
||||
<digit> ::= "0" | <positive digit>
|
||||
<positive digit> ::= "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"
|
||||
<letter> ::= "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z"
|
||||
```
|
||||
{{</container>}}
|
71
content/_faq.md
Normal file
71
content/_faq.md
Normal file
|
@ -0,0 +1,71 @@
|
|||
---
|
||||
date: '2023-10-06T06:54:34'
|
||||
title: FAQ
|
||||
draft: false
|
||||
type: page
|
||||
---
|
||||
|
||||
{{<container>}}
|
||||
|
||||
## How should I deal with revisions in the 0.y.z initial development phase?
|
||||
|
||||
The simplest thing to do is start your initial development release at 0.1.0and then increment the minor version for each subsequent release.
|
||||
|
||||
## How do I know when to release 1.0.0?
|
||||
|
||||
If your software is being used in production, it should probably already be1.0.0. If you have a stable API on which users have come to depend, you shouldbe 1.0.0. If you're worrying a lot about backward compatibility, you shouldprobably already be 1.0.0.
|
||||
|
||||
## Doesn't this discourage rapid development and fast iteration?
|
||||
|
||||
Major version zero is all about rapid development. If you're changing the APIevery day you should either still be in version 0.y.z or on a separatedevelopment branch working on the next major version.
|
||||
|
||||
## If even the tiniest backward incompatible changes to the public API require a major version bump, won't I end up at version 42.0.0 very rapidly?
|
||||
|
||||
This is a question of responsible development and foresight. Incompatiblechanges should not be introduced lightly to software that has a lot ofdependent code. The cost that must be incurred to upgrade can be significant.Having to bump major versions to release incompatible changes means you'llthink through the impact of your changes, and evaluate the cost/benefit ratioinvolved.
|
||||
|
||||
## Documenting the entire public API is too much work!
|
||||
|
||||
It is your responsibility as a professional developer to properly documentsoftware that is intended for use by others. Managing software complexity is ahugely important part of keeping a project efficient, and that's hard to do ifnobody knows how to use your software, or what methods are safe to call. Inthe long run, Semantic Versioning, and the insistence on a well defined publicAPI can keep everyone and everything running smoothly.
|
||||
|
||||
## What do I do if I accidentally release a backward incompatible change as a minor version?
|
||||
|
||||
As soon as you realize that you've broken the Semantic Versioning spec, fixthe problem and release a new minor version that corrects the problem andrestores backward compatibility. Even under this circumstance, it isunacceptable to modify versioned releases. If it's appropriate,document the offending version and inform your users of the problem so thatthey are aware of the offending version.
|
||||
|
||||
## What should I do if I update my own dependencies without changing the public API?
|
||||
|
||||
That would be considered compatible since it does not affect the public API.Software that explicitly depends on the same dependencies as your packageshould have their own dependency specifications and the author will notice anyconflicts. Determining whether the change is a patch level or minor levelmodification depends on whether you updated your dependencies in order to fixa bug or introduce new functionality. We would usually expect additional codefor the latter instance, in which case it's obviously a minor level increment.
|
||||
|
||||
## What if I inadvertently alter the public API in a way that is not compliant with the version number change (i.e. the code incorrectly introduces a major breaking change in a patch release)?
|
||||
|
||||
Use your best judgment. If you have a huge audience that will be drasticallyimpacted by changing the behavior back to what the public API intended, thenit may be best to perform a major version release, even though the fix couldstrictly be considered a patch release. Remember, Semantic Versioning is allabout conveying meaning by how the version number changes. If these changesare important to your users, use the version number to inform them.
|
||||
|
||||
## How should I handle deprecating functionality?
|
||||
|
||||
Deprecating existing functionality is a normal part of software development andis often required to make forward progress. When you deprecate part of yourpublic API, you should do two things: (1) update your documentation to letusers know about the change, (2) issue a new minor release with the deprecationin place. Before you completely remove the functionality in a new major releasethere should be at least one minor release that contains the deprecation sothat users can smoothly transition to the new API.
|
||||
|
||||
## Does SemVer have a size limit on the version string?
|
||||
|
||||
No, but use good judgment. A 255 character version string is probably overkill,for example. Also, specific systems may impose their own limits on the size ofthe string.
|
||||
|
||||
## Is "v1.2.3" a semantic version?
|
||||
|
||||
No, "v1.2.3" is not a semantic version. However, prefixing a semantic versionwith a "v" is a common way (in English) to indicate it is a version number.Abbreviating "version" as "v" is often seen with version control. Example:`git tag v1.2.3 -m "Release version 1.2.3"`, in which case "v1.2.3" is a tagname and the semantic version is "1.2.3".
|
||||
|
||||
## Is there a suggested regular expression (RegEx) to check a SemVer string?
|
||||
|
||||
There are two. One with named groups for those systems that support them(PCRE [Perl Compatible Regular Expressions, i.e. Perl, PHP and R], Pythonand Go).
|
||||
|
||||
See: <https://regex101.com/r/Ly7O1x/3/>
|
||||
|
||||
```
|
||||
^(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-9]\d*)(?:-(?P<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+(?P<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
|
||||
```
|
||||
|
||||
And one with numbered capture groups instead (so cg1 = major, cg2 = minor,cg3 = patch, cg4 = prerelease and cg5 = buildmetadata) that is compatiblewith ECMA Script (JavaScript), PCRE (Perl Compatible Regular Expressions,i.e. Perl, PHP and R), Python and Go.
|
||||
|
||||
See: <https://regex101.com/r/vkijKf/1/>
|
||||
|
||||
```
|
||||
^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
|
||||
```
|
||||
{{</container>}}
|
136
content/_index.md
Normal file
136
content/_index.md
Normal file
|
@ -0,0 +1,136 @@
|
|||
---
|
||||
date: '2023-10-06T06:54:34'
|
||||
title: Semantic Versioning
|
||||
subtitle: v3.0.0, W3C Working Draft, 30 March 2024
|
||||
draft: false
|
||||
type: page
|
||||
w3c: unofficial_draft
|
||||
w3c_latest_version: https://semantic-versioning.org
|
||||
w3c_feedback: ["https://git.qoto.org/semantic-versioning/semantic-versioning/-/issues"]
|
||||
w3c_editors:
|
||||
"Jeffrey Phillips Freemam": "https://JeffreyFreeman.me"
|
||||
---
|
||||
|
||||
{{<container>}}
|
||||
|
||||
{{<w3c-header>}}
|
||||
|
||||
## Overview
|
||||
|
||||
Given a version number
|
||||
```
|
||||
MAJOR.MINOR.PATCH-EXTRA+META
|
||||
```
|
||||
, increment the:
|
||||
|
||||
1. *MAJOR* version when you make backwards incompatible changes
|
||||
1. *MINOR* version when you add functionality in a backward compatible manner
|
||||
1. *PATCH* version when you make backward compatible bug fixes
|
||||
1. *EXTRA* version when you make a new prerelease, or other extra versioning parameters
|
||||
|
||||
{{<note-box>}}
|
||||
EXTRA Has a natural ordering, specified below, may contain any alphanumeric characters, in addition to dots, and additional dashes
|
||||
{{</note-box>}}
|
||||
|
||||
{{<note-box>}}
|
||||
META metadata is non-ordered, this does not encrement
|
||||
{{</note-box>}}
|
||||
|
||||
|
||||
## Semantic Versioning Specification
|
||||
|
||||
The key words "*MUST*", "*MUST NOT*", "*REQUIRED*", "*SHALL*", "*SHALL NOT*", "*SHOULD*","*SHOULD NOT*", "*RECOMMENDED*", "*MAY*", and "*OPTIONAL*" in this document are to beinterpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
|
||||
|
||||
{{<algorithm>}}
|
||||
1. A normal version number *MUST* take the form `X.Y.Z` where `X`, `Y`, and `Z` are non-negative integers, and *MUST NOT* contain leading zeroes. `X` is the major version, `Y` is the minor version, and `Z` is the patch version. Each element *MUST* increase numerically.
|
||||
1. Once a versioned package has been released, the contents of that version *MUST NOT* be modified. Any modifications *MUST* be released as a new version.
|
||||
1. Major version zero `(0.y.z)` is for initial development. Anything *MAY* change at any time. The artifact *SHOULD NOT* be considered stable.
|
||||
1. Version `1.0.0` defines the artifact. The way in which the version number is incremented after this release is dependent on the type of software and how it changes.
|
||||
1. Patch version `Z` `(x.y.Z | x > 0)` *MUST* be incremented if only backward compatible bug fixes are introduced. A bug fix is defined as an internal change that fixes incorrect documented behavior or improves performance characteristics while adding no new functionality.
|
||||
1. Minor version `Y` `(x.Y.z | x > 0)` *MUST* be incremented if new, backward compatible functionality is introduced to the artifact. It *MUST* be incremented if any public functionality is marked as deprecated. It *MAY* be incremented if substantial new functionality or improvements are introduced within the private code. It MAY include patch level changes. Patch version *MUST* be reset to 0 when minor version is incremented.
|
||||
1. Major version `X` `(X.y.z | X > 0)` *MUST* be incremented if any backward incompatible changes are introduced to the artifact. It MAY also include minorand patch level changes. *Patch* and minor versions *MUST* be reset to 0 when major version is incremented.
|
||||
1. A pre-release version *MAY* be denoted by appending a hyphen and aseries of dot separated identifiers immediately following the patch version. Identifiers *MUST* comprise only ASCII alphanumerics and hyphens `[0-9A-Za-z-]`. Identifiers *MUST NOT* be empty. Numeric identifiers *MUST NOT* include leading zeroes. Pre-release versions have a lower precedence than the associated normal version. A pre-release version indicates that the version is unstable and might not satisfy the intended compatibility requirements as denoted by its associated normal version.
|
||||
1. Build metadata MAY be denoted by appending a plus sign and a series of dot separated identifiers immediately following the patch or pre-release version. Identifiers *MUST* comprise only ASCII alphanumerics and hyphens `[0-9A-Za-z-]`.Identifiers *MUST NOT* be empty. Build metadata *MUST* be ignored when determining version precedence. Thus two versions that differ only in the build metadata, have the same precedence.
|
||||
1. Precedence refers to how versions are compared to each other when ordered.
|
||||
1. Precedence *MUST* be calculated by separating the version into major, minor, patch and pre-release identifiers in that order (Build metadata does not figure into precedence).
|
||||
1. Precedence is determined by the first difference when comparing each of these identifiers from left to right as follows: Major, minor, and patch versions are always compared numerically.
|
||||
1. When major, minor, and patch are equal, a pre-release version has lower precedence than a normal version.
|
||||
1. Precedence for two pre-release versions with the same major, minor, and patch version *MUST* be determined by comparing each dot separated identifier from left to right until a difference is found as follows:
|
||||
1. Identifiers consisting of only digits are compared numerically.
|
||||
1. Identifiers with letters or hyphens are compared lexically in ASCII sort order.
|
||||
1. Numeric identifiers always have lower precedence than non-numeric identifiers.
|
||||
1. A larger set of pre-release fields has a higher precedence than a smaller set, if all of the preceding identifiers are equal.
|
||||
1. Select the subcategory below that best describes the artifact. They are ordered in descending priority, so pick the first category that matches your software type.
|
||||
{{</algorithm>}}
|
||||
|
||||
{{<example-box>}}
|
||||
Example versions without the optional EXTRA or META components:
|
||||
|
||||
`1.9.0`, `1.10.0`, `1.11.0`
|
||||
{{</example-box>}}
|
||||
|
||||
{{<example-box>}}
|
||||
Example versions utilizing the optional EXTRA component but without META:
|
||||
|
||||
`1.0.0-alpha`, `1.0.0-alpha.1`, `1.0.0-0.3.7`, `1.0.0-x.7.z.92`, `1.0.0-x-y-z`
|
||||
{{</example-box>}}
|
||||
|
||||
{{<example-box>}}
|
||||
Example versions utilizing the optional EXTRA and META components:
|
||||
|
||||
`1.0.0-alpha+001`, `1.0.0+20130313144700`, `1.0.0-beta+exp.sha.5114f85`, `1.0.0+21AF26D3117B344092BD`
|
||||
{{</example-box>}}
|
||||
|
||||
{{<example-box>}}
|
||||
Example version precedence:
|
||||
|
||||
`1.0.0-alpha` < `1.0.0-alpha.1` < `1.0.0-alpha.beta` < `1.0.0-beta` < `1.0.0-beta.2` < `1.0.0-beta.11` < `1.0.0-rc.1` < `1.0.0` < `2.0.0-alpha` < `2.0.0` < `2.1.0` < `2.1.1`
|
||||
{{</example-box>}}
|
||||
|
||||
## Dependent Artifact Versioning
|
||||
|
||||
## API Versioning
|
||||
|
||||
When, versioning software with a public API such as libraries, and web endpoints it must match the following criteria:
|
||||
|
||||
1. Software using Semantic Versioning *MUST* declare a public API. This API could be declared in the code itself or exist strictly in documentation.However it is done, it *SHOULD* be precise and comprehensive.
|
||||
|
||||
For any artifact of this type the meaning of incrementing the components of a version are as follows:
|
||||
|
||||
* *PATCH* - An internal fix to behavior contrary to the documented expected behavior for the publiv API, This should implement no changes to the public API signatures.
|
||||
* *MINOR* - If new functionality is added to the public API in a backwards compatible way, including new information in the return values.
|
||||
* *MAJOR* - Any change to the public API that breaks backwards incompatibility.
|
||||
|
||||
## Application Versioning
|
||||
|
||||
## Dataset Versioning
|
||||
|
||||
When, versioninng datasets which may have the schema versioned alongside or seperately. A dataset may include such things as a RDBMS database, a Semantic Web Knowledge Graph, or an XML file. Such Datasets must describe the following:
|
||||
|
||||
1. Public structured data for which access is being provided.
|
||||
|
||||
For any artifact of this type the meaning of incrementing the components of a version are as follows:
|
||||
|
||||
{{<advisement-box>}}
|
||||
Anytime the underlying schema expiernces an increase in any of its version'a parts the dataset must atleast increment its version corresponding part, or a more significant part.
|
||||
{{</advisement-box>}}
|
||||
|
||||
* *PATCH* - Additional rows / instances have been added to your dataset. This *MUST* also be increment when incremented on the shema.
|
||||
* *MINOR* - Additional, backwards compatible, information is provided about existing rows/individuals. This *MUST* increment when MINOR is incremented in the underlying schema.
|
||||
* *MAJOR* - Non-backwards compatible changes to the data or underlying schema. This *MUST* be incremented when MAJOR is incremented in the underlying schema.
|
||||
|
||||
## Schema Versioning
|
||||
|
||||
When, versioning schemas for reading or interacting with data sets, for example, RDBMS Schema, Semantic Web Ontologies, and XML Schemas. Such schemas must describe the following:
|
||||
|
||||
1. Public structred data that is being described describe.
|
||||
1. You are versioning the schema (for structuring datasets see above) independently of the dataset.
|
||||
1. You are versioning the schema and not the dataset.
|
||||
|
||||
For any artifact of this type the meaning of incrementing the components of a version are as follows:
|
||||
|
||||
* *PATCH* - Additional or improved validation, indexing, and other backwards compatible improvements that do not introduce new data. Also data's structure and typing is unchanged except for bugs contrary to the documented expected behavior.
|
||||
* *MINOR* - Additions only to the schema allowing access to new underlying data while not changing the structure of historic data.
|
||||
* *MAJOR* - Any changes to the structure of the data preventing bachwards-compatible access to historic data.
|
||||
|
||||
{{</container>}}
|
16
content/_license.md
Normal file
16
content/_license.md
Normal file
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
date: '2023-10-06T06:54:34'
|
||||
title: License
|
||||
draft: false
|
||||
type: page
|
||||
---
|
||||
|
||||
{{<container>}}
|
||||
Licensed under: [Creative Commons ― CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)
|
||||
|
||||
# About
|
||||
|
||||
The Semantic Versioning specification was originally authored by [TomPreston-Werner](https://tom.preston-werner.com), inventor of Gravatar andcofounder of GitHub.
|
||||
|
||||
If you'd like to leave feedback, please [open an issue onGitHub](https://github.com/semver/semver/issues).
|
||||
{{</container>}}
|
46
hugo.toml
Normal file
46
hugo.toml
Normal file
|
@ -0,0 +1,46 @@
|
|||
# The base url of the website. This should be all lowercase and end with a forward slash.
|
||||
baseurl = "https://semantic-versioning.org/"
|
||||
languageCode = "en-us"
|
||||
title = "Semantic Versioning Specification"
|
||||
|
||||
paginate = 20
|
||||
pygmentsCodeFences = true
|
||||
pygmentsCodeFencesGuessSyntax = true
|
||||
pygmentsStyle = "monokai"
|
||||
DefaultContentLanguage = "en"
|
||||
defaultContentLanguageInSubdir = false
|
||||
|
||||
# Author displayed on posts, the current template doesnt actually render this
|
||||
[author]
|
||||
name = "SemanticVersioning"
|
||||
email = "SemanticVersioning@semantic-versioning.org"
|
||||
|
||||
# Custom site variables used when rendering the template
|
||||
[params]
|
||||
siteName="Semantic Versioning"
|
||||
siteTagLine="The Semantic Versioning Specification."
|
||||
# Do not include the @
|
||||
twitterUser="SemanticVersioning"
|
||||
siteDescription="The Semantic Versioning Specification"
|
||||
# this is the user name of the ActivityPub account. It will be the first part of
|
||||
# your handle as @apUser@domain. Please use whatever capitalization styling you
|
||||
# want. It will be changed to lowercase for your handle itself. Only include
|
||||
# letters.
|
||||
apUser="SemanticVersioning"
|
||||
# This is where you run an alternative mastodon based account. This will be
|
||||
# setup to be an alias for this account.
|
||||
secondaryApHost="https://qoto.org"
|
||||
# This shouldnt include the @
|
||||
secondaryApUser="SemanticVersioning"
|
||||
# The repo use for the repo url button in the navigation menu and other places.
|
||||
# This can be any git repor that contains your project code, not the code for
|
||||
# this website usually but it can be.
|
||||
repoUrl="https://git.qoto.org/semantic-versioning/semantic-versioning"
|
||||
# The url to where the source code for this website will be.
|
||||
siteRepoUrl="https://git.qoto.org/semantic-versioning/semantic-versioning"
|
||||
# The email of the site's webmaster or whoever will receive comms
|
||||
siteEmail="the@jeffreyfreeman.me"
|
||||
postHashtags=["SemanticVersioning", "SemVer"]
|
||||
renderDefaultHashtags=true
|
||||
renderArticleHashtags=true
|
||||
gitlabHeatmapData=["https://corsproxy.io?https://gitlab.com/users/freemo/calendar.json", "https://git.qoto.org/users/freemo/calendar.json"]
|
Binary file not shown.
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 6.2 KiB |
Binary file not shown.
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 6.2 KiB |
Loading…
Add table
Reference in a new issue