From 2084532e630ce660a38920afa63549bdc774ac1c Mon Sep 17 00:00:00 2001 From: Dylan Page Date: Fri, 12 May 2023 13:54:34 -0400 Subject: [PATCH] docs(adr): move inital ADR out to new PR, clean up 0002 --- .../adr/0001-record-architecture-decisions.md | 20 ------------- docs/adr/0002-project-locks.md | 30 ++++++++++--------- 2 files changed, 16 insertions(+), 34 deletions(-) delete mode 100644 docs/adr/0001-record-architecture-decisions.md diff --git a/docs/adr/0001-record-architecture-decisions.md b/docs/adr/0001-record-architecture-decisions.md deleted file mode 100644 index d1d4c1a087..0000000000 --- a/docs/adr/0001-record-architecture-decisions.md +++ /dev/null @@ -1,20 +0,0 @@ -# 1. Record architecture decisions - -Date: 2023-05-09 - -## Status - -Accepted - -## Context - -We need to record the architectural decisions made for Atlantis. The project is a very decentralized project. It suffers from frequent one-timer contributors and ever changing team of maintainers. -By utilizing the ADR process, we can improve who decisions are made and bring transparency to past decisions to avoid future contributors and maintainers to confidently steer the project. - -## Decision - -We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions). - -## Consequences - -See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools) before submitting a new ADR. diff --git a/docs/adr/0002-project-locks.md b/docs/adr/0002-project-locks.md index 800e7b2c06..3634eb2bc7 100644 --- a/docs/adr/0002-project-locks.md +++ b/docs/adr/0002-project-locks.md @@ -1,7 +1,7 @@ -# ADR-001: Project Locks +# ADR-0002: Project Locks -- Date: 2023-04-18 +- Date: 2023-05-09 - Status: Draft ## Context and Problem Statement @@ -123,13 +123,15 @@ This is not to suggest the revival of these PRs in their current state but to ac ### Possible Solutions **Note**: Some of these solutions will purposely be contradictory to the ADR Goals or Non-Goals in an effort to flesh out alternatives and to assist in the decision-making process. - - ### Solution 1: Clone once + TF_DATA_DIR +**TO-DO**: flesh out + Take PR #2921 and re-implement locks on the DATA_DIR only for plans and the entire base repo + PR for git clones. -**TO-DO**: flesh out +#### Pros + - +#### Cons ### Solution 2: Clone once + move plans into state/backend @@ -149,12 +151,12 @@ TBD ## Links -https://github.com/runatlantis/atlantis/issues/1914 -https://github.com/runatlantis/atlantis/pull/2131 -https://github.com/runatlantis/atlantis/pull/2180 -https://github.com/runatlantis/atlantis/pull/2882 -https://github.com/runatlantis/atlantis/pull/2921 -https://developer.hashicorp.com/terraform/cli/config/environment-variables#tf_data_dir -https://github.com/runatlantis/atlantis/blob/main/server/events/models/models.go -https://github.com/runatlantis/atlantis/blob/main/server/events/working_dir.go -https://github.com/runatlantis/atlantis/blob/main/server/events/working_dir_locker.go +- https://github.com/runatlantis/atlantis/issues/1914 +- https://github.com/runatlantis/atlantis/pull/2131 +- https://github.com/runatlantis/atlantis/pull/2180 +- https://github.com/runatlantis/atlantis/pull/2882 +- https://github.com/runatlantis/atlantis/pull/2921 +- https://developer.hashicorp.com/terraform/cli/config/environment-variables#tf_data_dir +- https://github.com/runatlantis/atlantis/blob/main/server/events/models/models.go +- https://github.com/runatlantis/atlantis/blob/main/server/events/working_dir.go +- https://github.com/runatlantis/atlantis/blob/main/server/events/working_dir_locker.go