README.md in uffizzi-cli-0.2.2 vs README.md in uffizzi-cli-0.3.2

- old
+ new

@@ -27,39 +27,66 @@ - Postgres database - Redis cache ## Installation -Add this line to your application's Gemfile: +Add this line to your application's `Gemfile`: ```ruby -gem 'uffizzi' +gem 'uffizzi-cli' ``` And then execute: $ bundle install Or install it yourself as: - $ gem install uffizzi + $ gem install uffizzi-cli +### Docker image + +We also provide an image on Docker Hub: + +```bash +docker run -it --rm uffizzi/cli project list +``` + +If you specify the following environment variables, the Docker image's +entrypoint script can log you into Uffizzi before executing your command. + +- `UFFIZZI_USER` +- `UFFIZZI_HOSTNAME` +- `UFFIZZI_PASSWORD` +- `UFFIZZI_PROJECT` (optional) + ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org). Run rubocop: `bundle exec rubocop -A` +## Testing + +Run tests: +`bundle exec rake test` + +Run tests from a file: +`bundle exec rake test TEST=test/uffizzi/cli/preview_test.rb` + +Run single test +`bundle exec rake test TEST=test/uffizzi/cli/preview_test.rb TESTOPTS="--name=test_name"` + ## Commands ### login ``` -$ uffizzi login -u your@email.com --hostname localhost:8080 +$ uffizzi login --user your@email.com --hostname localhost:8080 ``` Logging you into the app which you set in the hostname option. ### login options @@ -165,19 +192,19 @@ 4. Make changes you need for the feature, commit them to the repo ``` git add . git commit -m 'short commit description' (e.g. git commit -m 'added domain settings') -git push origin FEATURE_NAME +git push origin BRANCH_NAME ``` 4. You already can create PR with develop branch as a target. Once the feature is ready let us know in the channel - we will review 5. Merge your feature to `qa` branch and push. Ensure your pipeline is successful ``` git checkout qa git pull --rebase qa -git merge --no-ff FEATURE_NAME +git merge --no-ff BRANCH_NAME git push origin qa ``` ## Contributing