Skip to content

Commit

Permalink
Add instructions for internal processes, update version in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
inkstak committed Aug 11, 2023
1 parent c884fb4 commit 61b55a4
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 1 deletion.
21 changes: 21 additions & 0 deletions release_instruction.md
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.
2 changes: 1 addition & 1 deletion retype.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ url: https://mon-territoire.github.io/caoutsearch

branding:
title: Caoutsearch
label: 0.0.6
label: 0.0.7

meta:
title: " | Caoutsearch"
Expand Down
3 changes: 3 additions & 0 deletions retype_instruction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Retype instructions

Use [retype](https://retype.com/) to build documentation.

0 comments on commit 61b55a4

Please sign in to comment.