https://github.com/aligent/magento-cloud-deploy-pipe
https://github.com/aligent/magento-cloud-deploy-pipe
pipe
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/aligent/magento-cloud-deploy-pipe
- Owner: aligent
- License: gpl-3.0
- Created: 2021-11-09T03:04:07.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-02T02:38:36.000Z (about 2 years ago)
- Last Synced: 2025-02-16T13:23:59.816Z (over 1 year ago)
- Topics: pipe
- Language: Shell
- Homepage:
- Size: 40 KB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Aligent Magento Cloud Deploy Pipe
This pipe is used to relay commits to Magento Cloud to trigger deployments.
## YAML Definition
Add the following your `bitbucket-pipelines.yml` file:
```yaml
- step:
name: "Git commit relay"
script:
- pipe: docker://aligent/magento-cloud-deploy-pipe:latest
variables:
MAGENTO_CLOUD_REMOTE: "user@git-remote.git"
```
## Variables
| Variable | Usage |
| --------------------- | ----------------------------------------------------------- |
| MAGENTO_CLOUD_REMOTE | The git remote where commits will be relayed|
| NR_APP_ID | (Optional) The NewRelic App ID the deployment marker will be created in|
| NR_USER_KEY | (Optional) The NewRelic User Key for API Calls |
| NR_ALERT_MUTING_RULE_ID | (Optional) The NewRelic Alert Mute Rule ID used for suppressing alerts during deployment|
| NR_ACCOUNT_ID | (Optional) The NewRelic Account ID that the deployment will suppress the alerts|
| MAGENTO_CLOUD_CLI_TOKEN | (Optional) Magento Cloud Deploy User API token, for automatic redeploy on transient failure|
| DEBUG | (Optional) Turn on extra debug information. Default: `false`. |
* Note that you need `nr-deployment.json.template` file under the project root with the content below to enable the NR deployment marker:
```
{
"deployment": {
"revision": "GITSHA"
}
}
```
## Development
Commits published to the `main` branch will trigger an automated build for the `latest` tag in DockerHub