-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Also unbounds `./docs/RELEASE.ru.md`, to not bump version there everytime
- Loading branch information
Showing
5 changed files
with
52 additions
and
49 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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 |
---|---|---|
|
@@ -46,8 +46,8 @@ Download and unzip the archive for the desired architecture. | |
|
||
Universal executable: | ||
```shell | ||
curl -sLO https://binary.picodata.io/repository/raw/genin/bin/genin-0.5.7-x86_64-musl.tar.gz | ||
tar -xvf genin-0.5.7-x86_64-musl.tar.gz ; sudo install genin /usr/local/bin/ | ||
curl -sLO https://binary.picodata.io/repository/raw/genin/bin/genin-0.5.8-x86_64-musl.tar.gz | ||
tar -xvf genin-0.5.8-x86_64-musl.tar.gz ; sudo install genin /usr/local/bin/ | ||
``` | ||
|
||
--- | ||
|
@@ -84,11 +84,11 @@ sudo yum install -y genin | |
2. If you want to install `rpm` packages directly without | ||
adding our repository. | ||
```shell | ||
sudo rpm -i https://binary.picodata.io/repository/yum/el/8/x86_64/os/genin-0.5.7-1.el8.x86_64.rpm | ||
sudo rpm -i https://binary.picodata.io/repository/yum/el/8/x86_64/os/genin-0.5.8-1.el8.x86_64.rpm | ||
``` | ||
RHEL 7.x, CentOS 7.x | ||
```shell | ||
sudo rpm -i https://binary.picodata.io/repository/yum/el/7/x86_64/os/genin-0.5.7-1.el7.x86_64.rpm | ||
sudo rpm -i https://binary.picodata.io/repository/yum/el/7/x86_64/os/genin-0.5.8-1.el7.x86_64.rpm | ||
``` | ||
|
||
--- | ||
|
@@ -116,7 +116,7 @@ sudo apt install -y genin | |
2. Downloading and installing the package directly: | ||
```shell | ||
curl -sLO https://binary.picodata.io/repository/raw/genin/deb/genin-0.5.7.amd64.deb && sudo dpkg -i genin-0.5.7.amd64.deb | ||
curl -sLO https://binary.picodata.io/repository/raw/genin/deb/genin-0.5.8.amd64.deb && sudo dpkg -i genin-0.5.8.amd64.deb | ||
``` | ||
--- | ||
|
@@ -142,7 +142,7 @@ sudo apt install -y genin | |
2. Downloading and installing the package directly: | ||
```shell | ||
curl -sLO https://binary.picodata.io/repository/raw/genin/deb/genin-0.5.7.amd64.deb && sudo dpkg -i genin-0.5.7.amd64.deb | ||
curl -sLO https://binary.picodata.io/repository/raw/genin/deb/genin-0.5.8.amd64.deb && sudo dpkg -i genin-0.5.8.amd64.deb | ||
``` | ||
--- | ||
|
@@ -162,8 +162,8 @@ brew install genin | |
Use the following command to grab and install Genin in macOS (10.10+) wihtout | ||
homebrew: | ||
```shell | ||
curl -L https://binary.picodata.io/repository/raw/genin/apple/genin-0.5.7-darwin-amd64.zip -o genin-0.5.7-darwin-amd64.zip | ||
unzip genin-0.5.7-darwin-amd64.zip -d ~/bin/ | ||
curl -L https://binary.picodata.io/repository/raw/genin/apple/genin-0.5.8-darwin-amd64.zip -o genin-0.5.8-darwin-amd64.zip | ||
unzip genin-0.5.8-darwin-amd64.zip -d ~/bin/ | ||
``` | ||
> **Note:** The application can then be found under the `~/bin` directory. | ||
> Make sure the directory is in your `$PATH`. | ||
|
@@ -181,8 +181,8 @@ brew install [email protected] | |
#### Windows | ||
Use the following command to grab and install Genin in Windows 7 64 bit or newer: | ||
```shell | ||
curl.exe -L https://binary.picodata.io/repository/raw/genin/windows/genin-0.5.7-darwin-amd64.zip -o genin-0.5.7-windows-amd64.zip | ||
unzip.exe genin-0.5.7-windows-amd64.zip -d %HOME%/.cargo/bin/ | ||
curl.exe -L https://binary.picodata.io/repository/raw/genin/windows/genin-0.5.8-darwin-amd64.zip -o genin-0.5.8-windows-amd64.zip | ||
unzip.exe genin-0.5.8-windows-amd64.zip -d %HOME%/.cargo/bin/ | ||
``` | ||
> **Note:** The application can then be found under the `.cargo/bin` folder inside | ||
> your user profile folder. Make sure it is in your `%PATH%`. | ||
|
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 |
---|---|---|
|
@@ -49,8 +49,8 @@ Genin уже заранее скомпилирован под разные ар | |
|
||
Универсальный исполняемый файл: | ||
```shell | ||
curl -sLO https://binary.picodata.io/repository/raw/genin/bin/genin-0.5.7-x86_64-musl.tar.gz | ||
tar -xvf genin-0.5.7-x86_64-musl.tar.gz ; sudo install genin /usr/local/bin/ | ||
curl -sLO https://binary.picodata.io/repository/raw/genin/bin/genin-0.5.8-x86_64-musl.tar.gz | ||
tar -xvf genin-0.5.8-x86_64-musl.tar.gz ; sudo install genin /usr/local/bin/ | ||
``` | ||
|
||
--- | ||
|
@@ -87,11 +87,11 @@ sudo yum install -y genin | |
2. Так же вы можете установить пакет `rpm` напрямую без добавления нашего репозитория. | ||
RHEL 8.x, CentOS 8.x, Rockylinux 8.x, recent Fedora version | ||
```shell | ||
sudo rpm -i https://binary.picodata.io/repository/yum/el/8/x86_64/os/genin-0.5.7-1.el8.x86_64.rpm | ||
sudo rpm -i https://binary.picodata.io/repository/yum/el/8/x86_64/os/genin-0.5.8-1.el8.x86_64.rpm | ||
``` | ||
RHEL 7.x, CentOS 7.x | ||
```shell | ||
sudo rpm -i https://binary.picodata.io/repository/yum/el/7/x86_64/os/genin-0.5.7-1.el7.x86_64.rpm | ||
sudo rpm -i https://binary.picodata.io/repository/yum/el/7/x86_64/os/genin-0.5.8-1.el7.x86_64.rpm | ||
``` | ||
> **Note:** будьте внимательны, так как при выборе не правильной версии ос могут быть ошибки | ||
> при установке `rpm` | ||
|
@@ -118,7 +118,7 @@ sudo apt install -y genin | |
|
||
2. Загрузкой и установкой пакета напрямую: | ||
```shell | ||
curl -sLO https://binary.picodata.io/repository/raw/genin/deb/genin-0.5.7.amd64.deb && sudo dpkg -i genin-0.5.7.amd64.deb | ||
curl -sLO https://binary.picodata.io/repository/raw/genin/deb/genin-0.5.8.amd64.deb && sudo dpkg -i genin-0.5.8.amd64.deb | ||
``` | ||
|
||
--- | ||
|
@@ -143,7 +143,7 @@ sudo apt install -y genin | |
|
||
2. Загрузкой и установкой пакета напрямую: | ||
```shell | ||
curl -sLO https://binary.picodata.io/repository/raw/genin/deb/genin-0.5.7.amd64.deb && sudo dpkg -i genin-0.5.7.amd64.deb | ||
curl -sLO https://binary.picodata.io/repository/raw/genin/deb/genin-0.5.8.amd64.deb && sudo dpkg -i genin-0.5.8.amd64.deb | ||
``` | ||
|
||
--- | ||
|
@@ -163,8 +163,8 @@ brew install genin | |
Для установки без помощи homebrew используйте следующие команды для загрузки и установки | ||
Genin на macOS (10.10+): | ||
```shell | ||
curl -sLO https://binary.picodata.io/repository/raw/genin/osx/genin-0.5.7-x86_64-macosx.tar.gz | ||
unzip genin-0.5.7-darwin-amd64.zip -d ~/bin/ | ||
curl -sLO https://binary.picodata.io/repository/raw/genin/osx/genin-0.5.8-x86_64-macosx.tar.gz | ||
unzip genin-0.5.8-darwin-amd64.zip -d ~/bin/ | ||
``` | ||
|
||
--- | ||
|
@@ -188,8 +188,8 @@ brew install [email protected] | |
Используйте следующие команды для скачивания и установки Genin на операционных системах | ||
Windows 7 64 и новее. | ||
```shell | ||
curl.exe -sLO https://binary.picodata.io/repository/raw/genin/win/genin-0.5.7-win64.zip | ||
unzip.exe genin-0.5.7-win64.zip -d %HOME%/.cargo/bin/ | ||
curl.exe -sLO https://binary.picodata.io/repository/raw/genin/win/genin-0.5.8-win64.zip | ||
unzip.exe genin-0.5.8-win64.zip -d %HOME%/.cargo/bin/ | ||
``` | ||
> **Note:** Genin будет распакован в директорию `.cargo/bin` которая находится в домашнем | ||
> каталоге важего пользователя. Перед использованием приложения пожалуйста удостоверьтесь | ||
|
@@ -199,7 +199,7 @@ unzip.exe genin-0.5.7-win64.zip -d %HOME%/.cargo/bin/ | |
``` | ||
genin --version | ||
``` | ||
Если вы видите сообщение `genin 0.5.7` значит установка прошла успешно. | ||
Если вы видите сообщение `genin 0.5.8` значит установка прошла успешно. | ||
|
||
--- | ||
## Руководство по использованию | ||
|
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 |
---|---|---|
|
@@ -14,51 +14,53 @@ CI `Genin` представляет из себя следующие после | |
![genin-build-release](images/genin-build-release.png) | ||
|
||
В процессе `ci` последовательно выполняется тестирование, запуск линтера, сборка | ||
исполяемого файла под MacOS и основные дистибутивы линукс. Так же `ci` содержит | ||
ряд условий на основе которых процесс выпуска новых релизов `Genin` происходит | ||
исполяемого файла под MacOS и основные дистибутивы линукс. Так же `ci` содержит | ||
ряд условий на основе которых процесс выпуска новых релизов `Genin` происходит | ||
автоматически при пуше тега. | ||
|
||
### Порядок действий при релизе | ||
|
||
1. Создать ветку и запушить ее. | ||
2. Если `ci` прошел успешно (тесты выполнись без замечаний), то открываем `Pull | ||
Request` в мастер. | ||
3. Теперь необходимо поднять версию в файлах `Cargo.toml`, `README.ru.md`, `README.md` | ||
и запушить изменения. | ||
и запушить изменения. | ||
4. Если `ci` прошел успешно, то ставим тег в ветки и пушим тег. | ||
5. После сборки и тестирования, `ci` автоматически запушит версию с тегом в [binary.picodata.io](https://binary.picodata.io/#browse/browse:bastida-raw:genin). | ||
Запушенные пакеты (а так же исполняемый файл) будут иметь приписку `~rc`, например | ||
`0.5.7~rc`. Это необходимо для того что бы отделять версии из пулл реквестов от | ||
релизных. | ||
6. Если патч готов к релизу, то ревьюим `Pull Request` и мерджим в мастер. После | ||
того как `ci` успешно завершится, мы получим новый релиз в гитхабе, а так же набор | ||
пакетов не только [binary.picodata.io](https://binary.picodata.io/#browse/browse:bastida-raw:genin), | ||
но и в [download.picodata.io](https://download.picodata.io/tarantool-picodata/). | ||
5. После сборки и тестирования, `ci` автоматически запушит версию с тегом в [binary.picodata.io](https://binary.picodata.io/#browse/browse:bastida-raw:genin). | ||
Запушенные пакеты (а так же исполняемый файл) будут иметь приписку `~rc`, например | ||
`0.1.2~rc`. Это необходимо для того что бы отделять версии из пулл реквестов от | ||
релизных. | ||
6. Если патч готов к релизу, то ревьюим `Pull Request` и мерджим в мастер. После | ||
того как `ci` успешно завершится, мы получим новый релиз в гитхабе, а так же набор | ||
пакетов не только [binary.picodata.io](https://binary.picodata.io/#browse/browse:bastida-raw:genin), | ||
но и в [download.picodata.io](https://download.picodata.io/tarantool-picodata/). | ||
|
||
## MacOS | ||
|
||
Для `MacOS` версии 10.10+ при релизе требуется несколько дополнительных действий. | ||
Все дело в том, что релизы в `homebrew` тяжело автоматизировать так как они требуют | ||
Для `MacOS` версии 10.10+ при релизе требуется несколько дополнительных действий. | ||
Все дело в том, что релизы в `homebrew` тяжело автоматизировать так как они требуют | ||
редактирования скриптов написанных на `Ruby`. | ||
|
||
### Порядок действий при релизе | ||
|
||
1. После того как патч с тегом влит в мастер и на GitHub появился новый релиз, | ||
переходим в репозиторий [picodata homebrew tap](https://github.com/picodata/homebrew-tap) и создаем новую ветку | ||
в которой будет наша новая версия `Genin`. | ||
2. Вычисляем хэшсумму `sha256` от архива с исполняемым файлом `shasum -a 256 genin-0.5.7-x86_64-macosx.tar.gz`. | ||
3. Создаем файл `Formula/[email protected]`. Файл должен содержать в названии версию Genin | ||
записанную через символ `@`. | ||
1. После того как патч с тегом влит в мастер и на GitHub появился новый релиз, | ||
переходим в репозиторий [picodata homebrew tap](https://github.com/picodata/homebrew-tap) и создаем новую ветку | ||
в которой будет наша новая версия `Genin`. | ||
2. Вычисляем хэшсумму `sha256` от архива с исполняемым файлом `shasum -a 256 genin-0.1.2-x86_64-macosx.tar.gz`. | ||
3. Создаем файл `Formula/[email protected]`. Файл должен содержать в названии версию Genin | ||
записанную через символ `@`. | ||
|
||
```ruby | ||
# В название добавляем версию. Например версия 0.5.7 должна быть записана как AT057 | ||
class GeninAT057 < Formula | ||
# В название добавляем версию. Например версия 0.1.2 должна быть записана как AT012 | ||
class GeninAT012 < Formula | ||
desc "Quick inventory generation for tarantool apps" | ||
homepage "https://github.com/picodata/genin" | ||
# Меняем версию или полный путь к пакету в binary.picodata.io | ||
url "https://binary.picodata.io/repository/raw/genin/osx/genin-0.5.7-x86_64-macosx.tar.gz" | ||
url "https://binary.picodata.io/repository/raw/genin/osx/genin-0.1.2-x86_64-macosx.tar.gz" | ||
# Вставляем хэшсумму вычисленную в шаге 2 | ||
sha256 "cf09eab628a179ccc3f548bc7b4fcfa0e4defa2ef373913a7e89dca25a65556e" | ||
# Меняем версию | ||
version "0.5.7" | ||
version "0.1.2" | ||
license "BSD-2-Clause license" | ||
|
||
def install | ||
|
@@ -70,9 +72,10 @@ class GeninAT057 < Formula | |
end | ||
end | ||
``` | ||
4. Обновляем симлинк в директории Alias на актуальную версию: `rm Aliases/genin && ln -s ../Formula/[email protected] Aliases/genin`. | ||
|
||
4. Обновляем симлинк в директории Alias на актуальную версию: `rm Aliases/genin && ln -s ../Formula/[email protected] Aliases/genin`. | ||
5. Открываем Pull Request в мастер и мерджим обновленную формулу. | ||
|
||
> **Note:** обновление версии без поднятия хотя бы минорной части приведет к конфликту | ||
> версий в Homebrew Tap. Поэтому рекомендуем всегда поднимать версию генина вне | ||
> **Note:** обновление версии без поднятия хотя бы минорной части приведет к конфликту | ||
> версий в Homebrew Tap. Поэтому рекомендуем всегда поднимать версию генина вне | ||
> зависимости от объема привносимой функциональности. |