This repository has been archived by the owner on Nov 19, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into issue-6912
- Loading branch information
Showing
47 changed files
with
2,265 additions
and
2,082 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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 |
---|---|---|
@@ -1,56 +1,56 @@ | ||
{:.procedure} | ||
To get started with environment branches: | ||
|
||
1. Log in to your local development system, or switch to, the [Magento file system owner]({{ site.baseurl }}/cloud/before/before-workspace-file-sys-owner.html). | ||
1. Change to a directory to which the Magento file system owner has write access. | ||
1. Enter the following command in a terminal to log in to your project: | ||
1. On your local workstation, change to your Cloud project directory. | ||
|
||
```bash | ||
magento-cloud login | ||
``` | ||
1. Switch to the [Magento file system owner]({{ site.baseurl }}/cloud/before/before-workspace-file-sys-owner.html). | ||
|
||
1. List your projects. With the project ID, you can complete additional commands. | ||
1. Log in to your Magento project. | ||
|
||
```bash | ||
magento-cloud project:list | ||
magento-cloud login | ||
``` | ||
|
||
1. If necessary, clone the project to your local. You should have cloned when setting up your local development workspace. | ||
1. List your projects. | ||
|
||
```bash | ||
magento-cloud project:get <project ID> | ||
magento-cloud project:list | ||
``` | ||
|
||
1. Change to a project directory. For example, `cd /var/www/html/magento2` | ||
1. List environments in the project. Every environment includes an active Git branch of your code, database, environment variables, configurations, and services. | ||
1. List environments in the project. Every environment includes an active Git branch that contains your code, database, environment variables, configurations, and services. | ||
|
||
```bash | ||
magento-cloud environment:list | ||
``` | ||
|
||
{:.bs-callout-info} | ||
`magento-cloud environment:list`—displays environment hierarchies whereas the `git branch` command does not. | ||
It is important to use the `magento-cloud environment:list` command because it displays environment hierarchies, whereas the `git branch` command does not. | ||
|
||
1. Fetch origin branches to get the latest code: | ||
1. Fetch origin branches to get the latest code. | ||
|
||
```bash | ||
git fetch origin | ||
``` | ||
|
||
1. Check out, or switch to, a specific branch and environment. Git commands only checkout the Git branch. The Magento Cloud command also switches to the active environment. | ||
1. Checkout, or switch to, a specific branch and environment. | ||
|
||
```bash | ||
magento-cloud environment:checkout <environment ID> | ||
magento-cloud environment:checkout <environment-ID> | ||
``` | ||
|
||
To create a new environment, use `magento-cloud environment:branch <environment name> <parent environment ID>` | ||
Git commands only checkout the Git branch. The `magento-cloud checkout` command checks out the branch and switches to the active environment. | ||
|
||
{:.bs-callout-tip} | ||
You can create a new environment branch using the `magento-cloud environment:branch <environment-name> <parent-environment-ID>` command syntax. It may take some additional time to create and activate a new environment branch. | ||
|
||
1. Pull any updated code to your local for the environment ID (which is the Git branch): | ||
1. Use the environment ID to pull any updated code to your local. This is not necessary if the environment branch is new. | ||
|
||
```bash | ||
git pull origin <environment ID> | ||
git pull origin <environment-ID> | ||
``` | ||
|
||
1. Create a [snapshot]({{ site.baseurl }}/cloud/project/project-webint-snap.html) of the environment as a backup: | ||
1. (_Optional_) Create a [snapshot]({{ site.baseurl }}/cloud/project/project-webint-snap.html) of the environment as a backup. | ||
|
||
```bash | ||
magento-cloud snapshot:create -e <environment ID> | ||
magento-cloud snapshot:create -e <environment-ID> | ||
``` |
This file contains 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 |
---|---|---|
@@ -1,30 +1,36 @@ | ||
This section discusses how to get a module's Composer name and its version from Magento Marketplace. Alternatively, you can find the name and version of *any* module (whether or not you purchased it on Marketplace) in the module's `composer.json` file. Open `composer.json` in a text editor and write down the values of `"name"` and `"version"`. | ||
## Composer name of an extension | ||
|
||
Although this section discusses how to get the Composer name and version of an extension or module from Magento Marketplace, you can find the name and version of *any* module (whether or not you purchased it on Marketplace) in the Composer file of the module. Open the `composer.json` file in a text editor and note the `"name"` and `"version"` values. | ||
|
||
{:.procedure} | ||
To get the module's Composer name from Magento Marketplace: | ||
To get the Composer name of a module from the Magento Marketplace: | ||
|
||
1. Log in to [Magento Marketplace](https://marketplace.magento.com) with the username and password you used to purchase the component. | ||
1. In the upper right corner, click **<your username>** > **My Account** as the following figure shows. | ||
|
||
1. In the upper right corner, click **Username** > **My Account**. | ||
|
||
![Access your Marketplace account]({{ site.baseurl }}/common/images/cloud_marketplace-account.png){:width="650px"} | ||
|
||
1. On the My Account page, click **My Purchases** as the following figure shows. | ||
1. On the _My Account_ page, click **My Purchases**. | ||
|
||
![Marketplace purchase history]({{ site.baseurl }}/common/images/cloud_marketplace-purch-history.png){:width="650px"} | ||
|
||
1. On the My Purchases page, click **Technical Details** for the module you purchased as the following figure shows. | ||
1. On the _My Purchases_ page, click **Technical Details** for the module you purchased. | ||
|
||
![Technical details shows the module's Composer name]({{ site.baseurl }}/common/images/cloud_marketplace-download-invoice.png){:width="200px"} | ||
|
||
1. Click **Copy** to copy the component name to the clipboard. | ||
1. Open a text editor. | ||
1. Paste the module name in the text editor. | ||
|
||
1. Open a text editor and paste the module name. | ||
|
||
1. Append a colon character (`:`) to the component name. | ||
1. In **Technical Details** on the My Purchases page, click **Copy** to copy the version to the clipboard. | ||
|
||
1. In **Technical Details** on the _My Purchases_ page, click **Copy** to copy the version to the clipboard. | ||
|
||
1. Append the version number to the component name after the colon. | ||
|
||
A sample follows: | ||
|
||
```text | ||
pixlee/magento2:1.0.1 | ||
``` | ||
``` |
This file contains 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 |
---|---|---|
@@ -0,0 +1,2 @@ | ||
{:.bs-callout-tip} | ||
We highly recommend that you have your Magento application fully deployed to an Integration or Staging environment before attempting to add a module. Always work in a development branch when adding a module to your implementation. If you do not have a branch, see [Get started creating branches]({{ site.baseurl }}/cloud/env/environments-start.html#getstarted). |
This file contains 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
This file contains 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
Oops, something went wrong.