Skip to content

Commit 1865b24

Browse files
committed
docs: add readme for setup-apt and os-env
1 parent dc74686 commit 1865b24

File tree

15 files changed

+307
-136
lines changed

15 files changed

+307
-136
lines changed

dist/actions/setup-cpp.js

Lines changed: 30 additions & 32 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/actions/setup-cpp.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/legacy/setup-cpp.js

Lines changed: 33 additions & 35 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/legacy/setup-cpp.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/modern/setup-cpp.js

Lines changed: 30 additions & 32 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/modern/setup-cpp.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/ci-log/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
"name": "ci-log",
33
"version": "1.0.0",
44
"description": "Colorful logging and print for any environment including GitHub Actions",
5-
"homepage": "https://github.com/aminya/setup-cpp",
5+
"repository": "https://github.com/aminya/setup-cpp",
6+
"homepage": "https://github.com/aminya/setup-cpp/tree/master/packages/ci-log",
67
"license": "Apache-2.0",
78
"author": "Amin Yahyaabadi",
89
"main": "./dist/index.js",

packages/exec-powershell/package.json

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
"name": "exec-powershell",
33
"version": "1.0.0",
44
"description": "Run a powershell command.",
5-
"homepage": "https://github.com/aminya/setup-cpp",
5+
"repository": "https://github.com/aminya/setup-cpp",
6+
"homepage": "https://github.com/aminya/setup-cpp/tree/master/packages/exec-powershell",
67
"license": "Apache-2.0",
78
"author": "Amin Yahyaabadi",
89
"main": "./dist/index.js",
@@ -13,8 +14,9 @@
1314
"lint.eslint": "eslint **/*.{ts,tsx,js,jsx,cjs,mjs,json,yaml} --no-error-on-unmatched-pattern --cache --cache-location ./.cache/eslint/ --fix"
1415
},
1516
"dependencies": {
16-
"execa": "<8",
17-
"which": "^4.0.0"
17+
"execa": "^7",
18+
"which": "^4.0.0",
19+
"@types/node": "^14"
1820
},
1921
"devDependencies": {
2022
"@types/which": "^3.0.0"

packages/os-env/README.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
<h1 align="center">os-env</h1>
2+
<p>
3+
<img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" />
4+
<img src="https://img.shields.io/badge/node-%3E%3D12-blue.svg" />
5+
<a href="#" target="_blank">
6+
<img alt="License: Apache--2.0" src="https://img.shields.io/badge/License-Apache--2.0-yellow.svg" />
7+
</a>
8+
</p>
9+
10+
> Manage environment variables, PATH, and rc files
11+
12+
## Install
13+
14+
```sh
15+
npm install --save os-env
16+
```
17+
18+
## Usage
19+
20+
<!-- INSERT GENERATED DOCS START -->
21+
22+
### `defaultRcPath` (variable)
23+
24+
### `RcOptions` (type)
25+
26+
### `sourceRCInRc` (variable)
27+
28+
handles adding conditions to source rc file from .bashrc and .profile
29+
30+
### `finalizeRC` (function)
31+
32+
**Parameters:**
33+
34+
- rcOptions (`RcOptions`)
35+
36+
**returns:** Promise<void>
37+
38+
### `escapeString` (function)
39+
40+
**Parameters:**
41+
42+
- valGiven (`string`)
43+
- shouldEscapeSpace (`boolean`)
44+
45+
**returns:** any
46+
47+
### `AddEnvOptions` (type)
48+
49+
### `addEnv` (function)
50+
51+
Add an environment variable.
52+
53+
This function is cross-platforms and works in all the local or CI systems.
54+
55+
**Parameters:**
56+
57+
- name (`string`)
58+
- valGiven (`string`)
59+
- givenOptions (`Partial<AddEnvOptions>`)
60+
61+
**returns:** Promise<void>
62+
63+
### `addPath` (function)
64+
65+
Add a path to the PATH environment variable.
66+
67+
This function is cross-platforms and works in all the local or CI systems.
68+
69+
**Parameters:**
70+
71+
- path (`string`)
72+
- givenOptions (`Partial<AddPathOptions>`)
73+
74+
**returns:** Promise<void>
75+
76+
<!-- INSERT GENERATED DOCS END -->
77+
78+
## 🤝 Contributing
79+
80+
You can sponsor my work here:
81+
82+
https://github.com/sponsors/aminya
83+
84+
Pull requests, issues and feature requests are welcome.
85+
See the [Contributing guide](https://github.com/aminya/setup-cpp/blob/master/CONTRIBUTING.md).

packages/os-env/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
"name": "os-env",
33
"version": "1.0.0",
44
"description": "Manage environment variables, PATH, and rc files",
5-
"homepage": "https://github.com/aminya/setup-cpp",
5+
"repository": "https://github.com/aminya/setup-cpp",
6+
"homepage": "https://github.com/aminya/setup-cpp/tree/master/packages/os-env",
67
"license": "Apache-2.0",
78
"author": "Amin Yahyaabadi",
89
"main": "./dist/index.js",

0 commit comments

Comments
 (0)