README.md in aptly_cli-0.3.1 vs README.md in aptly_cli-0.3.2

- old
+ new

@@ -118,11 +118,11 @@ aptly-cli DESCRIPTION: - Aptly repository API client + Aptly repository API client (https://github.com/sepulworld/aptly_cli) COMMANDS: file_delete File delete file_list List all directories @@ -153,17 +153,20 @@ -c, --config FILE Path to YAML config file -s, --server SERVER - Host name or IP address + Host name or IP address of Aptly API server + -p, --port PORT + Port of Aptly API server + --username USERNAME - User name + User name or '${PROMPT}' --password PASSWORD - Password + Password or '${PROMPT_PASSWORD}' or '${KEYRING}' --debug Enable debug output -h, --help @@ -181,26 +184,57 @@ $ aptly-cli <command> --help ## Development -After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. +### Measuring coverage locally +``` +$ rake docker_pull +$ rake docker_run +$ bundle exec rake test +... +Coverage report generated for Unit Tests to /Users/marca/dev/git-repos/aptly_cli/coverage. 521 / 566 LOC (92.05%) covered. +[Coveralls] Outside the CI environment, not sending data. + +$ open coverage/index.html +``` + +<img width="1426" alt="screen shot 2016-07-21 at 4 05 56 pm" src="https://cloud.githubusercontent.com/assets/305268/17042294/2f28f8f8-4f61-11e6-8a92-f0d921e36187.png"> + +### Rubocop syntax and style check + +```bash +$ bundle exec rake rubocop +Running RuboCop... +Inspecting 24 files +WCCCWC..CCCC.CCC.WCWCCCC +... +``` + 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). Ruby Minitest are implemented using a Docker container for functional tests. Rake tasks available: ```bash -rake build # Build aptly_cli-<version>.gem into the pkg directory -rake docker_build # Docker build image -rake docker_list_aptly # List Docker Aptly running containers -rake docker_run # Start Aptly Docker container on port 8082 -rake docker_stop # Stop running Aptly Docker containers -rake install # Build and install aptly_cli-<version>.gem into system gems -rake install:local # Build and install aptly_cli-<version>.gem into system gems without network access -rake test # Run tests +rake build # Build aptly_cli-<version>.gem into the pkg directory +rake clean # Remove any temporary products +rake clobber # Remove any generated files +rake docker_build # Docker build image +rake docker_list_aptly # List Docker Aptly running containers +rake docker_pull # Pull Docker image to Docker Hub +rake docker_push # Push Docker image to Docker Hub +rake docker_restart # Restart Aptly docker container +rake docker_run # Start Aptly Docker container on port 8082 +rake docker_show_logs # Show running Aptly process Docker stdout logs +rake docker_stop # Stop running Aptly Docker containers +rake install # Build and install aptly_cli-<version>.gem into system gems +rake install:local # Build and install aptly_cli-<version>.gem into system gems without network access +rake rubocop # Run RuboCop +rake rubocop:auto_correct # Auto-correct RuboCop offenses +rake test # Run tests ``` ## Contributing