Skip to content

Commit 4be1b56

Browse files
authored
Add release notes (#1922)
1 parent dd17c7e commit 4be1b56

File tree

1 file changed

+122
-0
lines changed

1 file changed

+122
-0
lines changed

website/docs/release_notes.md

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

88
# Release notes
99

10+
## [v0.2.1](https://github.com/VirtusLab/scala-cli/releases/tag/v0.2.1)
11+
12+
### Add a guide for migrating from the old `scala` runner to Scala CLI
13+
14+
As of [SIP-46](https://github.com/scala/improvement-proposals/pull/46), Scala CLI has been accepted as the new `scala`
15+
command. To make the transition smooth we added a [guide](docs/guides/old-runner-migration.md) highlighting
16+
the differences between the two runners.
17+
18+
Added by [@Gedochao](https://github.com/Gedochao) in [#1900](https://github.com/VirtusLab/scala-cli/pull/1900)
19+
20+
### Improve the `publish` and `publish setup` sub-commands' user experience
21+
22+
We're currently focusing on improving the experimental `publish` feature of Scala CLI and making `publish setup` + `publish`
23+
more stable and user-friendly.
24+
25+
Using pgp keys created by `config --create-pgp-key` subcommand is now supported as a default option,
26+
no additional user input is needed.
27+
28+
Addressed by [@alexarchambault](https://github.com/alexarchambault) in [#1432](https://github.com/VirtusLab/scala-cli/pull/1432)
29+
and by [@MaciejG604](https://github.com/MaciejG604) in [#1898](https://github.com/VirtusLab/scala-cli/pull/1898)
30+
31+
### Remove unsupported kebab-case style in using directives
32+
33+
All using directives names are now using camelCase, kebab-case is no longer available.
34+
35+
Added by [@lwronski](https://github.com/lwronski) in [#1878](https://github.com/VirtusLab/scala-cli/pull/1878)
36+
37+
### Add a reference for available config keys in help & docs
38+
39+
You can now view the available config keys using `config --help`:
40+
```bash
41+
scala-cli config -h
42+
# Usage: scala-cli config [options]
43+
# Configure global settings for Scala CLI.
44+
#
45+
# Available keys:
46+
# actions Globally enables actionable diagnostics. Enabled by default.
47+
# interactive Globally enables interactive mode (the '--interactive' flag).
48+
# power Globally enables power mode (the '--power' launcher flag).
49+
# suppress-warning.directives-in-multiple-files Globally suppresses warnings about directives declared in multiple source files.
50+
# suppress-warning.outdated-dependencies-files Globally suppresses warnings about outdated dependencies.
51+
#
52+
# You are currently viewing the basic help for the config sub-command. You can view the full help by running:
53+
# scala-cli config --help-full
54+
# For detailed documentation refer to our website: https://scala-cli.virtuslab.org/docs/commands/misc/config
55+
#
56+
# Config options:
57+
# --unset, --remove Remove an entry from config
58+
```
59+
Also, `config --full-help` will show the list of all keys.
60+
61+
Added by [@Gedochao](https://github.com/Gedochao) in [#1910](https://github.com/VirtusLab/scala-cli/pull/1910)
62+
63+
### Pass user arguments to JS runner
64+
65+
It's now possible to pass user arguments to a JS application:
66+
67+
```scala title=ScalaJsArgs.sc
68+
import scala.scalajs.js
69+
import scala.scalajs.js.Dynamic.global
70+
71+
val process = global.require("process")
72+
val argv = Option(process.argv)
73+
.filterNot(js.isUndefined)
74+
.map(_.asInstanceOf[js.Array[String]].drop(2).toSeq)
75+
.getOrElse(Nil)
76+
val console = global.console
77+
console.log(argv.mkString(" "))
78+
```
79+
80+
<ChainedSnippets>
81+
```bash
82+
scala-cli ScalaJsArgs.sc --js -- Hello World
83+
```
84+
```text
85+
Hello World
86+
```
87+
</ChainedSnippets>
88+
89+
Added by [@alexarchambault](https://github.com/alexarchambault) in [#1826](https://github.com/VirtusLab/scala-cli/pull/1826)
90+
91+
92+
### Other changes
93+
* Tweak error messages for running scripts without file extensions by [@Gedochao](https://github.com/Gedochao) in [#1886](https://github.com/VirtusLab/scala-cli/pull/1886)
94+
* Exit with Bloop command return code if it's non-zero by [@alexarchambault](https://github.com/alexarchambault) in [#1837](https://github.com/VirtusLab/scala-cli/pull/1837)
95+
* bloop-rifle: increase timeout values by [@Flowdalic](https://github.com/Flowdalic) in [#1865](https://github.com/VirtusLab/scala-cli/pull/1865)
96+
* Suggest users to clean working directory when Nailgun server failed by [@lwronski](https://github.com/lwronski) in [#1916](https://github.com/VirtusLab/scala-cli/pull/1916)
97+
* fix: encode videos in yuv420p to support Firefox by [@danielleontiev](https://github.com/danielleontiev) in [#1904](https://github.com/VirtusLab/scala-cli/pull/1904)
98+
* Fix reading passwords from commands by [@alexarchambault](https://github.com/alexarchambault) in [#1775](https://github.com/VirtusLab/scala-cli/pull/1775)
99+
* Add extra class path to generated bootstrap launcher by [@lwronski](https://github.com/lwronski) in [#1897](https://github.com/VirtusLab/scala-cli/pull/1897)
100+
101+
102+
#### SIP-related changes
103+
* Add 'dependency' and 'dependencies' alias for using directive by [@MaciejG604](https://github.com/MaciejG604) in [#1903](https://github.com/VirtusLab/scala-cli/pull/1903)
104+
105+
106+
#### Documentation updates
107+
* Ensure no console-syntax in reference docs and no `md` fenced blocks in `--help` by [@Gedochao](https://github.com/Gedochao) in [#1874](https://github.com/VirtusLab/scala-cli/pull/1874)
108+
* Document export subcommand by [@MaciejG604](https://github.com/MaciejG604) in [#1875](https://github.com/VirtusLab/scala-cli/pull/1875)
109+
* Tweak guides' and cookbooks' pages by [@Gedochao](https://github.com/Gedochao) in [#1894](https://github.com/VirtusLab/scala-cli/pull/1894)
110+
* Fix pgp creation option name by [@MaciejG604](https://github.com/MaciejG604) in [#1909](https://github.com/VirtusLab/scala-cli/pull/1909)
111+
* Fix using directive docs by [@lwronski](https://github.com/lwronski) in [#1901](https://github.com/VirtusLab/scala-cli/pull/1901)
112+
* Add docs to classifiers and exclude dependency by [@lwronski](https://github.com/lwronski) in [#1892](https://github.com/VirtusLab/scala-cli/pull/1892)
113+
114+
115+
#### Internal changes
116+
* Fix handling for `experimental` features by [@Gedochao](https://github.com/Gedochao) in [#1915](https://github.com/VirtusLab/scala-cli/pull/1915)
117+
* Change default home directory for tests integration and docs-test modules to avoid overriding global user config by [@lwronski](https://github.com/lwronski) in [#1917](https://github.com/VirtusLab/scala-cli/pull/1917)
118+
* NIT Use enums for help groups and help command groups by [@Gedochao](https://github.com/Gedochao) in [#1880](https://github.com/VirtusLab/scala-cli/pull/1880)
119+
120+
121+
#### Updates & maintenance
122+
* Bump dns-packet from 5.3.1 to 5.4.0 in /website by [@dependabot](https://github.com/dependabot) in [#1906](https://github.com/VirtusLab/scala-cli/pull/1906)
123+
* Bump VirtusLab/scala-cli-setup from 0.1.20 to 0.2.0 by [@dependabot](https://github.com/dependabot) in [#1890](https://github.com/VirtusLab/scala-cli/pull/1890)
124+
* Dump docusaurus to 2.3.1 and other docs deps by [@lwronski](https://github.com/lwronski) in [#1907](https://github.com/VirtusLab/scala-cli/pull/1907)
125+
* Update scala-cli.sh launcher for 0.2.0 by @github-actions in [#1881](https://github.com/VirtusLab/scala-cli/pull/1881)
126+
* Back port of documentation changes to main by @github-actions in [#1911](https://github.com/VirtusLab/scala-cli/pull/1911)
127+
128+
129+
## New Contributors
130+
* [@danielleontiev](https://github.com/danielleontiev) made their first contribution in [#1904](https://github.com/VirtusLab/scala-cli/pull/1904)
131+
10132
## [v0.2.0](https://github.com/VirtusLab/scala-cli/releases/tag/v0.2.0)
11133

12134
### Require the `--power` option for restricted features by default

0 commit comments

Comments
 (0)