From d6dd235557fe2c94ff9ae8d799da54682105c976 Mon Sep 17 00:00:00 2001 From: Dylan Page Date: Mon, 18 Dec 2023 20:28:26 -0500 Subject: [PATCH 1/6] chore: add governance process to Atlantis --- GOVERNANCE.md | 115 +++++++++++++++++++++++++++++++++++++++++++++++++ MAINTAINERS.md | 2 +- USERS.md | 6 +++ 3 files changed, 122 insertions(+), 1 deletion(-) create mode 100644 GOVERNANCE.md create mode 100644 USERS.md diff --git a/GOVERNANCE.md b/GOVERNANCE.md new file mode 100644 index 0000000000..933740841f --- /dev/null +++ b/GOVERNANCE.md @@ -0,0 +1,115 @@ +# Atlantis Governance + +This document defines the project governance for Atlantis. + +## Overview + +**Atlantis** is committed to building an open, inclusive, productive and self-governing open source +community focused on building a high-quality infrastructure orchestration system. The +community is governed by this document with the goal of defining how community +should work together to achieve this goal. + +## Code Repositories + +The following code repositories are governed by Atlantis community and +maintained under the `runatlantis` organization. + +* **[atlantis](https://github.com/runatlantis/atlantis):** Main Atlantis codebase. +* **[atlantis-helm-charts](https://github.com/runatlantis/helm-charts):** Helm chart for easy deployment of Atlantis. +* **[atlantis-tests](https://github.com/runatlantis/atlantis):** A set of terraform projects that atlantis e2e tests run on. +* **[atlantis-example](https://github.com/runatlantis/atlantis):** A simple terraform project to use along with atlantis bootstrap mode. + +## Community Roles + +* **Users:** Members that engage with the Atlantis community via any medium (Slack, WeChat, GitHub, mailing lists, etc.). +* **Contributors:** Regular contributions to projects (documentation, code reviews, responding to issues, participation in proposal discussions, contributing code, etc.). +* **Core Contributors:** Contributors who drive certain subprojects within Atlantis. They are responsible for the direction and work done within that subproject, providing enhancements and support for the Atlantis project as a whole. Core Contributors are expected to contribute code and documentation, review PRs including ensuring quality of code, triage issues, proactively fix bugs, and perform maintenance tasks for the subprojects they are responsible for. +* **Maintainers:** The Atlantis project leaders. They are responsible for the overall health and direction of the project; final reviewers of PRs and responsible for releases. Some Maintainers are responsible for one or more components within a project, acting as technical leads for that component. Maintainers are expected to contribute code and documentation, review PRs including ensuring quality of code, triage issues, proactively fix bugs, and perform maintenance tasks for these components. + +### Maintainers + +New maintainers and subproject maintainers must be nominated by an existing maintainer and must be elected by a supermajority of existing maintainers. Likewise, maintainers can be removed by a supermajority of the existing maintainers or can resign by notifying one of the maintainers. + +### Supermajority + +A supermajority is defined as two-thirds of members in the group. +A supermajority of [Maintainers](#maintainers) is required for certain +decisions as outlined above. Voting on decisions can happen on the mailing list, GitHub, Slack, email, or via a voting service, when appropriate. Maintainers can either vote "agree, yes, +1", "disagree, no, -1", or "abstain". A vote passes when supermajority is met. An abstain vote equals not voting at all. + +### Decision Making + +Ideally, all project decisions are resolved by consensus. If impossible, any +maintainer may call a vote. Unless otherwise specified in this document, any +vote will be decided by a supermajority of maintainers. + +Votes by maintainers belonging to the same company +will count as one vote; e.g., 4 maintainers employed by fictional company **Fictiousum** will +only have **one** combined vote. If voting members from a given company do not +agree, the company's vote is determined by a supermajority of voters from that +company. If no supermajority is achieved, the company is considered to have +abstained. + +## Proposal Process + +One of the most important aspects in any open source community is the concept +of proposals. Large changes to the codebase and / or new features should be +preceded by a proposal as an ADR or GH issue in the main Atlantis repo. This process allows for all +members of the community to weigh in on the concept (including the technical +details), share their comments and ideas, and offer to help. It also ensures +that members are not duplicating work or inadvertently stepping on toes by +making large conflicting changes. + +The project roadmap is defined by accepted proposals. + +Proposals should cover the high-level objectives, use cases, and technical +recommendations on how to implement. In general, the community member(s) +interested in implementing the proposal should be either deeply engaged in the +proposal process or be an author of the proposal. + +The proposal should be documented as a separated markdown file pushed to the root of the +`docs/adr` folder in the [atlantis](https://github.com/runatlantis/atlantis) +repository via PR. The name of the file should follow the name pattern set by the ADR process `<####-short +meaningful words joined by '-'>.md`, e.g: +`0002-adr-proposal.md`. + +Use the [ADR Tools](https://github.com/npryce/adr-tools) and run `adr new ` + +### Proposal Lifecycle + +The proposal PR can be marked with different status labels to represent the +status of the proposal: + +* **New**: Proposal is just created. +* **Reviewing**: Proposal is under review and discussion. +* **Accepted**: Proposal is reviewed and accepted (either by consensus or vote). +* **Rejected**: Proposal is reviewed and rejected (either by consensus or vote). + +## Lazy Consensus + +To maintain velocity in a project as busy as Atlantis, the concept of [Lazy +Consensus](http://en.osswiki.info/concepts/lazy_consensus) is practiced. Ideas +and / or proposals should be shared by maintainers via +GitHub with the appropriate maintainer groups (e.g., +`@atlantis/all-maintainers`) tagged. Out of respect for other contributors, +major changes should also be accompanied by a ping on Slack or a note on the +Atlantis google mailing list as appropriate. Author(s) of proposal, Pull Requests, +issues, etc. will give a time period of no less than five (5) working days for +comment and remain cognizant of popular observed world holidays. + +Other maintainers may chime in and request additional time for review, but +should remain cognizant of blocking progress and abstain from delaying +progress unless absolutely needed. The expectation is that blocking progress +is accompanied by a guarantee to review and respond to the relevant action(s) +(proposals, PRs, issues, etc.) in short order. + +Lazy Consensus is practiced for all projects in the `runatlantis` org, including +the main project repository, community-driven sub-projects, and the community +repo that includes proposals and governing documents. + +Lazy consensus does _not_ apply to the process of: + +* Removal of maintainers from Atlantis + +## Updating Governance + +All substantive changes in Governance require a supermajority agreement by all maintainers. diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 7503792329..688de90946 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -5,4 +5,4 @@ The current Maintainers Group for the [Atlantis] Project consists of: | Dylan Page | [GenPage](https://github.com/GenPage) | Autodesk | Maintainer | | PePe Amengual | [jamengual](https://github.com/jamengual) | Slalom | Maintainer | | Rui Chen | [chenrui333](https://github.com/chenrui333) | Meetup | Maintainer | -| Ronak | [nitrocode](https://github.com/nitrocode) |RB Consulting LLC | Contributor, Reviewer | \ No newline at end of file +| Ronak | [nitrocode](https://github.com/nitrocode) | RB Consulting LLC | Core Contributor | \ No newline at end of file diff --git a/USERS.md b/USERS.md new file mode 100644 index 0000000000..70ebdfd2fb --- /dev/null +++ b/USERS.md @@ -0,0 +1,6 @@ +Who uses Atlantis? +As the Atlantis Community grows, we'd like to keep track of our users. Please send a PR with your organization name if you are using Atlantis. + +Currently, the following organizations are officially using Atlantis: + +1. Autodesk \ No newline at end of file From 71dbbba76471ab4798ffbbecc8368a66cdb69324 Mon Sep 17 00:00:00 2001 From: Dylan Page <dylan.page@autodesk.com> Date: Mon, 18 Dec 2023 20:40:16 -0500 Subject: [PATCH 2/6] docs: update release process and add backport steps --- CONTRIBUTING.md | 41 +++++++++++++++++++++++++++++------------ 1 file changed, 29 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 99e25fb0de..07d981f001 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -160,18 +160,35 @@ If you get an error about `pegomock` not being available, install it: go get github.com/petergtz/pegomock/... ``` +# Backporting Fixes + +Atlantis now uses a [cherry-pick-bot](https://github.com/googleapis/repo-automation-bots/tree/main/packages/cherry-pick-bot) from Google. The bot assists in maintaining changes across releases branches by easily cherry-picking changes via pull requests. + +Maintainers and Core Contributors can add a comment to a pull request: + +``` +/cherry-pick target-branch-name +``` + +target-branch-name is the branch to cherry-pick to. cherry-pick-bot will cherry-pick the merged commit to a new branch (created from the target branch) and open a new pull request to the target branch. + +The bot will immediately try to cherry-pick a merged PR. On unmerged pull request, it will not do anything immediately, but wait until merge. You can comment multiple times on a PR for multiple release branches. + +## Manual Backporting Fixes + +The bot will fail to cherry-pick if the feature branches' git history is not linear (merge commits instead of rebase). In that case, you will need to manually cherry-pick the squashed merged commit from main to the release branch + +1. Switch to the release branch intended for the fix. +1. Run `git cherry-pick <sha>` with the commit hash from the main branch. +1. Push the newly cherry-picked commit up to the remote release branch. + # Creating a New Release -1. Update version number in `main.go`. -1. Update image tag version in the [kustomize/bundle.yaml](kustomize/bundle.yaml). -1. Update `CHANGELOG.md` with latest release number and information (this URL might be useful: https://github.com/runatlantis/atlantis/compare/v0.3.5...main) -1. Create a pull request and merge to main -1. Check out main and fetch latest -1. Run `make release` - 1. If you get `signal: killed` errors, bump up your Docker resources to have more memory, e.g. 6 G.B. +1. (Major/Minor release only) Create a new release branch `release-x.y` 1. Go to https://github.com/runatlantis/atlantis/releases and click "Draft a new release" - 1. Prefix version with `v` + 1. Prefix version with `v` and increment based on last release. 1. The title of the release is the same as the tag (ex. v0.2.2) - 1. Fill in description by copying from the CHANGELOG just without the Downloads section - 1. Drag in binaries made with `make release` -1. Re-run main branch build to ensure tag gets pushed to Github: https://github.com/runatlantis/atlantis/pkgs/container/atlantis -1. Update the default version in `Chart.yaml` in [the official Helm chart](https://github.com/runatlantis/helm-charts/blob/main/charts/atlantis/values.yaml). + 1. Fill in description by clicking on the "Generate Release Notes" button. + 1. You may have to manually move around some commit titles as they are determined by PR labels (see .github/labeler.yml & .github/release.yml) + 1. (Latest Major/Minor branches only) Make sure the release is set as latest + 1. Don't set "latest release" for patches on older release branches. +1. Check and update the default version in `Chart.yaml` in [the official Helm chart](https://github.com/runatlantis/helm-charts/blob/main/charts/atlantis/values.yaml) as needed. From b90cb7a224d729de57f9045e9ba61b6c08aba814 Mon Sep 17 00:00:00 2001 From: Dylan Page <dylan.page@autodesk.com> Date: Mon, 18 Dec 2023 20:54:00 -0500 Subject: [PATCH 3/6] docs: tweaks --- GOVERNANCE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 933740841f..022c494652 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -16,12 +16,12 @@ maintained under the `runatlantis` organization. * **[atlantis](https://github.com/runatlantis/atlantis):** Main Atlantis codebase. * **[atlantis-helm-charts](https://github.com/runatlantis/helm-charts):** Helm chart for easy deployment of Atlantis. -* **[atlantis-tests](https://github.com/runatlantis/atlantis):** A set of terraform projects that atlantis e2e tests run on. -* **[atlantis-example](https://github.com/runatlantis/atlantis):** A simple terraform project to use along with atlantis bootstrap mode. +* **[atlantis-tests](https://github.com/runatlantis/atlantis-tests):** A set of terraform projects that atlantis e2e tests run on. +* **[atlantis-example](https://github.com/runatlantis/atlantis-example):** A simple terraform project to use along with atlantis bootstrap mode. ## Community Roles -* **Users:** Members that engage with the Atlantis community via any medium (Slack, WeChat, GitHub, mailing lists, etc.). +* **Users:** Members that engage with the Atlantis community via any medium (Slack, GitHub, mailing lists, etc.). * **Contributors:** Regular contributions to projects (documentation, code reviews, responding to issues, participation in proposal discussions, contributing code, etc.). * **Core Contributors:** Contributors who drive certain subprojects within Atlantis. They are responsible for the direction and work done within that subproject, providing enhancements and support for the Atlantis project as a whole. Core Contributors are expected to contribute code and documentation, review PRs including ensuring quality of code, triage issues, proactively fix bugs, and perform maintenance tasks for the subprojects they are responsible for. * **Maintainers:** The Atlantis project leaders. They are responsible for the overall health and direction of the project; final reviewers of PRs and responsible for releases. Some Maintainers are responsible for one or more components within a project, acting as technical leads for that component. Maintainers are expected to contribute code and documentation, review PRs including ensuring quality of code, triage issues, proactively fix bugs, and perform maintenance tasks for these components. From 85647953533b0be6c8320a7d33797270912a1488 Mon Sep 17 00:00:00 2001 From: Dylan Page <dylan.page@autodesk.com> Date: Tue, 19 Dec 2023 10:58:24 -0500 Subject: [PATCH 4/6] Update GOVERNANCE.md Co-authored-by: Rui Chen <rui@chenrui.dev> --- GOVERNANCE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 022c494652..e0118e24ea 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -52,7 +52,7 @@ abstained. ## Proposal Process One of the most important aspects in any open source community is the concept -of proposals. Large changes to the codebase and / or new features should be +of proposals. Large changes to the codebase and/or new features should be preceded by a proposal as an ADR or GH issue in the main Atlantis repo. This process allows for all members of the community to weigh in on the concept (including the technical details), share their comments and ideas, and offer to help. It also ensures From c6e36ad335c8b5e94f4a86f200b85c0a4634ece7 Mon Sep 17 00:00:00 2001 From: Dylan Page <dylan.page@autodesk.com> Date: Tue, 19 Dec 2023 10:59:05 -0500 Subject: [PATCH 5/6] Update GOVERNANCE.md Co-authored-by: Rui Chen <rui@chenrui.dev> --- GOVERNANCE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index e0118e24ea..3953be0df7 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -88,7 +88,7 @@ status of the proposal: To maintain velocity in a project as busy as Atlantis, the concept of [Lazy Consensus](http://en.osswiki.info/concepts/lazy_consensus) is practiced. Ideas -and / or proposals should be shared by maintainers via +and/or proposals should be shared by maintainers via GitHub with the appropriate maintainer groups (e.g., `@atlantis/all-maintainers`) tagged. Out of respect for other contributors, major changes should also be accompanied by a ping on Slack or a note on the From 6734f31208e33dc443d76c49fef2323c7b870d7c Mon Sep 17 00:00:00 2001 From: Dylan Page <dylan.page@autodesk.com> Date: Tue, 19 Dec 2023 11:04:17 -0500 Subject: [PATCH 6/6] docs: review suggestions --- GOVERNANCE.md | 3 ++- USERS.md | 6 ------ 2 files changed, 2 insertions(+), 7 deletions(-) delete mode 100644 USERS.md diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 3953be0df7..9b4454e111 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -91,7 +91,8 @@ Consensus](http://en.osswiki.info/concepts/lazy_consensus) is practiced. Ideas and/or proposals should be shared by maintainers via GitHub with the appropriate maintainer groups (e.g., `@atlantis/all-maintainers`) tagged. Out of respect for other contributors, -major changes should also be accompanied by a ping on Slack or a note on the +major changes should also be accompanied by a ping on Slack in the +[#contributors](https://atlantis-community.slack.com/archives/C04ES70Q6E8) channel or a note on the Atlantis google mailing list as appropriate. Author(s) of proposal, Pull Requests, issues, etc. will give a time period of no less than five (5) working days for comment and remain cognizant of popular observed world holidays. diff --git a/USERS.md b/USERS.md deleted file mode 100644 index 70ebdfd2fb..0000000000 --- a/USERS.md +++ /dev/null @@ -1,6 +0,0 @@ -Who uses Atlantis? -As the Atlantis Community grows, we'd like to keep track of our users. Please send a PR with your organization name if you are using Atlantis. - -Currently, the following organizations are officially using Atlantis: - -1. Autodesk \ No newline at end of file