updated README
This commit is contained in:
parent
fdfe07896d
commit
740f2c8939
37
README.md
37
README.md
@ -17,7 +17,7 @@ It provides an integration with Drone CI promote feature to trigger a pipeline r
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
drone:
|
drone:
|
||||||
url: https://drone.yourserver.de
|
url: https://YOUR.DRONE.SERVER
|
||||||
token: <your drone access token>
|
token: <your drone access token>
|
||||||
owner: <the owner of the git repository>
|
owner: <the owner of the git repository>
|
||||||
project: <the git project>
|
project: <the git project>
|
||||||
@ -27,6 +27,7 @@ drone:
|
|||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### Permissions
|
### Permissions
|
||||||
|
|
||||||
There are just two permissions:
|
There are just two permissions:
|
||||||
@ -34,6 +35,40 @@ There are just two permissions:
|
|||||||
- **manage.view** - provides access to the Drone deploy list
|
- **manage.view** - provides access to the Drone deploy list
|
||||||
- **manage.deploy** - provides access to trigger a new deploy
|
- **manage.deploy** - provides access to trigger a new deploy
|
||||||
|
|
||||||
|
### Drone CI pipeline example
|
||||||
|
|
||||||
|
- **.drone.yml** in your git repository
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
kind: pipeline
|
||||||
|
name: default
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: deploy website
|
||||||
|
image: alpine
|
||||||
|
commands:
|
||||||
|
# your deploy commands here
|
||||||
|
- echo Hello World
|
||||||
|
when:
|
||||||
|
event: [ promote ]
|
||||||
|
environment: [ website ]
|
||||||
|
```
|
||||||
|
|
||||||
|
- **config.yml** in your Cockpit config folder for an example project *myorganization/myproject*
|
||||||
|
|
||||||
|
```yml
|
||||||
|
...
|
||||||
|
|
||||||
|
drone:
|
||||||
|
url: https://YOUR.DRONE.SERVER
|
||||||
|
owner: myorganization
|
||||||
|
project: myproject
|
||||||
|
branch: master
|
||||||
|
environment: website
|
||||||
|
token: XXXXXXXXXXXXXXXXXXXXX
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Having the configuration defined accessing the Drone deploys page (/drone/deploys) a list of latest (limited to 50) deploys is displayed:
|
Having the configuration defined accessing the Drone deploys page (/drone/deploys) a list of latest (limited to 50) deploys is displayed:
|
||||||
|
Loading…
Reference in New Issue
Block a user