e4s-policies

The e4s-policies repository contains a versioned archive of e4s policy documentation (e.g. e4s-policies-1.0.yaml). The format of these policy files is described below. A policy file contains all information necessary to generate a markdown, html or other human readable policy document. It can also be referenced by tools that evaluate products' e4s policy compatability documents.

An example e4s policy compatability document, e4s-policy-compatability-1.0.yaml, is included in this repository. Products can provide their own compatability document (typcially in the .e4s directory at the root of their repository) or a status of 'unreported' will be assigned to all policies for that product. In combination with the centralized e4s policy document e4s policy compatability documents can be used to generate policy compatability summaries for individual products or product groups.

Version 0.01 of the e4s policies yaml format uses the following structure:

#The version of the e4s policies contained in this file
e4s_policy_version: 1
#The version of the format used by this file
e4s_policy_format_version: 0.01
#A list of sub-groups of policies. As of this writing only the 'Official' policy group is relevant to E4S community compatability. Others are included for reference.
policy_groups:
  #An object defining a group of policies
  - Official:
      #The title or short description associated with these policies in the official policy document.
      title: The policies below are criteria for E4S membership
      #The 'preamble' or detailed description associated with these policies in the official policy document
      preamble: >
        To qualify for E4S
        membership, a package must demonstrate compatability with each of these
        policies. Under special circumstances, a package may be granted an
        exception to a policy.
      #The policy type tag used in conjunction with the id when listing individual policies in the official policy document
      Tag: P
      #The list of individual policies.
      policies:
        #The policy id, equivalent to its order in its group in the official policy document
        - id: 1
          #The name of the policy
          name: Spack-based Build and Installation
          #The full description of the policy
          description: >
            Each E4S member package supports a scriptable Spack build and
            production-quality installation in a way that is compatible with
            other E4S member packages in the same environment. When E4S build,
            test, or installation issues arise, there is an expectation that
            teams will collaboratively resolve those is