diff options
author | Andrea Leopardi <an.leopardi@gmail.com> | 2017-11-22 22:09:05 +0100 |
---|---|---|
committer | Andrea Leopardi <an.leopardi@gmail.com> | 2017-11-22 22:09:05 +0100 |
commit | 9103d3fe38c6e7429c632e28b6f0ef961f9bb31e (patch) | |
tree | 5bce0370af5cc449434bfa576914fd1786aef30b | |
parent | a93bd4607733eddd4650d1e41d7ca49f4ea3fbd8 (diff) | |
download | elixir-al/otp-compat-table.tar.gz |
Fixes mentioned by @josevalimal/otp-compat-table
-rw-r--r-- | RELEASE.md | 24 | ||||
-rw-r--r-- | lib/elixir/pages/Compatibility and Deprecations.md | 6 |
2 files changed, 15 insertions, 15 deletions
diff --git a/RELEASE.md b/RELEASE.md index 538b5f3f2..a1b269b69 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -6,29 +6,29 @@ This document simply outlines the release process: 1. Ensure you are running on the oldest supported Erlang version -1. Remove all `-dev` extension from versions (see below for all files) +2. Remove all `-dev` extension from versions (see below for all files) -1. Ensure CHANGELOG is updated and add current date +3. Ensure CHANGELOG is updated and add current date -1. If a new `vMAJOR.MINOR`, replace "master" with "vVERSION" in the "Compatibility and Deprecations" page and commit +4. If a new `vMAJOR.MINOR`, replace "master" with "vVERSION" in the "Compatibility and Deprecations" page and commit -1. If a new `vMAJOR.MINOR`, create a new branch "vMAJOR.MINOR" and set `CANONICAL=` in Makefile +5. If a new `vMAJOR.MINOR`, create a new branch "vMAJOR.MINOR" and set `CANONICAL=` in Makefile -1. Add an entry for the new version to the OTP compatibility table in the "Compatibility and Deprecations" page +6. Add an entry for the new version to the OTP compatibility table in the "Compatibility and Deprecations" page -1. Commit changes above with title "Release vVERSION" and generate new tag +7. Commit changes above with title "Release vVERSION" and generate new tag -1. Run `make clean test` to ensure all tests pass from scratch and the CI is green +8. Run `make clean test` to ensure all tests pass from scratch and the CI is green -1. Recompile an existing project (for example, Ecto) to ensure manifests can be upgraded +9. Recompile an existing project (for example, Ecto) to ensure manifests can be upgraded -1. Push branch and the new tag +10. Push branch and the new tag -1. Publish new zips with `make zips`, upload `Precompiled.zip` and `Docs.zip` to GitHub Releases +11. Publish new zips with `make zips`, upload `Precompiled.zip` and `Docs.zip` to GitHub Releases -1. Add the release to `elixir.csv` and `_data/elixir-versions.yml` files in `elixir-lang/elixir-lang.github.com` +12. Add the release to `elixir.csv` and `_data/elixir-versions.yml` files in `elixir-lang/elixir-lang.github.com` -1. After a new `vMAJOR.MINOR`, move back to master, bump versions, start new CHANGELOG, add `-dev` back and commit "Start vMAJOR.MINOR+1" +13. After a new `vMAJOR.MINOR`, move back to master, bump versions, start new CHANGELOG, add `-dev` back and commit "Start vMAJOR.MINOR+1" ## Places where version is mentioned diff --git a/lib/elixir/pages/Compatibility and Deprecations.md b/lib/elixir/pages/Compatibility and Deprecations.md index ff01fdb88..cc1725fbf 100644 --- a/lib/elixir/pages/Compatibility and Deprecations.md +++ b/lib/elixir/pages/Compatibility and Deprecations.md @@ -16,7 +16,7 @@ v1.0.4 | 17 v1.0.5 | 17-18 v1.1.0 | 17-18 v1.1.1 | 17-18 -v1.2.0 | 18-18 +v1.2.0 | 18 v1.2.1 | 18 v1.2.2 | 18 v1.2.3 | 18 @@ -46,9 +46,9 @@ Elixir deprecations happen in 3 steps: 1. The feature is soft-deprecated. It means both CHANGELOG and documentation must list the feature as deprecated but no warning is effectively emitted by running the code. There is no requirement to soft-deprecate a feature. - 1. The feature is effectively deprecated by emitting warnings on usage. In order to deprecate a feature, the proposed alternative MUST exist for AT LEAST two versions. For example, `Enum.uniq/2` was soft-deprecated in favor of `Enum.uniq_by/2` in Elixir v1.1. This means a deprecation warning may only be emitted by Elixir v1.3 or later. + 2. The feature is effectively deprecated by emitting warnings on usage. In order to deprecate a feature, the proposed alternative MUST exist for AT LEAST two versions. For example, `Enum.uniq/2` was soft-deprecated in favor of `Enum.uniq_by/2` in Elixir v1.1. This means a deprecation warning may only be emitted by Elixir v1.3 or later. - 1. The feature is removed. This can only happen on major releases. This means deprecated features in Elixir v1.x shall only be removed by Elixir v2.x. + 3. The feature is removed. This can only happen on major releases. This means deprecated features in Elixir v1.x shall only be removed by Elixir v2.x. ### Table of deprecations |