Skip to content

Commit dee9504

Browse files
authored
Merge pull request #21 from ByteInternet/update_readme
Update README.md
2 parents 0746804 + c013213 commit dee9504

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Change configuration matching you use case, and refer to the documentation for o
2222
3. Setup your CI server
2323
1. GitLab CI [templates/.gitlab-ci.yml](./templates/.gitlab-ci.yml).
2424
2. Bitbucket [templates/bitbucket-pipelines.yml](./templates/bitbucket-pipelines.yml).
25-
3. **Github Actions workflow coming soon!**
25+
3. Github Actions [templates/github-actions.yml](./templates/github-actions.yml).
2626
4. For Magento 2 your first build will fail due to missing configuration. Login to the server and depending on your project file edit
2727
the `app/etc/env.php` or `app/etc/local.xml`. You will find these files in `~/apps/<domain>/shared/`.
2828

@@ -122,7 +122,7 @@ Available templates:
122122
Example usage:
123123
`$configuration = new Magento2('git@git.foo.bar:magento-2/project.git', ['nl_NL'], ['nl_NL'])`
124124

125-
## Required environment variables
125+
## Environment variables
126126
Some specific environment variables are required to allow the deploy image access to the git repository
127127
or to be able to send out notifications.
128128

@@ -134,6 +134,16 @@ and the SSH user. Must be base64 encoded like this:
134134
cat ~/.ssh/deploy_key | base64
135135
```
136136

137+
### Optional
138+
- `DEPLOY_COMPOSER_AUTH` Composer auth.json contents. This file is required if you require access to specific Composer
139+
repositories like Magento's, 3rd party vendors, or even your own private Composer package repository. If this environment
140+
variable does not exist, no `auth.json` will be written, so it is optional.
141+
The auth.json must be base64 encoded like this:
142+
143+
``` bash
144+
cat auth.json | base64
145+
```
146+
137147
## Testing
138148
To test your build & deploy you can run your deploy locally.
139149

0 commit comments

Comments
 (0)