Skip to content

Commit 2023b06

Browse files
authored
Feature/Add git-flow (#7)
* Added git-flow * Updated setup.sh * Updated script docs, version, changelog
1 parent 346f920 commit 2023b06

3 files changed

Lines changed: 24 additions & 10 deletions

File tree

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
44

5+
## [0.2.0] - 2022-02-04
6+
7+
### Added
8+
9+
- Added [git-flow](https://github.com/petervanderdoes/gitflow-avh)
10+
511
## [0.1.0] - 2022-02-04
612

713
### Added

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,31 @@
11
# FRS - fast Ruby setup
22

3-
Automation script for spin-up Ruby developer environment. Configure your developer stuff on Linux Ubuntu in minutes 🚀
3+
Automation script for spin-up Ruby developer environment. Configure your developer stuff on Linux Ubuntu in minutes 🚀 Focus on development, not on developer tools!
44

55
## Features
66

7+
* Installs & configures [git](https://git-scm.com), [git-flow](https://github.com/petervanderdoes/gitflow-avh)
78
* Installs & configures [ZSH](https://www.zsh.org), [OhMyZsh](https://ohmyz.sh) and [Spaceship Promt](https://spaceship-prompt.sh)
89
* Installs & configures [asdf](https://asdf-vm.com), [asdf Ruby plugin](https://github.com/asdf-vm/asdf-ruby)
910
* Installs & configures latest [MRI Ruby](https://www.ruby-lang.org/en/downloads/releases) with default gems
1011
* Installs & configures [Visual Studio Code](https://code.visualstudio.com)
11-
* Configures git
1212

1313
## Requirements/Preconditions
1414

15-
1. Fresh Linux Ubuntu 20.04.3 LTS / Linux Ubuntu 21.10
15+
1. Fresh `Linux Ubuntu 20.04 LTS` / `Linux Ubuntu 21.10`
1616
2. `wget` system dependency
17-
3. GitHub personal access token. Go to `Github/Settings/Developer settings/Personal access tokens` to create it.
17+
3. GitHub personal access token
1818

1919
## Using
2020

21+
### Create GitHub personal access token
22+
23+
To create it go to: [`GitHub/Settings/Developer settings/Personal access tokens/New personal access token`](https://github.com/settings/tokens/new). Specify token name and next token scopes:
24+
25+
* `repo` - full control of private repositories
26+
* `workflow` - update GitHub Action workflows
27+
* `admin:repo_hook` - full control of repository hooks
28+
2129
### Install wget
2230

2331
Open your terminal. Install `wget`:
@@ -34,7 +42,7 @@ wget https://raw.githubusercontent.com/RubyWorkout/frs/master/setup.sh
3442

3543
### Run script
3644

37-
Run Fast Ruby Setup script with your email, name (registered on github), github username and github personal access token as position arguments:
45+
Run Fast Ruby Setup script with your email, name (registered on github), github username and github personal access token as positional arguments:
3846

3947
```bash
4048
. ./setup.sh johndoe@example.com "John Doe" git_username git_token

setup.sh

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ function step_title() {
2727
echo "${bold}${green}STEP $1: $2...${reset}"
2828
}
2929

30-
# Install ZSH and friends
30+
# Install git, zsh and friends
3131
function step_1() {
3232
cd ~
33-
step_title $1 "Installing ZSH, OhMyZsh and Spaceship Promt"
33+
step_title $1 "Installing GIT, ZSH, OhMyZsh and Spaceship Promt"
3434
sudo apt update
35-
sudo apt-get install -y git curl wget zsh powerline fonts-powerline software-properties-common apt-transport-https
35+
sudo apt-get install -y git git-flow curl wget zsh powerline fonts-powerline software-properties-common apt-transport-https
3636
sh -c "$(curl -fsSL https://raw.github.com/ohmyzsh/ohmyzsh/master/tools/install.sh) --unattended"
3737
sudo chsh -s $(which zsh)
3838
git clone https://github.com/spaceship-prompt/spaceship-prompt.git "$ZSH_CUSTOM/themes/spaceship-prompt" --depth=1
@@ -109,7 +109,7 @@ function print_fails_steps {
109109
echo "${red}Failed number of step(s): ${joined%,*} ${reset}"
110110
}
111111

112-
# Step list iterator
112+
# Steps list iterator
113113
for s in $(seq 1 $final_step_index)
114114
do
115115
((steps_counter++))
@@ -119,7 +119,7 @@ do
119119
fi
120120
done
121121

122-
# Final result message
122+
# Print out final result message
123123
if [[ ${#bundler_build_errors[@]} == 0 ]]
124124
then
125125
echo "${green}Congrats, your Ruby developer environment is ready${reset} 🚀"

0 commit comments

Comments
 (0)