Skip to content
This repository was archived by the owner on May 30, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/references/deploy.yml.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ Field |Type |Required |Description
`required_contexts` |*[]string* |`false` |This field allows you to specify a subset of contexts that must be success.
`payload` |*object* or *string* |`false` |This field is JSON payload with extra information about the deployment.
`production_environment` |*boolean* |`false` |This field specifies whether this runtime environment is production or not.
`deployable_ref` |*string* |`false` |This field specifies which the ref(branch, SHA, tag) is deployable or not. It supports the regular expression, [re2](https://github.com/google/re2/wiki/Syntax) by Google, to match the ref.
`auto_deploy_on` |*string* |`false` |This field controls auto-deployment behaviour given a ref(branch, SHA, tag). It supports the regular expression, [re2](https://github.com/google/re2/wiki/Syntax) by Google, to match the ref.
`deployable_ref` |*string* |`false` |This field specifies which the ref(branch, SHA, tag) is deployable or not. It supports the regular expression ([re2]((https://github.com/google/re2/wiki/Syntax))).
`auto_deploy_on` |*string* |`false` |This field controls auto-deployment behaviour given a ref(branch, SHA, tag). If any new push events are detected on this event, the deployment will be triggered. It supports the regular expression ([re2](https://github.com/google/re2/wiki/Syntax)). E.g. `refs/heads/main` or `refs/tags/v.*`
`review` |*[Review](#review)* |`false` |This field configures review.

## Review
Expand Down
14 changes: 14 additions & 0 deletions docs/tasks/usecases.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,20 @@ envs:
production_environment: true
```

## Auto deployment

If you want to enable the auto-deployment when the pull request is merged into the main branch, you should configure the `auto_deploy_on` field like the below.

```yaml
envs:
- name: production
auto_merge: true
required_contexts: []
auto_deploy_on: refs/heads/main
deployable_ref: main
production_environment: true
```

## Questions?

We are always happy to help with questions you might have. You can post questions or comments to our [community](https://github.com/gitploy-io/gitploy/discussions).
Expand Down