Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/falcucci/release-me

A bunch of scripts that helps developers manage their software releases. It provides a ready-to-use process to track tasks, organize releases, and automate deployment processes.
https://github.com/falcucci/release-me

automation changelog deploy

Last synced: 3 days ago
JSON representation

A bunch of scripts that helps developers manage their software releases. It provides a ready-to-use process to track tasks, organize releases, and automate deployment processes.

Awesome Lists containing this project

README

        

# Release-me

## What is it? :bulb:

It's just useful scripts to make our work when we talk about changelogs, releases and build automation like `APK's` generation and send it into `google drive'`s folders. It also could be a `gist` but obviously I want to put other scripts related of it as I need here.

# Requirements

## Config to use `release.sh` script

Before to start to use it, please install the following dependencies:

* [ruby](https://www.ruby-lang.org/en/documentation/installation/)
* [GitHub Changelog Generator](https://github.com/github-changelog-generator/github-changelog-generator)
* [chandler](https://github.com/mattbrictson/chandler)
* [npm](https://github.com/creationix/nvm)
* React Native Version `npm install -g react-native-version`

Basically it uses the libraries above to make the automation and currently could be executed from your `terminal` by the following snippet:
```shell
bash -c "$(curl -LsS https://raw.githubusercontent.com/falcucci/release-me/master/release.sh)"
```
or just put it on your `package.json` as follows:

```json
{
"scripts": {
"publish": "curl -LsS https://raw.githubusercontent.com/falcucci/release-me/master/release.sh | bash -s"
}
}
```

## Config to use `apk-builder.sh` script

Before to start to use it, please install the following dependencies:

* [gdrive](https://github.com/prasmussen/gdrive) `brew install gdrive`

The script will build your `APK` file and send it for your google drive folder to manage your versions. For now you could add a npm script at your `package.json` as follows and e.g run `npm run build staging`:
```json
{
"scripts": {
"build": "curl -LsS https://raw.githubusercontent.com/falcucci/release-me/master/apk-builder.sh | bash -s",
}
}
```

Also, read how [gdrive](https://github.com/prasmussen/gdrive) works and add the `GOOGLE_DRIVE_FOLDER_ID` variable at your `.env.` file as your google drive folder identifier. If you have two folders for example, put it on each one in the related `.env`.

## Notifications

We have a script to avoid you to visit [One Signal](https://onesignal.com/) every time to send and debug a `push-notification`. Firstly get the `TEMPLATE_ID` value and put it in your `.env` environment file. The `template_id` is the UUID found in the URL when viewing a template on our dashboard. Secondly get your `PLAYER_ID` [here](https://documentation.onesignal.com/docs/player-id).

So, with that variables already setted just run `npm run notification `

```json
{
"scripts": {
"notification": "curl -LsS https://raw.githubusercontent.com/falcucci/release-me/master/notification.sh | bash -s",
}
}
```

## Config to use `changelog-it.sh`

* `npm i -g -S @falcucci/[email protected]`

The most useful script integrated with [gitlab]() and [jira]() so far.

```bash
curl -LsS https://raw.githubusercontent.com/falcucci/release-me/master/changelog-it.sh | bash -s
```

Please, check it out (how to configure) your channels, templates and more in the [changelog-it](https://github.com/falcucci/jira-changelog) README.

That's it! :sparkles:

## License

The code is available under the [MIT license](LICENSE).