Add initialBuildSteps removal notice (#9943)

* Add `initialBuildSteps` removal notice And suggestion on what to use (`preBuildComponent`) instead. * Update release-notes/Cabal-3.12.0.0.md Co-authored-by: sheaf <[email protected]>
haskell · Apr 29, 2024 · c80ee75 · c80ee75
1 parent bccc59f
commit c80ee75
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/release-notes/Cabal-3.12.0.0.md b/release-notes/Cabal-3.12.0.0.md
@@ -61,6 +61,18 @@ Cabal and Cabal-syntax 3.12.0.0 changelog and release notes
   added. It can now be used in the `default-language` and `other-languages`
   fields, and will be offered as an option by `cabal init`.
 
+- Remove `initialBuildSteps` from `Distribution.Simple.Build` [#9474](https://github.com/haskell/cabal/pull/9474)
+
+  Calling `initialBuildSteps` to prepare source files for a package is error
+  prone, as `initialBuildSteps` only handles things like the paths module
+  and nothing else.
+
+  To mimick `initialBuildSteps` behaviour when there is no custom Setup, you
+  can call `repl_setupHooks`.
+
+  If you are dealing with a custom setup, you have to invoke
+  `./Setup repl --repl-multi-file`.
+
 ### Other changes
 
 - `cabal init` should not suggest Cabal < 2.0 [#8680](https://github.com/haskell/cabal/issues/8680)