Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: document Codespaces composer authorization step #68

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

MateusDadalto
Copy link
Contributor

@MateusDadalto MateusDadalto commented Aug 5, 2022

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Fixes: #50

What is the new behavior?

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

@@ -33,6 +35,10 @@ If you don't see your credentials there, [you can follow the Magento 2 guide to
cp /path/to/magento/project/auth.json.sample ~/.composer/auth.json
```

#### Codespaces configuration
Github Codespaces allows you to create secret environment variables that are injected in your container when it is created.
To do so, go to **Settings -> Codespaces** and there you'll see a `Codespaces secrets` section. Click on New Secret, name it **`COMPOSER_AUTH`** and put the complete authorization json in the value
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you drop a screenshot in there?

@@ -17,7 +17,9 @@ git clone https://www.github.com/graycoreio/mage2docker \
[The process of creating a Magento account is fully documented by Magento and you should follow their process](https://docs.magento.com/m2/ce/user_guide/magento/magento-account-create.html).

### Configuring Composer
In case you have not done so, we will add your Magento composer authentication credentials to your user's local `auth.json`.
In case you have not done so, we will add your Magento composer authentication credentials to your user's local `auth.json`. Alternatively, if you are using codespaces you can create a new secret that will be injected in your container
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you link to the two modes?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] Add step for adding COMPOSER_AUTH to dolphin docs
2 participants