-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add instructions for internal processes, update version in documentation
- Loading branch information
Showing
3 changed files
with
25 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Release instructions | ||
|
||
Use [gem_release](https://github.com/svenfuchs/gem-release) to publish new versions. | ||
|
||
First, create a new tag with one of the following command: | ||
```shell | ||
gem bump --push # Create a new patch | ||
gem bump --push --version minor | ||
gem bump --push --version major | ||
``` | ||
|
||
**Don't forget to add the new version to `retype.yml`!** (until we figure out how to automate this step). | ||
|
||
Then, publish the version on rubygem: | ||
|
||
```shell | ||
gem release | ||
``` | ||
|
||
Caoutsearch is still under developement, so we don't take time to communicate changes on every release. | ||
When it'll be ready for public diffusion, add a release on github. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Retype instructions | ||
|
||
Use [retype](https://retype.com/) to build documentation. |