Skip to content

Commit f08256a

Browse files
committed
Add release notes for v1.0.0
1 parent 0fa200a commit f08256a

File tree

1 file changed

+80
-0
lines changed

1 file changed

+80
-0
lines changed

website/docs/release_notes.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,86 @@ import ReactPlayer from 'react-player'
77

88
# Release notes
99

10+
## [v1.0.0](https://github.com/VirtusLab/scala-cli/releases/tag/v1.0.0)
11+
12+
## The official `scala` runner release
13+
14+
Scala CLI has reached the highly anticipated `1.0.0` milestone!
15+
Having addressed all the [SIP-46](https://github.com/scala/improvement-proposals/pull/46) requirements,
16+
this version is going to become the official `scala` runner, replacing the old `scala` command.
17+
18+
For a deeper understanding of Scala CLI as the new `scala` runner and to explore its benefits and features,
19+
we encourage you to check out our [blogpost](https://virtuslab.com/blog/scala-cli-the-new-scala-runner/).
20+
21+
Also be sure to get familiar with all the differences introduced by this change in our [migration guide](docs/guides/old-runner-migration.md).
22+
23+
## What's Changed
24+
25+
### New default Scala version - 3.3.0
26+
27+
Scala 3.3.0 is now the default version for Scala CLI projects.
28+
It's the first LTS (Long Term Support) release of Scala 3 to be used by Scala CLI.
29+
Right on time for 1.0.0!
30+
31+
Added by [@lwronski](https://github.com/lwronski) in [#2140](https://github.com/VirtusLab/scala-cli/pull/2140)
32+
33+
### Toolkit-test
34+
35+
By incorporating the [Scala Toolkit](https://github.com/scala/toolkit) into your project, you gain the advantage of two additional
36+
dependencies seamlessly integrated into your classpath:
37+
- `org.scala-lang:toolkit:<version>` is added to the main scope, allowing its utilization throughout your project.
38+
- `org.scala-lang:toolkit-test:<version>` is included in the test scope, making it available exclusively for testing purposes.
39+
40+
Scala CLI now supports the following features for the toolkit:
41+
* including e.g. `//> using toolkit latest` in any main scope file will automatically add the `toolkit` dependency to the main scope and the `toolkit-test` dependency to the test scope
42+
* if you place e.g. `//> using toolkit latest` within a test scope file, both `toolkit` and `toolkit-test` will be limited to the test scope only
43+
* inserting e.g. `//> using test.toolkit latest` anywhere in the project will add both `toolkit` and `toolkit-test` to the test scope only
44+
45+
This convention is encouraged for other toolkit-like libraries as well.
46+
47+
Added by [@Gedochao](https://github.com/Gedochao) in [#2127](https://github.com/VirtusLab/scala-cli/pull/2127) and [#2137](https://github.com/VirtusLab/scala-cli/pull/2137)
48+
49+
### Forcing an object wrapper for scripts
50+
51+
Scala CLI now supports the `//> using objectWrapper` directive, along with the corresponding `--object-wrapper` option,
52+
which allows to force wrapping script code in an object body instead of a class.
53+
54+
Using object wrappers should be avoided for scripts relying on multi-threading (as it may cause deadlocks), but may prove to be the only option in some cases.
55+
56+
Added by [@MaciejG604](https://github.com/MaciejG604) in [#2136](https://github.com/VirtusLab/scala-cli/pull/2136)
57+
58+
## Other changes
59+
* Add alias for snapshots repository in Maven by [@lwronski](https://github.com/lwronski) in [#2125](https://github.com/VirtusLab/scala-cli/pull/2125)
60+
* Bump typelevel-toolkit to 0.0.11, configure toolkit-test by [@armanbilge](https://github.com/armanbilge) in [#2135](https://github.com/VirtusLab/scala-cli/pull/2135)
61+
* Fix updating toolkit dependencies by [@Gedochao](https://github.com/Gedochao) in [#2138](https://github.com/VirtusLab/scala-cli/pull/2138)
62+
* Improve directive parsing errors & special-case `toolkit` directive version parsing by [@Gedochao](https://github.com/Gedochao) in [#2133](https://github.com/VirtusLab/scala-cli/pull/2133)
63+
* Fix determining position for value in directive without quotes by [@lwronski](https://github.com/lwronski) in [#2141](https://github.com/VirtusLab/scala-cli/pull/2141)
64+
65+
### Fixes
66+
* Fix line conversion logic by simplifying topWrapperLen to line count of top wrapper by [@MaciejG604](https://github.com/MaciejG604) in [#2101](https://github.com/VirtusLab/scala-cli/pull/2101)
67+
* Fix test watch infinite loop by [@MaciejG604](https://github.com/MaciejG604) in [#2113](https://github.com/VirtusLab/scala-cli/pull/2113)
68+
* Fix flaky completions for `zsh` by [@Jasper-M](https://github.com/Jasper-M) in [#2118](https://github.com/VirtusLab/scala-cli/pull/2118)
69+
* Fix - install certificates for java by [@lwronski](https://github.com/lwronski) in [#2123](https://github.com/VirtusLab/scala-cli/pull/2123)
70+
* Fix the `--source-jar` option & add corresponding `using` directives by [@Gedochao](https://github.com/Gedochao) in [#2120](https://github.com/VirtusLab/scala-cli/pull/2120)
71+
72+
### Documentation changes
73+
* Add docs for bootstrapped standalone fat JAR by [@lwronski](https://github.com/lwronski) in [#2122](https://github.com/VirtusLab/scala-cli/pull/2122)
74+
* Add developer docs on modifying `reflect-config.json` by [@Gedochao](https://github.com/Gedochao) in [#2114](https://github.com/VirtusLab/scala-cli/pull/2114)
75+
76+
### Build and internal changes
77+
* Update release procedure - update also v1 tag by [@lwronski](https://github.com/lwronski) in [#2107](https://github.com/VirtusLab/scala-cli/pull/2107)
78+
* NIT Refactor test scope directives by [@Gedochao](https://github.com/Gedochao) in [#2083](https://github.com/VirtusLab/scala-cli/pull/2083)
79+
* Add main class to jar manifest in assembly by [@romanowski](https://github.com/romanowski) in [#2124](https://github.com/VirtusLab/scala-cli/pull/2124)
80+
81+
### Updates and maintenance
82+
* Update scala-cli.sh launcher for 1.0.0-RC2 by [@github-actions](https://github.com/github-actions) in [#2105](https://github.com/VirtusLab/scala-cli/pull/2105)
83+
* Update org.eclipse.jgit to 6.5.0.202303070854-r by [@scala-steward](https://github.com/scala-steward) in [#2090](https://github.com/VirtusLab/scala-cli/pull/2090)
84+
85+
## New Contributors
86+
* [@Jasper-M](https://github.com/Jasper-M) made their first contribution in [#2118](https://github.com/VirtusLab/scala-cli/pull/2118)
87+
88+
**Full Changelog**: https://github.com/VirtusLab/scala-cli/compare/v1.0.0-RC2...v1.0.0
89+
1090
## [v1.0.0-RC2](https://github.com/VirtusLab/scala-cli/releases/tag/v1.0.0-RC2)
1191

1292
## What's Changed

0 commit comments

Comments
 (0)