Skip to content

Commit 6547a9c

Browse files
GedochaoGedochao
authored
Add release notes for v0.1.18 (#1618)
1 parent e41d40d commit 6547a9c

File tree

1 file changed

+189
-0
lines changed

1 file changed

+189
-0
lines changed

‎website/docs/release_notes.md

Lines changed: 189 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,195 @@ sidebar_position: 99
55

66
# Release notes
77

8+
## [v0.1.18](https://github.com/VirtusLab/scala-cli/releases/tag/v0.1.18)
9+
10+
## Filter tests with `--test-only`
11+
It is now possible to filter test suites with the `--test-only` option.
12+
13+
```scala title=BarTests.scala
14+
//> using lib "org.scalameta::munit::1.0.0-M7"
15+
package tests.only
16+
class Tests extends munit.FunSuite {
17+
test("bar") {
18+
assert(2 + 2 == 5)
19+
}
20+
test("foo") {
21+
assert(2 + 3 == 5)
22+
}
23+
test("foo-again") {
24+
assert(2 + 3 == 5)
25+
}
26+
}
27+
```
28+
29+
```scala title=HelloTests.scala
30+
package tests
31+
class HelloTests extends munit.FunSuite {
32+
test("hello") {
33+
assert(2 + 2 == 4)
34+
}
35+
}
36+
```
37+
38+
```bash fail
39+
scala-cli test BarTests.scala HelloTests.scala --test-only 'tests.only*'
40+
# tests.only.Tests:
41+
# ==> X tests.only.Tests.bar 0.037s munit.FailException: ~/project/src/test/BarTests.scala:5 assertion failed
42+
# 4: test("bar") {
43+
# 5: assert(2 + 2 == 5)
44+
# 6: }
45+
# at munit.FunSuite.assert(FunSuite.scala:11)
46+
# at tests.only.Tests.$init$$$anonfun$1(BarTests.scala:5)
47+
# at tests.only.Tests.$init$$$anonfun$adapted$1(BarTests.scala:6)
48+
# + foo 0.004s
49+
# + foo-again 0.001s
50+
```
51+
52+
Filtering particular tests by name requires passing args to the test framework.
53+
For example, with `munit`:
54+
55+
```bash
56+
scala-cli test BarTests.scala HelloTests.scala --test-only 'tests.only*' -- '*foo*'
57+
# tests.only.Tests:
58+
# + foo 0.032s
59+
# + foo-again 0.001s
60+
```
61+
62+
Added by [@lwronski](https://github.com/lwronski) in [#1604](https://github.com/VirtusLab/scala-cli/pull/1604)
63+
64+
## Accept authenticated proxy params via Scala CLI config
65+
If you can only download artifacts through an authenticated proxy, it is now possible to configure it
66+
with the `config` subcommand.
67+
68+
```bash ignore
69+
scala-cli config httpProxy.address https://proxy.company.com
70+
scala-cli config httpProxy.user _encoded_user_
71+
scala-cli config httpProxy.password _encoded_password_
72+
```
73+
74+
Replace `_encoded_user_` and `_encoded_password_` by your actual user and password, following
75+
the [password option format](reference/password-options.md). They should typically look like
76+
`env:ENV_VAR_NAME`, `file:/path/to/file`, or `command:command to run`.
77+
78+
Added by [@alexarchambault](https://github.com/alexarchambault) in [#1593](https://github.com/VirtusLab/scala-cli/pull/1593)
79+
80+
## Support for running Markdown sources from zipped archives and gists
81+
It is now possible to run `.md` sources inside a `.zip` archive.
82+
Same as with directories, `.md` sources inside zipped archives are ignored by default, unless
83+
the `--enable-markdown` option is passed.
84+
85+
```bash ignore
86+
scala-cli archive-with-markdown.zip --enable-markdown
87+
```
88+
89+
This also enables running Markdown sources fom GitHub gists, as those are downloaded by Scala CLI as zipped archives.
90+
91+
```bash
92+
scala-cli https://gist.github.com/Gedochao/6415211eeb8ca4d8d6db123f83f0f839 --enable-markdown
93+
```
94+
95+
It is also possible to point Scala CLI to a `.md` file with a direct URL.
96+
97+
```bash
98+
scala-cli https://gist.githubusercontent.com/Gedochao/6415211eeb8ca4d8d6db123f83f0f839/raw/4c5ce7593e19f1390555221e0d076f4b02f4b4fd/example.md
99+
```
100+
101+
Added by [@Gedochao](https://github.com/Gedochao) in [#1581](https://github.com/VirtusLab/scala-cli/pull/1581)
102+
103+
## Support for running piped Markdown sources
104+
Instead of passing paths to your Markdown sources, you can also pipe your code via standard input:
105+
106+
```bash
107+
echo '# Example Snippet
108+
```scala
109+
println("Hello")
110+
```' | scala-cli _.md
111+
```
112+
113+
Added by [@Gedochao](https://github.com/Gedochao) in [#1582](https://github.com/VirtusLab/scala-cli/pull/1582)
114+
115+
## Support for running Markdown snippets
116+
It is now possible to pass Markdown code as a snippet directly from the command line.
117+
118+
````bash
119+
scala-cli run --markdown-snippet '# Markdown snippet
120+
with a code block
121+
```scala
122+
println("Hello")
123+
```'
124+
````
125+
126+
Added by [@Gedochao](https://github.com/Gedochao) in [#1583](https://github.com/VirtusLab/scala-cli/pull/1583)
127+
128+
## Customize exported Mill project name
129+
It is now possible to pass the desired name of your Mill project to the `export` sub-command
130+
with the `--project` option.
131+
132+
```bash
133+
scala-cli export . --mill -o mill-proj --project project-name
134+
```
135+
136+
Added by [@carlosedp](https://github.com/carlosedp) in [#1563](https://github.com/VirtusLab/scala-cli/pull/1563)
137+
138+
## Export Scala compiler options to Mill projects
139+
It is now possible to export `scalac` options from a Scala CLI project to Mill with the `export` sub-command.
140+
141+
Added by [@lolgab](https://github.com/lolgab) in [#1562](https://github.com/VirtusLab/scala-cli/pull/1562)
142+
143+
## Other changes
144+
145+
## Fixes
146+
* Fix overriding settings from tests by [@alexarchambault](https://github.com/alexarchambault) in [#1566](https://github.com/VirtusLab/scala-cli/pull/1566)
147+
* Print compilation failed in watch mode too in test command by [@alexarchambault](https://github.com/alexarchambault) in [#1548](https://github.com/VirtusLab/scala-cli/pull/1548)
148+
* Fix error message when running JVM launcher from Java 8 by [@alexarchambault](https://github.com/alexarchambault) in [#1575](https://github.com/VirtusLab/scala-cli/pull/1575)
149+
* Fix `using` directives for Markdown inputs by [@Gedochao](https://github.com/Gedochao) in [#1598](https://github.com/VirtusLab/scala-cli/pull/1598)
150+
* Fix - clean up only homebrew-scala-experimental directory by [@lwronski](https://github.com/lwronski) in [#1615](https://github.com/VirtusLab/scala-cli/pull/1615)
151+
* Warn users when pushing to Sonatype with missing credentials or params by [@alexarchambault](https://github.com/alexarchambault) in [#1545](https://github.com/VirtusLab/scala-cli/pull/1545)
152+
* Warning for multiple files with using directives by [@wleczny](https://github.com/wleczny) in [#1591](https://github.com/VirtusLab/scala-cli/pull/1591)
153+
* Make package --python work by [@alexarchambault](https://github.com/alexarchambault) in [#1531](https://github.com/VirtusLab/scala-cli/pull/1531)
154+
* Better revolver output by [@alexarchambault](https://github.com/alexarchambault) in [#1614](https://github.com/VirtusLab/scala-cli/pull/1614)
155+
* Make `PackageTestsDefault.reuse run native binary` more robust by [@lwronski](https://github.com/lwronski) in [1621](https://github.com/VirtusLab/scala-cli/pull/1621)
156+
157+
## Documentation updates
158+
* Add some explanations on implicit sub-commands in `-help` by [@Gedochao](https://github.com/Gedochao) in [#1587](https://github.com/VirtusLab/scala-cli/pull/1587)
159+
* Runner specification by [@romanowski](https://github.com/romanowski) in [#1445](https://github.com/VirtusLab/scala-cli/pull/1445)
160+
* Install documentation update by [@wleczny](https://github.com/wleczny) in [#1595](https://github.com/VirtusLab/scala-cli/pull/1595)
161+
* Document recent features & changes affecting working with Markdown inputs by [@Gedochao](https://github.com/Gedochao) in [#1606](https://github.com/VirtusLab/scala-cli/pull/1606)
162+
* Improve docs coverage with `sclicheck` by [@Gedochao](https://github.com/Gedochao) in [#1612](https://github.com/VirtusLab/scala-cli/pull/1612)
163+
* Reduce ignore tags in the docs snippets by [@Gedochao](https://github.com/Gedochao) in [#1617](https://github.com/VirtusLab/scala-cli/pull/1617)
164+
165+
## Build and internal changes
166+
* Remove superfluous annotation by [@alexarchambault](https://github.com/alexarchambault) in [#1567](https://github.com/VirtusLab/scala-cli/pull/1567)
167+
* Decompose & refactor `Inputs` by [@Gedochao](https://github.com/Gedochao) in [#1565](https://github.com/VirtusLab/scala-cli/pull/1565)
168+
* Disable create PGP key test on Windows CI by [@alexarchambault](https://github.com/alexarchambault) in [#1588](https://github.com/VirtusLab/scala-cli/pull/1588)
169+
* Switch to Scala 3-based case-app by [@alexarchambault](https://github.com/alexarchambault) in [#1568](https://github.com/VirtusLab/scala-cli/pull/1568)
170+
* Remove cli-options module by [@alexarchambault](https://github.com/alexarchambault) in [#1552](https://github.com/VirtusLab/scala-cli/pull/1552)
171+
* Enable to force using jvm signing launcher for native launcher of scala-cli by [@lwronski](https://github.com/lwronski) in [#1597](https://github.com/VirtusLab/scala-cli/pull/1597)
172+
* Run warm up test before running default tests by [@lwronski](https://github.com/lwronski) in [#1599](https://github.com/VirtusLab/scala-cli/pull/1599)
173+
* Make DefaultTests more robust by [@alexarchambault](https://github.com/alexarchambault) in [#1613](https://github.com/VirtusLab/scala-cli/pull/1613)
174+
175+
## Updates & maintenance
176+
* Update scala-cli.sh launcher for 0.1.17 by [@github-actions](https://github.com/github-actions) in [#1564](https://github.com/VirtusLab/scala-cli/pull/1564)
177+
* Update zip-input-stream to 0.1.1 by [@scala-steward](https://github.com/scala-steward-org/scala-steward) in [#1573](https://github.com/VirtusLab/scala-cli/pull/1573)
178+
* Update coursier-jvm_2.13, ... to 2.1.0-RC1 by [@scala-steward](https://github.com/scala-steward-org/scala-steward) in [#1572](https://github.com/VirtusLab/scala-cli/pull/1572)
179+
* Update mill-main to 0.10.9 by [@scala-steward](https://github.com/scala-steward-org/scala-steward) in [#1571](https://github.com/VirtusLab/scala-cli/pull/1571)
180+
* Update test-runner, tools to 0.4.8 by [@scala-steward](https://github.com/scala-steward-org/scala-steward) in [#1574](https://github.com/VirtusLab/scala-cli/pull/1574)
181+
* Update case-app_2.13 to 2.1.0-M21 by [@scala-steward](https://github.com/scala-steward-org/scala-steward) in [#1570](https://github.com/VirtusLab/scala-cli/pull/1570)
182+
* Bump VirtusLab/scala-cli-setup from 0.1.16 to 0.1.17 by [@dependabot](https://github.com/dependabot) in [#1579](https://github.com/VirtusLab/scala-cli/pull/1579)
183+
* Bump Ammonite to 2.5.5-17-df243e14 & Scala to 3.2.1 by [@Gedochao](https://github.com/Gedochao) in [#1586](https://github.com/VirtusLab/scala-cli/pull/1586)
184+
* Update scala-cli-signing to 0.1.13 by [@alexarchambault](https://github.com/alexarchambault) in [#1569](https://github.com/VirtusLab/scala-cli/pull/1569)
185+
* Update coursier-jvm_2.13, ... to 2.1.0-RC2 by [@scala-steward](https://github.com/scala-steward-org/scala-steward) in [#1590](https://github.com/VirtusLab/scala-cli/pull/1590)
186+
* Update scalajs-sbt-test-adapter_2.13 to 1.11.0 by [@scala-steward](https://github.com/scala-steward-org/scala-steward) in [#1477](https://github.com/VirtusLab/scala-cli/pull/1477)
187+
* Update slf4j-nop to 2.0.4 by [@scala-steward](https://github.com/scala-steward-org/scala-steward) in [#1596](https://github.com/VirtusLab/scala-cli/pull/1596)
188+
* Update jsoniter-scala-core_2.13 to 2.18.0 by [@scala-steward](https://github.com/scala-steward-org/scala-steward) in [#1608](https://github.com/VirtusLab/scala-cli/pull/1608)
189+
* Update test-runner, tools to 0.4.9 by [@scala-steward](https://github.com/scala-steward-org/scala-steward) in [#1610](https://github.com/VirtusLab/scala-cli/pull/1610)
190+
* Update Bloop to 1.5.4-sc-4 by [@alexarchambault](https://github.com/alexarchambault) in [#1622](https://github.com/VirtusLab/scala-cli/pull/1622)
191+
192+
## New Contributors
193+
* [@carlosedp](https://github.com/carlosedp) made their first contribution in [#1563](https://github.com/VirtusLab/scala-cli/pull/1563)
194+
195+
**Full Changelog**: https://github.com/VirtusLab/scala-cli/compare/v0.1.17...v0.1.18
196+
8197
## [v0.1.17](https://github.com/VirtusLab/scala-cli/releases/tag/v0.1.17)
9198

10199
# Enhancements

0 commit comments

Comments
 (0)