зеркало из https://github.com/github/freno-client.git
Update docucmentation and add bin/release
This commit is contained in:
Родитель
c59db08c9a
Коммит
1d6cc9f350
|
@ -12,8 +12,8 @@ Please note that this project is released with a [Contributor Code of Conduct][c
|
||||||
## Submitting a pull request
|
## Submitting a pull request
|
||||||
|
|
||||||
0. [Fork][fork] and clone the freno-client repository
|
0. [Fork][fork] and clone the freno-client repository
|
||||||
0. Configure and install the dependencies: `script/bootstrap`
|
0. Configure and install the dependencies: `bin/setup`
|
||||||
0. Make sure the tests pass on your machine: `rake`
|
0. Make sure the tests pass on your machine: `bin/test`
|
||||||
0. Create a new branch: `git checkout -b my-branch-name`
|
0. Create a new branch: `git checkout -b my-branch-name`
|
||||||
0. Make your change, add tests, and make sure the tests still pass
|
0. Make your change, add tests, and make sure the tests still pass
|
||||||
0. Push to your fork and [submit a pull request][pr]
|
0. Push to your fork and [submit a pull request][pr]
|
||||||
|
|
|
@ -5,4 +5,4 @@ WORKDIR /freno-client
|
||||||
|
|
||||||
COPY . .
|
COPY . .
|
||||||
|
|
||||||
CMD ["script/test"]
|
CMD ["bin/test"]
|
||||||
|
|
|
@ -355,7 +355,7 @@ end
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
After checking out the repo, run `script/bootstrap` to install dependencies. Then, run `script/test` to run the tests. You can also run `script/console` for an interactive prompt that will allow you to experiment.
|
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
@ -366,11 +366,11 @@ This repository is open to [contributions](CONTRIBUTING.md). Contributors are ex
|
||||||
If you are the current maintainer of this gem:
|
If you are the current maintainer of this gem:
|
||||||
|
|
||||||
1. Create a branch for the release: `git checkout -b cut-release-vx.y.z`
|
1. Create a branch for the release: `git checkout -b cut-release-vx.y.z`
|
||||||
1. Make sure your local dependencies are up to date: `script/bootstrap`
|
1. Make sure your local dependencies are up to date: `bin/setup`
|
||||||
1. Ensure that tests are green: `bundle exec rake test`
|
1. Ensure that tests are green: `bundle exec rake test`
|
||||||
1. Bump gem version in `lib/freno/client/version.rb`
|
1. Bump gem version in `lib/freno/client/version.rb`
|
||||||
1. Merge a PR to github/freno-client containing the changes in the version file
|
1. Merge a PR to github/freno-client containing the changes in the version file
|
||||||
1. Run `script/release`
|
1. Run `bin/release`
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,6 @@
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
IFS=$'\n\t'
|
||||||
|
set -vx
|
||||||
|
|
||||||
|
bundle exec rake release
|
Загрузка…
Ссылка в новой задаче