Skip to content

Commit 6b6346c

Browse files
refactor docker implementation and update Readme
1 parent fd61483 commit 6b6346c

File tree

3 files changed

+18
-17
lines changed

3 files changed

+18
-17
lines changed

Dockerfile

Lines changed: 0 additions & 11 deletions
This file was deleted.

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,21 @@ The extra `credential_process` config line tells AWS to [Source Credentials with
9393

9494
## Development
9595

96-
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
96+
Prerequisites:
9797

98-
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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
98+
* Ruby 3.0.5
99+
100+
You can have Ruby installed locally, or use Docker and mount this repository into a Ruby container. By using Docker you can avoid conflicts with differing Ruby versions or other installed gems. To run and 'bash' into a Ruby container, install Docker and run the following. See [docker-compose.yml](docker-compose.yml) for details, or to experiment with different Ruby versions.
101+
102+
```
103+
docker compose run ruby
104+
```
105+
106+
With either option, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
107+
108+
To install this gem onto your local machine, run `bundle exec rake install`.
109+
110+
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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
99111

100112
## Contributing
101113

docker-compose.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
version: '3'
22
services:
33
ruby:
4-
build: .
4+
image: ruby:3.0.5
55
volumes:
6-
- .:/app # Map the current directory to /app inside the container
7-
stdin_open: true
8-
tty: true
6+
- .:/app
7+
working_dir: /app
8+
command: bash

0 commit comments

Comments
 (0)