Skip to content

Commit 465ec46

Browse files
authored
ci: fix publish step permissions (#881)
* Update README * Fix permission publish lib step
1 parent 5d56881 commit 465ec46

2 files changed

Lines changed: 13 additions & 6 deletions

File tree

.github/workflows/release-please.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,4 @@ jobs:
3838
uses: ./.github/workflows/publish-lib.yml
3939
permissions:
4040
id-token: write
41+
contents: read

packages/septic/README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,24 @@
1-
# Septic Node
1+
# Septic Config Lib
22

3-
Septic Node is a package that offers a library for parsing, formatting, linting and analysing Septic configuration files in addition to CLI for common CI workflows like linting and formatting.
3+
Septic Config Lib is a package that offers a library for parsing, formatting, linting and analysing Septic configuration files in addition to CLI for common CI workflows like linting and formatting.
44

55
## CLI
66

7-
To use the CLI for Septic, first install the package by running:
7+
To use the CLI for Septic on windows, first install Node and NPM by using [node version manager](https://github.com/coreybutler/nvm-windows). After installation install node version 22 and select that version by running:
8+
9+
```bash
10+
nvm install 22
11+
nvm use 22
12+
```
13+
14+
Nvm also install the node package manager (npm). We can install the Septic config library by running:
815

916
```bash
1017
npm install -g septic
1118
```
1219

13-
After installation the following commands are available:
20+
After installation, the Septic config analyzer (SCA) command line tool is available. SCA offers a CLI for doing common CI quality checks such as linting and formatting. Run the following command to get overview of the functionality and use:
1421

1522
```bash
16-
septic-lint
17-
septic-format
23+
sca --help
1824
```

0 commit comments

Comments
 (0)