Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (39 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

62 lines (39 loc) · 1.26 KB

Contributing

Development of the Legacy CLI happens in public in the GitHub repository.

Issues and pull requests submitted via GitHub are very welcome.

The principal Upsun CLI repository is: https://github.com/platformsh/cli

Developing locally

If you clone this repository locally, you can build it with:

composer install

Run the CLI from the local source with:

./bin/platform

Run tests with:

./scripts/test/unit.sh

Developing in a docker container

If you don't have PHP installed locally or for other reasons want to do development on the CLI inside a docker container, follow this procedure:

Create a .env file based on the default one

cp .env-dist .env

You should ensure that the UID and GUI used inside the container matches your local user to avoid file permission problems. To get the UID and GID for local user, run:

id

If your uid and gid is not 1000, then alter USER_ID and GROUP_ID in .env accordingly.

Next, build and start your container

docker-compose up -d

Attach to the running container

docker-compose exec cli bash

Now you may run the steps mentioned in "Developing locally" inside the container.