@quobix/vacuum 0.17.7 → 0.17.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,7 +6,6 @@
|
|
|
6
6
|
[](https://goreportcard.com/report/github.com/daveshanley/vacuum)
|
|
7
7
|
[](https://discord.gg/UAcUF78MQN)
|
|
8
8
|
[](https:/-/pkg.go.dev/github.com/daveshanley/vacuum)
|
|
9
|
-
[](https://github.com/daveshanley/vacuum/releases)
|
|
10
9
|
[](https://www.npmjs.com/package/@quobix/vacuum)
|
|
11
10
|
[](https://hub.docker.com/r/dshanley/vacuum)
|
|
12
11
|
[](https://github.com/avelino/awesome-go)
|
|
@@ -35,10 +34,35 @@ yarn global add @quobix/vacuum
|
|
|
35
34
|
|
|
36
35
|
## Install using curl
|
|
37
36
|
|
|
38
|
-
```
|
|
37
|
+
```bash
|
|
39
38
|
curl -fsSL https://quobix.com/scripts/install_vacuum.sh | sh
|
|
40
39
|
```
|
|
41
40
|
|
|
41
|
+
### For CI/CD environments
|
|
42
|
+
|
|
43
|
+
To avoid GitHub API rate limiting in automated environments, set a GitHub token:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
# Using repository token (GitHub Actions)
|
|
47
|
+
GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }} curl -fsSL https://quobix.com/scripts/install_vacuum.sh | sh
|
|
48
|
+
|
|
49
|
+
# Using personal access token
|
|
50
|
+
GITHUB_TOKEN=your_github_token curl -fsSL https://quobix.com/scripts/install_vacuum.sh | sh
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
#### GitHub Actions example
|
|
54
|
+
|
|
55
|
+
```yaml
|
|
56
|
+
- name: Install vacuum
|
|
57
|
+
env:
|
|
58
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Increases rate limit from 60 to 5000 requests/hour
|
|
59
|
+
run: |
|
|
60
|
+
curl -fsSL https://quobix.com/scripts/install_vacuum.sh | sh
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
> **Note**: The GitHub token prevents intermittent installation failures in CI/CD environments caused by API rate limiting.
|
|
64
|
+
> No additional permissions are required, the token only accesses public repository information.
|
|
65
|
+
|
|
42
66
|
## Install using [Docker](https://hub.docker.com/r/dshanley/vacuum)
|
|
43
67
|
|
|
44
68
|
The image is available at: https://hub.docker.com/r/dshanley/vacuum
|
|
@@ -47,6 +71,8 @@ The image is available at: https://hub.docker.com/r/dshanley/vacuum
|
|
|
47
71
|
docker pull dshanley/vacuum
|
|
48
72
|
```
|
|
49
73
|
|
|
74
|
+
> **Multi-platform support**: Docker images are available for both `linux/amd64` and `linux/arm64` architectures, including native ARM64 support for Apple Silicon Macs.
|
|
75
|
+
|
|
50
76
|
To run, mount the current working dir to the container and use a relative path to your spec, like so
|
|
51
77
|
|
|
52
78
|
```
|