This repository was archived by the owner on Apr 11, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 14
docs: document Codespaces composer authorization step #68
Open
MateusDadalto
wants to merge
2
commits into
master
Choose a base branch
from
devcontainer-composer-auth
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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 | ||
|
|
||
| #### Local devcontainer | ||
|
|
||
| First check to see if you have a credentials file under `~/.composer/auth.json`. | ||
|
|
||
|
|
@@ -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 | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you drop a screenshot in there? |
||
|
|
||
| ### Per-project configuration | ||
| We recommend using `auth.json` in your user's directory, but when you're working on multiple Magento 2 applications at once, you may need multiple `auth.json`. You can simply add the `auth.json` to the root of your Magento 2 project after project creation, and composer will use those credentials instead. | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?