-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Atlantis 1.0.0 blog post #5296
Draft
lukemassa
wants to merge
5
commits into
runatlantis:main
Choose a base branch
from
lukemassa:atlantis_1_0_blog_post
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
title: Introducing Atlantis 1.0.0! | ||
lang: en-US | ||
--- | ||
|
||
# Atlantis 1.0.0 | ||
|
||
The core team is excited to announce the release of Atlantis 1.0.0! This release is many years in the making, and we're excited to be bringing Atlantis into this next chapter. | ||
|
||
## Questions | ||
|
||
### Why now? | ||
|
||
Atlantis has reached level of maturity, both as a product as well as a project, that justifies the designation that comes with a stable 1.0.0 release. | ||
|
||
One technical issue that this release solves is that, right now, when the Atlantis team publishes a new feature release by incrementing from `0.X.Y` to `0.{X+1}.0`, it is impossible to tell if there are breaking changes in the release without reading the release notes. In a post-1.0.0 world, breaking changes will always be accompanied by a bump in the major version (see below), hence the version number will encode more meaning. | ||
|
||
### What should we expect from this release? | ||
|
||
We don't expect 1.0.0 to be any different than any of our "minor" releases starting with `0`. It is primarily an indication that we believe the product is stable enough to warrant 1.0.0 release, and to show our commitment to both stability and backwards compatibility. | ||
|
||
### Will there be do an Atlantis 2.0.0? | ||
|
||
There are no immediate plans to release Atlantis 2.0.0, nor do we think it will never happen. We are roughly following semver guidelines described [here](https://semver.org/), which note that the major version should be incremented if "backward incompatible changes are introduced to the public API". (TODO: What does that mean for Atlantis?). If that ever happens, we reserve the right to release Atlantis 2.0.0. | ||
|
||
### How will we decide whether to increment major, minor, or patch for a given release? | ||
|
||
We are roughly guided by the recommendations [here](https://semver.org/), which roughly say that bug fixes go in patch releases, feature changes go in minor releases, and backwards incompatible changes go in major releases. | ||
|
||
As mentioned above, right now backwards incompatible changes are included together with "normal" releases. As we get experience separating these, we will develop a more clear understanding of what it means for a change to be backwards incompatible. For now here are a few guidelines: | ||
- Changes to server or repo config such that previously specified valid flag and configuration immediately fail | ||
- Changes to behavior like when applies and plans are run, except when gated by a new flag or setting | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Once v1.0.0 is released, any breaking changes to the Atlantis server configuration parameters, server-side repo config or API should trigger a major version bump.