about summary refs log tree commit diff
path: root/config.example.toml
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2023-10-02 07:41:52 +0000
committerbors <bors@rust-lang.org>2023-10-02 07:41:52 +0000
commit781ebbec8a0a2fdba7ea8113e09e21e972448d66 (patch)
treea032e307404aa3640b7b212c928df9f3d7b54dc5 /config.example.toml
parent15783292e5e26336f76ddc2123d66025ec6d84b7 (diff)
parent7d3dcd918eb1f1308a1d901821ede3041d563ae9 (diff)
downloadrust-781ebbec8a0a2fdba7ea8113e09e21e972448d66.tar.gz
rust-781ebbec8a0a2fdba7ea8113e09e21e972448d66.zip
Auto merge of #115898 - onur-ozkan:config-change-tracking, r=Mark-Simulacrum
bootstrap major change detection implementation

The use of `changelog-seen` and `bootstrap/CHANGELOG.md` has not been functional in any way for many years. We often do major/breaking changes but never update the changelog file or the `changelog-seen`. This is an alternative method for tracking major or breaking changes and informing developers when such changes occur.

Example output when bootstrap detects a major change:
![image](https://github.com/rust-lang/rust/assets/39852038/ee802dfa-a02b-488b-a433-f853ce079b8a)
Diffstat (limited to 'config.example.toml')
-rw-r--r--config.example.toml17
1 files changed, 12 insertions, 5 deletions
diff --git a/config.example.toml b/config.example.toml
index f3c2366d674..4f44121410e 100644
--- a/config.example.toml
+++ b/config.example.toml
@@ -19,11 +19,18 @@
 # Note that this has no default value (x.py uses the defaults in `config.example.toml`).
 #profile = <none>
 
-# Keeps track of the last version of `x.py` used.
-# If `changelog-seen` does not match the version that is currently running,
-# `x.py` will prompt you to update it and to read the changelog.
-# See `src/bootstrap/CHANGELOG.md` for more information.
-changelog-seen = 2
+# Keeps track of major changes made to this configuration.
+#
+# This value also represents ID of the PR that caused major changes. Meaning,
+# you can visit github.com/rust-lang/rust/pull/{change-id} to check for more details.
+#
+# A 'major change' includes any of the following
+#  - A new option
+#  - A change in the default values
+#
+# If `change-id` does not match the version that is currently running,
+# `x.py` will prompt you to update it and check the related PR for more details.
+change-id = 115898
 
 # =============================================================================
 # Tweaking how LLVM is compiled