Skip to content

Commit

Permalink
[skip ci] Context and decision in #847 ADR
Browse files Browse the repository at this point in the history
  • Loading branch information
aj-stein-gsa committed Nov 5, 2024
1 parent 506fd82 commit 4a662ba
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions documents/adr/0010-semantic-versions-only.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,16 @@ Accepted

## Context

What is the issue that we're seeing that is motivating this decision or change?
In the past, the FedRAMP Automation Team [the versioning methodology of the Spock Framework](https://spockframework.org/spock/docs/2.0/known_issues.html#_groovy_version_compatibility). Staff documented this versioning methodology in [ADR #2](https://github.com/GSA/fedramp-automation/blob/247f99a0e3a2cfa6b9e78dd7c18836cf008115b2/documents/adr/0002-git-release-version-strategy.md). In 2024, the FedRAMP Automation Team received significant positive feedback from the community to transition from this methodology to [Semantic Versioning](https://semver.org/) as part of its release strategy and updated [the automate.fedramp.gov website](https://automate.fedramp.gov/about/release/) accordingly. They also socialized with the community that this document, not the previous ADR and outdated developer documentation, is the canonical source for the release strategy and other documents.

This decision record is to document the following possible solutions and implications.

## Decision

What is the change that we're proposing and/or doing?
FedRAMP has decided to move forward completely with the Semantic Versioning transition and completely deprecate the Spock versioning approach.

1. FedRAMP will use Semantic Versioning, as is the preference of the community.
2. The official, normative release guidance for FedRAMP Automation data, documentation, and tools is the [release guidance on automate.fedramp.gov](https://automate.fedramp.gov/about/release/), not developer documentation in this repository.

## Consequences

Expand Down

0 comments on commit 4a662ba

Please sign in to comment.