This is a proof-of-concept platform undergoing development and testing. No official releases are currently distributed through this website!

.adp.yaml specification document

This document provides a canonical reference to the layout and intended use of the .adp.yaml metadata file for artifacts released using ADP.

Definitions

The following definitions describe the keywords in the .adp.yaml metadata file:

  • data type: This is the type of data as it pertains to YAML data types, such as string, integer, dictionary, or list.
  • syntax: If specified, denotes how a value must be represented in the metadata file.
  • mandatory: If true, promotion of an artifact from release candidate to official release cannot happen if this field is not filled out.
  • immutable: If true, the value cannot be changed once it has initially been set. If a value has not yet been set, it can be set once.
  • reserved: If true, this keyword is reserved (and will be automatically filled out) by the ADP platform and cannot be set or changed by a user.

Currently established keywords

uploaded
Data Type: string
Syntax: YYYY-MM-DDTHH:mm:SSZ (ISO 8601)
Mandatory: true
Immutable:: true
Reserved: true
Example Value: 2022-12-01T12:58:42Z

This element signifies when the original artifact was uploaded by the release manager for testing and voting purposes. It is automatically filled out by the ADP master when uploading.

uploaded_by
Data Type: string
Mandatory: true
Immutable:: true
Reserved: true
Example Value: humbedooh

This element signifies who originally uploaded the artifact for testing/voting; usually it is the release manager's ID. It is automatically filled out by the ADP master when uploading, and corresponds to the LDAP user ID of the committer performing the action.

released
Data Type: string
Syntax: YYYY-MM-DDTHH:mm:SSZ (ISO 8601)
Mandatory: true
Immutable:: true
Reserved: true
Example Value: 2022-12-01T12:58:42Z

This element signifies when the artifact was promoted to official release by the release manager. It is automatically filled out by the ADP master when the artifact is promoted.

released_by
Data Type: string
Mandatory: true
Immutable:: true
Reserved: true
Example Value: humbedooh

This element signifies who promoted the artifact to official release; it is usually the release manager's ID (though it may not be the same user as the one who uploaded it). It is automatically filled out by the ADP master when uploading, and corresponds to the LDAP user ID of the committer performing the action.

description
Data Type: string
Mandatory: false
Immutable:: false
Reserved: false
Example Value: Apache Tomcat 11.0.0-M1

This is the description, or common name, of the artifact. This should typically be the full, official name of the release, and may include the target platform if applicable. If set, this value is used for the detailed artifact overview in the directory listing on the download pages. If left out, ADP will use the artifact's filename instead.

notes
Data Type: string
Mandatory: false
Immutable:: false
Reserved: false
Example Value: Users of Tomcat 11 onwards should be aware that, as a result of the move from Java EE to Jakarta EE as part of the transfer of Java EE to the Eclipse Foundation, the primary package for all implemented APIs has changed from javax.* to jakarta.*. This will almost certainly require code changes to enable applications to migrate from Tomcat 9 and earlier to Tomcat 11 and later. A migration tool has been developed to aid this process.

This field is intended for detailed notes pertaining to this release, such as general compatibility issues and upgrade notes. Markdown can be used here. The field is optional.

links
Data Type: dictionary
Syntax: https://link-here: Description of link
Mandatory: false
Immutable:: false
Reserved: false
Example Value: https://lists.apache.org/thread/dydxj28f000dj3n0byjwnm52tvpfh5m3: Release vote https://lists.apache.org/thread/nw39v9brmk700scxxtr4mtf8tngd18gj: Release Announcement https://tomcat.apache.org/tomcat-11.0-doc/changelog.html: Changelog for 11.0.0-M1

This field contains any links the project wishes to make available to the users on the download page. It may contain links to the release vote email (via lists.apache.org, etc.), the changelog file, or other news or informational pages pertaining to this release.