Merge pull request #176 from bluca/version

Add versioning to specs

Author: brauner

README.md

@@ -42,6 +42,22 @@ BookToC: false
 
 See [open PRs on github](https://github.com/uapi-group/specifications/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc).
 
+## License
+
+All specifications are licensed under [CC-BY-4.0](https://spdx.org/licenses/CC-BY-4.0.html).
+
+## Versioning
+
+All specifications are versioned.
+
+The versioning format is MAJOR.MINOR.
+Compatible changes increment the MINOR version.
+Incompatible changes increment the MAJOR version and reset the MINOR version to `0`.
+
+Work in progress specifications have a MAJOR version of `0`.
+
+A `filename/MAJOR.MINOR` git tag will be created when a new version of a given spec is released.
+
 ## Glossary
 
 This section clarifies on terms and abbreviations used in specs and other documents.

specs/boot_loader_specification.md

@@ -8,6 +8,10 @@ SPDX-License-Identifier: CC-BY-4.0
 
 # The Boot Loader Specification
 
+| Version | Changes |
+|---------|---------|
+| 1.0     | Initial Release |
+
 This document defines a set of file formats and naming conventions that allow
 the boot loader menu entries to be shared between multiple operating systems
 and boot loaders installed on one device.

specs/configuration_files_specification.md

@@ -6,6 +6,10 @@ version: 1
 
 # Configuration Files Specification
 
+| Version | Changes |
+|---------|---------|
+| 1.0     | Initial Release |
+
 ## Introduction
 
 Various specifications attempt to define configuration files and file formats. This

specs/discoverable_disk_image.md

@@ -7,6 +7,10 @@ SPDX-License-Identifier: CC-BY-4.0
 ---
 # Discoverable Disk Image (DDI)
 
+| Version | Changes |
+|---------|---------|
+| 1.0     | Initial Release |
+
 DDIs (Discoverable Disk Images) are self-describing file system images that follow the DPS ([Discoverable
 Partitions Specification](discoverable_partitions_specification.md)), wrapped in a GPT partition table, that
 may contain root (or `/usr/`) filesystems for bootable OS images, system extensions, configuration

specs/discoverable_partitions_specification.md

@@ -7,6 +7,10 @@ SPDX-License-Identifier: CC-BY-4.0
 ---
 # The Discoverable Partitions Specification (DPS)
 
+| Version | Changes |
+|---------|---------|
+| 1.0     | Initial Release |
+
 _TL;DR: Let's automatically discover, mount and enable the root partition,
 `/home/`, `/srv/`, `/var/` and `/var/tmp/` and the swap partitions based on
 GUID Partition Tables (GPT)!_

specs/extension_image.md

@@ -6,6 +6,11 @@ version: 2
 SPDX-License-Identifier: CC-BY-4.0
 ---
 # Extension Images
+
+| Version | Changes |
+|---------|---------|
+| 1.0     | Initial Release |
+
 Extension Images are DDIs ([Discoverable Disk Images](discoverable_disk_image.md)) that are
 built to extend a base system via an overlay. A base system or a root DDI can be extended by several extension
 DDIs via, usually, a read-only OverlayFS. The defining characteristic of an Extension Image is that it contains

specs/file_hierarchy_for_the_verification_of_os_artifacts.md

@@ -8,6 +8,10 @@ SPDX-License-Identifier: CC-BY-4.0
 
 # File Hierarchy for the Verification of OS Artifacts (VOA)
 
+| Version | Changes |
+|---------|---------|
+| 0.1     | Work in progress |
+
 ## Motivation
 
 Cryptographic validation of artifacts with the help of digital signatures is a use-case of most Linux distributions.

specs/linux_file_system_hierarchy.md

@@ -8,6 +8,10 @@ SPDX-License-Identifier: CC-BY-4.0
 
 # Linux File System Hierarchy
 
+| Version | Changes |
+|---------|---------|
+| 0.1     | Work in progress |
+
 ## Description
 
 This page describes the layout of a modern Linux system.

specs/linux_tpm_pcr_registry.md

@@ -6,6 +6,10 @@ SPDX-License-Identifier: CC0-1.0
 
 # 🔏 Linux TPM PCR Registry 🗒️
 
+| Version | Changes |
+|---------|---------|
+| 1.0     | Initial Release |
+
 _TPM PCRs are a scarce resource, there are only 24 of them in typical standards compliant TPMs.
 According to the
 [TCG PC Client Specific Platform Firmware Profile Specification | Trusted Computing Group](https://trustedcomputinggroup.org/resource/pc-client-specific-platform-firmware-profile-specification/)

specs/unified_kernel_image.md

@@ -7,6 +7,10 @@ SPDX-License-Identifier: CC-BY-4.0
 ---
 # Unified Kernel Image (UKI)
 
+| Version | Changes |
+|---------|---------|
+| 1.0     | Initial Release |
+
 A Unified Kernel Image (UKI) is a combination of an UEFI boot stub program,
 a Linux kernel image, an optional initrd, and further resources in a single UEFI PE file.
 This file can either be directly invoked by the UEFI firmware