chore(readme): add simple readme file
All checks were successful
ci/woodpecker/push/build/2 Pipeline was successful
ci/woodpecker/push/build/1 Pipeline was successful
ci/woodpecker/push/build/3 Pipeline was successful

This commit is contained in:
pips 2025-07-31 00:36:12 +02:00
parent 0592e6aa27
commit 0dbd23b047

27
README.md Normal file
View file

@ -0,0 +1,27 @@
# golang-vendor-private
CI plugin to retrieve private go modules in local vendor folder.
Tested with woodpecker-ci >= 3
## Sample
```yaml
steps:
- name: vendor
image: forge.e5150.fr/ci-plugins/golang-vendor-private:latest
settings:
goprivate: forge.e5150.fr
login:
from_secret: test-username
password:
from_secret: test-token
```
## Settings
| Settings name | Type | Description |
| --------------- | --------------- | --------------- |
| `goprivate` | string | pattern for private go modules |
| `login` | string | login to access repository |
| `password` | string | password to access repository |