Skip to content

CT-2209 improve readme#75

Merged
jirkasemmler merged 10 commits intomainfrom
jirka/ct-2209-improve-readme
Aug 27, 2025
Merged

CT-2209 improve readme#75
jirkasemmler merged 10 commits intomainfrom
jirka/ct-2209-improve-readme

Conversation

@jirkasemmler
Copy link
Copy Markdown
Contributor

Changes:

  • reorganize readme by topics

  • add instructions for development/usage

  • let AI generate docs for missing commands


Additional notes

⚠️ Don't forget to release new version after merge

Comment thread README.md Outdated
`docker run --rm -it keboola/cli-utils php ./cli.php`
`docker run --rm -it keboola/cli-utils php ./cli.php <commands>`

### Running locally and local development
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Running locally

  1. clone the repo
  2. (optional for manage:mass-project-remove-expiration) init .env file cp .env.dist .env and fill variables
  3. build the image docker compose build app
  4. run a command docker compose run --rm app <command>

Development

  1. clone the repo
  2. (optional for manage:mass-project-remove-expiration) init .env file cp .env.dist .env and fill variables
  3. build the image docker compose build dev
  4. update the code
  5. run a command docker compose run --rm dev <command> (run composer install for you automaticaly)

I think we should use docker compose when we have this setup done and do not mess with lover docker command

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you don't even need php cli.php in front of command as running cli.php is part of docker compose setup

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • I have added the .env to app service (otherwise it would be ignored) -> so the .env file is required -> added to the steps
  • the php cli.php is needed because we don't have entrypoint but command in docker-compose.yml
  • I have split the running locally and development as you suggest, good point
  • I still would keep the docker run for cases when you dont want to build the image locally (which you technically should not, if you simply want to use it as is)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vojtabiberle I have made some modifications, thats why the new review requested

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks OK for me

@jirkasemmler jirkasemmler merged commit efd663d into main Aug 27, 2025
1 check passed
@jirkasemmler jirkasemmler deleted the jirka/ct-2209-improve-readme branch August 27, 2025 10:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants