spryker-sdk / sdk Goto Github PK

License: Other

PHP 97.97% Shell 0.65% Dockerfile 0.55% JavaScript 0.54% Twig 0.30%

sdk's Introduction

Spryker SDK

The Spryker SDK aims to provide a single entry point to accelerate your productivity working with Spryker. No matter if you want to validate existing code, implement new features with Spryker or go live with your project, the Spryker SDK provides you the tools to fulfill your mission faster and cut out the boring parts of the development, so you can focus developing exciting features for your business case.

Installation

ensure auth file is available for composer (https://getcomposer.org/doc/articles/authentication-for-private-packages.md)
ensure docker & docker-compose is installed
Download the installer.sh from the latest release at https://github.com/spryker-sdk/sdk/releases
run installer.sh </path/to/install/sdk/in>
follow the installer's instructions.
alias spryker-sdk should be set and SPRYKER_SDK_PATH env variable should be exported. If not check our troubleshooting doc.

Installation into the current dir:

PATH_TO_SDK=$(pwd) \
&& curl -fL github.com/spryker-sdk/sdk/releases/latest/download/installer.sh -O \
&& chmod +x installer.sh \
&& ./installer.sh "${PATH_TO_SDK}" \
&& rm -f installer.sh \
&& if [ -e ~/.zshrc ]; then source ~/.zshrc; else source ~/.bashrc; fi; \
echo "Current SDK version: $(spryker-sdk --version)"

Update

Can be executed from any directory. The path will be taken from the SPRYKER_SDK_PATH env variable

curl -fL github.com/spryker-sdk/sdk/releases/latest/download/installer.sh -O \
&& chmod +x installer.sh \
&& ./installer.sh --self-update \
&& rm -f installer.sh \
&& echo "Current SDK version: $(spryker-sdk --version)"

Getting started

To get an overview on the available capabilities of the Spryker SDK please run spryker-sdk list

Any task can be executed by running spryker-sdk <task-id> from project root folder. Using bin/consolespryker-sdk <task-id> -h will give a description on what options can be passed into the task.

Extending the SDK capabilities

Pleaser refer to the extension documentation for further information on how to extend the SDK. Extensions to the SDK should follow the SDK conventions. For maintaining an extension of the SDK please refer to the lifecycle management.

PhpStorm Command Line Tools

Please refer to the phpstorm integration documentation for further information on how to integrate the SDK to PhpStorm.

Running the SDK as a developer

Running the SDK in a development or debug mode is documented at development documentation

sdk's People

Stargazers

Watchers

Forkers

newloki andrea-taini amansilla spryker-projects

sdk's Issues

Please fix src/

See https://release.spryker.com/package-integration/view/spryker-sdk/sdk/60894544b1f325fcde3f51db03571b26829c82e9

should be in ROOT/resources/ as per rules

naming

php bin/spryker-sdk run {task} --tags=sniff,architecture ... - runs task and run other with tags

this doesnt make sense, sniff itself has no meaning

it means probably: style,architecture

AddCrudFacade is not exists at Spryker SDK

I'm trying to run AddCrud spryk but I can't find it in Spryker SDK
you can see that I'm using the latest version of it

Path in neon file

https://github.com/spryker-sdk/sdk/blob/master/composer.json#L106
should be

paths:
    -  src/

in neon file instead

Installation recipe for 0.6.5 broken

After running the installer as described in the Readme file the spryker-sdk can not be used since the following error happened.

PATH_TO_SDK=$(pwd) \
&& curl -fL github.com/spryker-sdk/sdk/releases/latest/download/installer.sh -O \
&& chmod +x installer.sh \
&& ./installer.sh "${PATH_TO_SDK}" \
&& rm -f installer.sh \
&& if [ -e ~/.zshrc ]; then source ~/.zshrc; else source ~/.bashrc; fi; \
echo "Current SDK version: $(spryker-sdk --version)"
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
  0     0    0     0    0     0      0      0 --:--:--  0:00:01 --:--:--     0
  0     0    0     0    0     0      0      0 --:--:--  0:00:10 --:--:--     0
  0     0    0     0    0     0      0      0 --:--:--  0:00:10 --:--:--     0
100  8105  100  8105    0     0    746      0  0:00:10  0:00:10 --:--:-- 40934

Spryker SDK Installer

SDK installation
SDK destination path: /Users/antoniomansillaarroyo/workspace/sc-b2b-mp-demo
stat /Users/antoniomansillaarroyo/workspace/sc-b2b-mp-demo/docker-compose.dev.yml: no such file or directory
stat /Users/antoniomansillaarroyo/workspace/sc-b2b-mp-demo/docker-compose.dev.yml: no such file or directory
Created alias in ~/.zshrc
Current SDK version: 0.6.5

This is the second time that after just installing the SDK you are not able to run any single command.

I suggest in this case not only fixing the issue but also adding a GitHub installation testing workflow to avoid this happening again in the future.

SDK gets stuck right after asking for repo info

I am trying to set up (and test) the sdk.

I have followed this documentation and steps:

https://docs.spryker.com/docs/sdk/dev/spryker-sdk.html#installation

I can use the sdk commands, but when trying to run spryker-sdk sdk:workflow:run (previously I executed the spryker-sdk sdk:init:project --workflow=app ) it is getting stuck right after asking for the git repository.

The output I see on the logs is:
{"message":"Unable` to read the file /project/composer.json: file_get_contents(/project/composer.json): Failed to open stream: No such file or directory","context":{},"level":400,"level_name":"ERROR","channel":"error_logger","datetime":"2022-11-14T15:13:37.967969+00:00","extra":{}} {"message":"The command \"'git' 'remote' 'get-url' '--push' 'origin'\" failed.\n\nExit Code: 128(Invalid exit argument)\n\nWorking directory: /project\n\nOutput:\n================\n\n\nError Output:\n================\nfatal: not a git repository (or any parent up to mount point /)\nStopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).\n","context":{},"level":400,"level_name":"ERROR","channel":"error_logger","datetime":"2022-11-14T15:13:38.065658+00:00","extra":{}}

composer.json file does exist, and I see no issues on permissions (can this be a race condition issue?).
When I try to run git remote get-url --push origin I get the correct ouptut (appTest.git), so I am not sure why the sdk is showing this error.

When trying to rerun the command, this is the error output on the terminal.

Can someone point me in the right direction?

namespace

this is the only repo that doesnt follow our rules regarding the namespace

I recommend renaming
a ) repo to https://github.com/spryker-sdk/sdk
b) use the corresponding psr4 namespace for it to fit to it and tooling: SprykerSdk/Sdk

"autoload": {
    "psr-4": {
        "SprykerSdk\\Sdk\\": "src/"
    }
}

A module with such a name will never exist, so using this namespace is fine.

Extension is not following PSR standards

https://github.com/spryker-sdk/sdk/blob/master/composer.json#L95

There are several violations here that need to get fixed:
https://github.com/spryker-sdk/sdk/tree/master/extension/Hello

src/ must contain PHP files
resources/ must contain config/yaml files etc, maybe config/ is OK if that is specific to that
https://github.com/spryker-sdk/sdk/blob/master/extension/Hello/HelloBundle.php would then be /src/HelloBundle.php

Then proper PSR would be

"Hello\\": "extension/Hello/src/"