Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 2.1 KB

DEV-CONTAINER.md

File metadata and controls

47 lines (31 loc) · 2.1 KB
Raw

Shopware Docs, CLI and DevContainer

You can try dev env provided by GitHub Codespaces or GitPod.

Setup

Because we need to clone multiple repositories, you need to generate a new SSH key or use your existing one. If you don't have a ed25519 key, you can generate it by running a command below:

$ ssh-keygen -t ed25519 -C "your.name@shopware.com"

Generate single-line base64 encoded value of your private key:

$ base64 ~/.ssh/id_ed25519 -w 0

This will allow you to clone all docs-content repos using SSH, and later commit changes to them.

GitHub: head to GitHub > Settings > Codespaces and add a new Codespace secret named GH_SWAG_SSH_PRIVATE_KEY and assign it to shopware/developer-portal repository.

GitPod: Head to User Settings > Variables and add a new variable named GH_SWAG_SSH_PRIVATE_KEY and assign it to shopware/developer-portal repository.

Make sure to also add the key to the GitHub > Settings > SSH and GPG keys.

$ cat ~/.ssh/id_ed25519

Post-install

Post-install script is triggered during the postCreateCommand lifecycle hook and:

  • installs (p)npm dependencies
  • builds Shopware Docs CLI
  • sets up SSH key provided during the setup step above
  • clones and symlinks all docs-content repos
  • starts dev server

You can then edit contents from the ./src/ folder and commit from the ./repos/<repo>-<branch> folders.

More resources