Skip to content

Commit a737c85

Browse files
committed
chore: add spinner-ci description
1 parent c490b84 commit a737c85

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

examples/basic/spinner-ci.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
/**
2+
* This example addresses a issue reported in GitHub Actions where `spinner` was excessively writing messages,
3+
* leading to confusion and cluttered output.
4+
* To enhance the CI workflow and provide a smoother experience,
5+
* the following changes have been made only for CI environment:
6+
* - Messages will now only be written when a `spinner` method is called and the message updated, preventing unnecessary message repetition.
7+
* - There will be no loading dots animation, instead it will be always `...`
8+
* - Instead of erase the previous message, action that is blocked during CI, it will just write a new one.
9+
*
10+
* Issue: https://github.com/natemoo-re/clack/issues/168
11+
*/
112
import * as p from '@clack/prompts';
213

314
const s = p.spinner();

0 commit comments

Comments
 (0)