chore(readme): add simple readme file
This commit is contained in:
parent
0592e6aa27
commit
0dbd23b047
1 changed files with 27 additions and 0 deletions
27
README.md
Normal file
27
README.md
Normal 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 |
|
||||||
Loading…
Add table
Add a link
Reference in a new issue