Skip to content

Commit 5c974ce

Browse files
GedochaoGedochao
authored
Add release notes for v1.0.0-RC1 (#1974)
1 parent 2476332 commit 5c974ce

File tree

1 file changed

+165
-0
lines changed

1 file changed

+165
-0
lines changed

‎website/docs/release_notes.md‎

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

88
# Release notes
99

10+
## [v1.0.0-RC1](https://github.com/VirtusLab/scala-cli/releases/tag/v1.0.0-RC1)
11+
12+
### Official `scala` runner release candidate
13+
14+
`v1.0.0-RC1` is the first release candidate version of Scala CLI.
15+
16+
Either this or a future release candidate is meant to become the new official `scala` runner to accompany
17+
the Scala compiler (`scalac`) and other scripts, replacing the old `scala` command.
18+
19+
To learn more about Scala CLI as the new `scala` runner, check out our recent blogpost:
20+
https://virtuslab.com/blog/scala-cli-the-new-scala-runner/
21+
22+
### Scala CLI should now have better performance
23+
24+
With a number of newly added performance tweaks, you can expect Scala CLI to run considerably faster.
25+
Added by [@lwronski](https://github.com/lwronski) in [#1939](https://github.com/VirtusLab/scala-cli/pull/1939)
26+
27+
### Print appropriate warnings when experimental features are used
28+
29+
Using experimental features will now cause Scala CLI to print an appropriate warning.
30+
31+
```bash
32+
scala-cli --power -e '//> using publish.name "my-library"'
33+
# The '//> publish.name "my-library"' directive is an experimental feature.
34+
# Please bear in mind that non-ideal user experience should be expected.
35+
# If you encounter any bugs or have feedback to share, make sure to reach out to the maintenance team at https://github.com/VirtusLab/scala-cli
36+
```
37+
38+
The warning can be suppressed with the `--suppress-experimental-warning` option, or alternatively with the
39+
`suppress-warning.experimental-features` global config key.
40+
```bash
41+
scala-cli config suppress-warning.experimental-features true
42+
```
43+
44+
Added by [@Gedochao](https://github.com/Gedochao) in [#1920](https://github.com/VirtusLab/scala-cli/pull/1920)
45+
46+
### Experimental and restricted configuration keys will now require to be accessed in `--power` mode
47+
48+
Some configuration keys available with the `config` sub-command have been tagged as experimental or restricted and will
49+
only be available in `--power` mode.
50+
51+
```bash ignore
52+
scala-cli config httpProxy.address
53+
# The 'httpProxy.address' configuration key is restricted.
54+
# You can run it with the '--power' flag or turn power mode on globally by running:
55+
# scala-cli config power true.
56+
```
57+
58+
Added by [@Gedochao](https://github.com/Gedochao) in [#1953](https://github.com/VirtusLab/scala-cli/pull/1953)
59+
60+
61+
### Dropped deprecated `using` directive syntax
62+
63+
The following syntax for `using` directives have been dropped:
64+
- skipping `//>`
65+
- multiline directives
66+
- directives in `/*> ... */` comments
67+
- directives in plain `//` comments
68+
- `@using`
69+
70+
Added by [@tgodzik](https://github.com/tgodzik) in [#1932](https://github.com/VirtusLab/scala-cli/pull/1932)
71+
72+
### Added support for packaging native images from Docker
73+
74+
It is now possible to package a GraalVM native image with Scala CLI from docker.
75+
76+
```bash ignore
77+
docker run -v $(pwd)/Hello.scala:/Hello.scala virtuslab/scala-cli package --native-image /Hello.scala
78+
```
79+
80+
Added by [@lwronski](https://github.com/lwronski) in [#1961](https://github.com/VirtusLab/scala-cli/pull/1961)
81+
82+
### Added support for Scala Native's `LTO`
83+
It is now possible to set the Link Time Optimization (LTO) when using Scala CLI with Scala Native.
84+
The available options are "thin", "full" and "none".
85+
You can do it with the `--native-lto` option from the command line:
86+
87+
```bash
88+
scala-cli -e 'println("Hello")' --native --native-lto thin
89+
```
90+
91+
Or with a `using` directive:
92+
93+
```scala compile
94+
//> using platform "scala-native"
95+
//> using nativeLto "thin"
96+
@main def main(): Unit = println("Hello")
97+
```
98+
99+
Added by [@lwronski](https://github.com/lwronski) in [#1964](https://github.com/VirtusLab/scala-cli/pull/1964)
100+
101+
### Other changes
102+
103+
#### Publishing changes
104+
* Make credential entries respect the --password-value option by [@MaciejG604](https://github.com/MaciejG604)
105+
in [#1949](https://github.com/VirtusLab/scala-cli/pull/1949)
106+
* Write PGP keys to publish-conf when doing publish setup by [@MaciejG604](https://github.com/MaciejG604)
107+
in [#1940](https://github.com/VirtusLab/scala-cli/pull/1940)
108+
* Comply with optional password in `scala-cli-signing` by [@MaciejG604](https://github.com/MaciejG604)
109+
in [#1982](https://github.com/VirtusLab/scala-cli/pull/1982)
110+
* Support ssh in GitHub repo org&name extraction by [@KuceraMartin](https://github.com/KuceraMartin)
111+
in [#1938](https://github.com/VirtusLab/scala-cli/pull/1938)
112+
113+
#### Fixes
114+
* Print an informative error if the project workspace path contains `File.pathSeparator` by [@Gedochao](https://github.com/Gedochao)
115+
in [#1985](https://github.com/VirtusLab/scala-cli/pull/1985)
116+
* Enable to pass custom docker-cmd to execute application in docker by [@lwronski](https://github.com/lwronski)
117+
in [#1980](https://github.com/VirtusLab/scala-cli/pull/1980)
118+
* Fix - uses show cli.nativeImage command to generate native image by [@lwronski](https://github.com/lwronski)
119+
in [#1975](https://github.com/VirtusLab/scala-cli/pull/1975)
120+
* Vcs.parse fix by [@KuceraMartin](https://github.com/KuceraMartin)
121+
in [#1963](https://github.com/VirtusLab/scala-cli/pull/1963)
122+
* move args definition to the top of the script by [@bishabosha](https://github.com/bishabosha)
123+
in [#1983](https://github.com/VirtusLab/scala-cli/pull/1983)
124+
125+
#### Documentation changes
126+
127+
* Back port of documentation changes to main by [@github-actions](https://github.com/github-actions)
128+
in [#1935](https://github.com/VirtusLab/scala-cli/pull/1935)
129+
* Remove ChainedSnippets by [@MaciejG604](https://github.com/MaciejG604)
130+
in [#1928](https://github.com/VirtusLab/scala-cli/pull/1928)
131+
* Further document publish command by [@MaciejG604](https://github.com/MaciejG604)
132+
in [#1914](https://github.com/VirtusLab/scala-cli/pull/1914)
133+
* Add a verbosity guide by [@Gedochao](https://github.com/Gedochao)
134+
in [#1936](https://github.com/VirtusLab/scala-cli/pull/1936)
135+
* Docs - how to run unit tests in Scala CLI by [@lwronski](https://github.com/lwronski)
136+
in [#1977](https://github.com/VirtusLab/scala-cli/pull/1977)
137+
138+
#### Build and internal changes
139+
140+
* Use locally build jvm launcher of scala-cli in gifs generator by [@lwronski](https://github.com/lwronski)
141+
in [#1921](https://github.com/VirtusLab/scala-cli/pull/1921)
142+
* Clean up after ammonite imports removal by [@MaciejG604](https://github.com/MaciejG604)
143+
in [#1934](https://github.com/VirtusLab/scala-cli/pull/1934)
144+
* Temporarily disable `PublishTests.secret keys in config` on Windows by [@Gedochao](https://github.com/Gedochao)
145+
in [#1948](https://github.com/VirtusLab/scala-cli/pull/1948)
146+
* Move toolkit to scalalang org by [@szymon-rd](https://github.com/szymon-rd)
147+
in [#1930](https://github.com/VirtusLab/scala-cli/pull/1930)
148+
149+
#### Updates and maintenance
150+
151+
* Update scala-cli.sh launcher for 0.2.1 by [@github-actions](https://github.com/github-actions)
152+
in [#1931](https://github.com/VirtusLab/scala-cli/pull/1931)
153+
* Bump VirtusLab/scala-cli-setup from 0.2.0 to 0.2.1 by [@dependabot](https://github.com/dependabot)
154+
in [#1947](https://github.com/VirtusLab/scala-cli/pull/1947)
155+
* Bump coursier/publish version to 0.1.4 by [@MaciejG604](https://github.com/MaciejG604)
156+
in [#1950](https://github.com/VirtusLab/scala-cli/pull/1950)
157+
* Bump to the latest weaver & remove expecty by [@lenguyenthanh](https://github.com/lenguyenthanh)
158+
in [#1955](https://github.com/VirtusLab/scala-cli/pull/1955)
159+
* Bump webfactory/ssh-agent from 0.7.0 to 0.8.0 by [@dependabot](https://github.com/dependabot)
160+
in [#1967](https://github.com/VirtusLab/scala-cli/pull/1967)
161+
* chore(dep): bump mill from 0.10.10 to 0.10.12 by [@ckipp01](https://github.com/ckipp01)
162+
in [#1970](https://github.com/VirtusLab/scala-cli/pull/1970)
163+
* Bump Bleep to `1.5.6-sc-4`by [@Gedochao](https://github.com/Gedochao)
164+
in [#1973](https://github.com/VirtusLab/scala-cli/pull/1973)
165+
166+
### New Contributors
167+
168+
* [@KuceraMartin](https://github.com/KuceraMartin) made their first contribution
169+
in [#1938](https://github.com/VirtusLab/scala-cli/pull/1938)
170+
* [@lenguyenthanh](https://github.com/lenguyenthanh) made their first contribution
171+
in [#1955](https://github.com/VirtusLab/scala-cli/pull/1955)
172+
173+
**Full Changelog**: https://github.com/VirtusLab/scala-cli/compare/v0.2.1...v1.0.0-RC1
174+
10175
## [v0.2.1](https://github.com/VirtusLab/scala-cli/releases/tag/v0.2.1)
11176

12177
### Add a guide for migrating from the old `scala` runner to Scala CLI

0 commit comments

Comments
 (0)