Skip to content

Commit

Permalink
Merge pull request #50 from tamada/releases/v0.4_1
Browse files Browse the repository at this point in the history
Releases/v0.4 1
  • Loading branch information
tamada committed Apr 17, 2019
2 parents 459d145 + e2dd049 commit ffa7ec8
Show file tree
Hide file tree
Showing 22 changed files with 818 additions and 31 deletions.
6 changes: 6 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,9 @@
[submodule "testdata/helloworld2"]
path = testdata/other/helloworld
url = https://htamada@bitbucket.org/htamada/helloworld2.git
[submodule "docs/themes/hugo-theme-massively"]
path = docs/themes/hugo-theme-massively
url = https://github.com/curtistimson/hugo-theme-massively.git
[submodule "docs/themes/cayman-hugo-theme"]
path = docs/themes/cayman-hugo-theme
url = https://github.com/zwbetz-gh/cayman-hugo-theme.git
14 changes: 9 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
GO=go
NAME := rrh
VERSION := "0.3"
VERSION := 0.4
REVISION := $(shell git rev-parse --short HEAD)
LDFLAGS := -X 'main.version=$(VERSION)'
-X 'main.revision=$(REVISION)'
Expand All @@ -17,12 +17,16 @@ deps:

dep ensure -vendor-only

replace_version:
@sed 's/const VERSION = .*/const VERSION = ${VERSION}/g' common/config.go > a
update_version:
@for i in README.md docs/content/_index.md; do\
sed -e 's!Version-[0-9.]*-yellowgreen!Version-${VERSION}-yellowgreen!g' -e 's!tag/v[0-9.]*!tag/v${VERSION}!g' $$i > a ; mv a $$i; \
done

@sed 's/const VERSION = .*/const VERSION = "${VERSION}"/g' common/config.go > a
@mv a common/config.go
@echo "Replace version to ${VERSION}"
@echo "Replace version to \"${VERSION}\""

setup: deps replace_version
setup: deps update_version
git submodule update --init

test: setup format lint
Expand Down
77 changes: 52 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
[![codebeat badge](https://codebeat.co/badges/15e04551-d448-4ad3-be1d-e98b1e586f1a)](https://codebeat.co/projects/github-com-tamada-rrh-master)
[![go report](https://goreportcard.com/badge/github.com/tamada/rrh)](https://goreportcard.com/report/github.com/tamada/rrh)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/tamada/rrh/blob/master/LICENSE)
[![Version](https://img.shields.io/badge/Version-0.4-yellowgreen.svg)](https://github.com/tamada/rrh/releases/tag/v0.4)


# RRH

Expand All @@ -14,11 +16,11 @@ RRH is a simple git repository manager.
* [Description](#description)
* [Installation](#installation)
* [Usage](#usage)
* [Development](#development)
* [Utilities](#utilities)
* [About Project](#about-project)
* [Discussion](#discussion)
* [About the Project](#about-the-project)

[Table of contents](#table_of_contents)
[Table of contents](#table-of-contents)

## Description

Expand Down Expand Up @@ -76,6 +78,17 @@ $ go get git@github.com/tamada/rrh.git

## Usage

### Getting started

RRH has various subcommands, however, `list` and `add` subcommand make you happy.

* `rrh list` shows managed repositories.
* `rrh add <REPO>` adds the given repository under the RRH management.
* type [`cdrrh`](#cdrrh) on Terminal, then type TAB, TAB, TAB!


### Command references

```sh
Usage: rrh [--version] [--help] <command> [<args>]

Expand Down Expand Up @@ -497,6 +510,8 @@ We can see those variables by running `rrh config` sub-command.
* specifies to colorize the output. The colors of output were specified on [`RRH_COLOR`](#rrh_color)
* Default: false
## Development
### Database
The database for managed repositories is formatted in JSON.
Expand Down Expand Up @@ -541,6 +556,8 @@ Also, the configuration file is on `$RRH_HOME/config.json`
## Utilities
Write the following script to `$HOME/.bash_profile`, then restart shell, then we can use `cdrrh` and `rrhpeco` command in the terminal.
### `cdrrh`
changes directory to the specified repository.
Expand Down Expand Up @@ -570,15 +587,13 @@ rrhpeco(){
}
```
## About Project
### License
[Apache License version 2.0](https://github.com/tamada/rrh/blob/master/LICENSE)
## About the Project
### Code of Conduct
[See the file](https://github.com/tamada/rrh/blob/master/CODE_OF_CONDUCT.md)
[![Contribution](https://img.shields.io/badge/RRH-Contribution-yellow.svg)](https://github.com/tamada/rrh/blob/master/CONTRIBUTION.md)
[![Code of Conduct](https://img.shields.io/badge/RRH-Code_of_Conduct-orange.svg)](https://github.com/tamada/rrh/blob/master/CODE_OF_CONDUCT.md)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/tamada/rrh/blob/master/LICENSE)
[![Gitter](https://img.shields.io/badge/Gitter-Join_Chat-red.svg)](https://gitter.im/rrh_git/community)
[![Gitter misc_ja](https://img.shields.io/badge/Gitter-For_Japanese-red.svg)](https://gitter.im/rrh_git/misc_ja)
### Contribution
Expand All @@ -593,28 +608,37 @@ rrhpeco(){
[See also the contribution guideline](https://github.com/tamada/rrh/blob/master/CONTRIBUTING.md).
### Author
### Code of Conduct
* [Haruaki Tamada](https://github.com/tamada)
[![Code of Conduct](https://img.shields.io/badge/RRH-Code_of_Conduct-orange.svg)](https://github.com/tamada/rrh/blob/master/CODE_OF_CONDUCT.md)
### Why the project name RRH
### License
At first, the name of this project was GRIM (Git Repository Integrated Manager).
However, the means of `grim` is not good, and there are many commands which start with `gr`.
Therefore, we changed the project name to RRH.
RRH means "Repositories, Ready to Hack," is not the abbreviation of the Red Riding Hood.
[Apache Version 2.0](https://github.com/tamada/rrh/blob/master/LICENSE)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/tamada/rrh/blob/master/LICENSE)
## Discussion
### Discussion
[![Gitter](https://img.shields.io/badge/Gitter-Join_Chat-red.svg)](https://gitter.im/rrh_git/community)
[![Gitter misc_ja](https://img.shields.io/badge/Gitter-For_Japanese-red.svg)](https://gitter.im/rrh_git/misc_ja)
Join our Gitter channel if you have any problem or suggestions to Rrh.
[![Gitter misc_ja](https://img.shields.io/badge/Gitter-For_Japanese-red.svg)](https://gitter.im/rrh_git/misc_ja)
For Japanese user, `misc_ja` channel has discussions in Japanese.
The public language of other channels and GitHub pages are English.
### Author
* [Haruaki Tamada](https://github.com/tamada)
### Why the project name RRH
At first, the name of this project was GRIM (Git Repository Integrated Manager).
However, the means of `grim` is not good, and there are many commands which start with `gr`.
Therefore, we changed the project name to RRH.
RRH means "Repositories, Ready to Hack," is not the abbreviation of the Red Riding Hood.
## Table of Contents
* [Description](#description)
Expand All @@ -623,6 +647,8 @@ The public language of other channels and GitHub pages are English.
* [Golang](#golang)
* [Requirements](#requirements)
* [Usage](#usage)
* [Getting started](#getting-started)
* [Command references](#command-references)
* [Subcommands](#subcommands)
* [`rrh add`](#rrh-add)
* [`rrh clone`](#rrh-clone)
Expand All @@ -640,14 +666,15 @@ The public language of other channels and GitHub pages are English.
* [`rrh rm`](#rrh-rm)
* [`rrh status`](#rrh-status)
* [Environment variables](#environment-variables)
* [Development](#development)
* [Database](#database)
* [Utilities](#utilities)
* [`cdrrh`](#cdrrh)
* [`rrhpeco`](#rrhpeco)
* [About Project](#about-project)
* [License](#license)
* [Code of Conduct](#code-of-conduct)
* [About the Project](#about-the-project)
* [Contribution](#contribution)
* [Code of Conduct](#code-of-conduct)
* [License](#license)
* [Discussion](#discussion)
* [Author](#author)
* [Why the project name RRH?](#why-the-project-name-rrh)
* [Discussion](#discussion)
2 changes: 1 addition & 1 deletion common/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import (
/*
VERSION shows the version of RRH.
*/
const VERSION = "0.3"
const VERSION = "0.4"

/*
The environment variable names.
Expand Down
2 changes: 2 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
_gen
public
47 changes: 47 additions & 0 deletions docs/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
baseURL = "http://tamada.github.io/rrh"
languageCode = "en-us"
defaultContentLanguage = "en"
title = "RRH"
theme = "cayman-hugo-theme"

pygmentsCodefences = true
pygmentsStyle = "pygments"

[params]
project_name = "RRH"
project_tagline = "A simple git repository manager"
dateFormat = "2006-01-02"

footer = "Made with [Hugo](https://gohugo.io/). Theme by [Cayman](https://github.com/zwbetz-gh/cayman-hugo-theme). Deployed to [GitHub Pages](https://pages.github.com/)."

katex = true

[menu]
[[menu.nav]]
name = "Home"
url = "/"
weight = 1
[[menu.nav]]
name = "Description"
url = "/description/"
weight = 2
[[menu.nav]]
name = "Installation"
url = "/installation/"
weight = 3
[[menu.nav]]
name = "Usage"
url = "/usage/"
weight = 4
[[menu.nav]]
name = "Development"
url = "/development/"
weight = 5
[[menu.nav]]
name = "Utilities"
url = "/utilities/"
weight = 6
[[menu.nav]]
name = "About"
url = "/about/"
weight = 7
37 changes: 37 additions & 0 deletions docs/content/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: RRH
---

[![Build Status](https://travis-ci.org/tamada/rrh.svg?branch=master)](https://travis-ci.org/tamada/rrh)
[![Coverage Status](https://coveralls.io/repos/github/tamada/rrh/badge.svg?branch=master)](https://coveralls.io/github/tamada/rrh?branch=master)
[![codebeat badge](https://codebeat.co/badges/15e04551-d448-4ad3-be1d-e98b1e586f1a)](https://codebeat.co/projects/github-com-tamada-rrh-master)
[![go report](https://goreportcard.com/badge/github.com/tamada/rrh)](https://goreportcard.com/report/github.com/tamada/rrh)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/tamada/rrh/blob/master/LICENSE)
[![Version](https://img.shields.io/badge/Version-0.4-yellowgreen.svg)](https://github.com/tamada/rrh/releases/tag/v0.4)

RRH is a simple git repository manager.

## Table of Contents

* [Description](description)
* [Installation](installation)
* [Homebrew](installation#homebrew)
* [Golang](installation#golang)
* [Requirements](installation#requirements)
* [Usage](usage)
* [Getting Started](usage#getting-started)
* [Command references](usage#command-references)
* [Subcommands](usage#subcommands)
* [Environment Variables](usage#environment-variables)
* [Development](development)
* [Database](development#database)
* [Utilities](utilities)
* [`cdrrh`](utilities#cdrrh)
* [`rrhpeco`](utilities#rrhpeco)
* [About the Project](about)
* [Contribution](about#contribution)
* [Discussion](about#disucussion)
* [Why the project name RRH](about#why-the-project-name-rrh)
* [Code of Conduct](about#code-of-conduct)
* [License](about#license)
* [Authors](about#authors)
56 changes: 56 additions & 0 deletions docs/content/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: About the Project
---

[![Contribution](https://img.shields.io/badge/RRH-Contribution-yellow.svg)](https://github.com/tamada/rrh/blob/master/CONTRIBUTION.md)
[![Code of Conduct](https://img.shields.io/badge/RRH-Code_of_Conduct-orange.svg)](https://github.com/tamada/rrh/blob/master/CODE_OF_CONDUCT.md)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/tamada/rrh/blob/master/LICENSE)
[![Gitter](https://img.shields.io/badge/Gitter-Join_Chat-red.svg)](https://gitter.im/rrh_git/community)
[![Gitter misc_ja](https://img.shields.io/badge/Gitter-For_Japanese-red.svg)](https://gitter.im/rrh_git/misc_ja)


### Contribution

1. Fork the project. ([https://github.com/tamada/rrh/fork](https://github.com/tamada/rrh/fork))
2. Create a feature branch. (`git checkout -b FEATURE_BRANCH_NAME`)
3. Edit the source files and Commit your changes.
4. Create tests and commit them.
5. Rebase your local changes against the master branch.
6. Run the test suite with the `make test` and confirm that passes.
7. Create a new pull request.
8. Confirm all checks pass.

[![Contribution](https://img.shields.io/badge/RRH-Contribution-yellow.svg)](https://github.com/tamada/rrh/blob/master/CONTRIBUTION.md)


### Code of Conduct

[![Code of Conduct](https://img.shields.io/badge/RRH-Code_of_Conduct-orange.svg)](https://github.com/tamada/rrh/blob/master/CODE_OF_CONDUCT.md)

### License

[Apache License version 2.0](https://github.com/tamada/rrh/blob/master/LICENSE)

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/tamada/rrh/blob/master/LICENSE)

### Discussion

[![Gitter](https://img.shields.io/badge/Gitter-Join_Chat-red.svg)](https://gitter.im/rrh_git/community)
[![Gitter misc_ja](https://img.shields.io/badge/Gitter-For_Japanese-red.svg)](https://gitter.im/rrh_git/misc_ja)

Join our Gitter channel if you have any problem or suggestions to Rrh.

For Japanese user, `misc_ja` channel has discussions in Japanese.
The public language of other channels and GitHub project pages are English.

### Authors

{{< githubuser tamada >}}

### Why the project name RRH

At first, the name of this project was GRIM (Git Repository Integrated Manager).
However, the means of `grim` is not good, and there are many commands which start with `gr`.
Therefore, we changed the project name to RRH.
RRH means "Repositories, Ready to Hack," is not the abbreviation of the Red Riding Hood.

23 changes: 23 additions & 0 deletions docs/content/description.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Description
---

There are too many repositories.
We love programming; however, to manage many repositories is quite hard and bothersome tasks.
Therefore, we built a headquarter for managing the git repositories, named RRH.
RRH manages repositories by categorizing in groups and execute git command to the groups.

I know the tool [ghq](https://github.com/motemen/ghq), manages the git repositories.
However, I cannot use it for the following reasons.

1. there are quite many repositories in my home directory.
* To start using ghq, we clone the repositories.
However, I did not accept to clone all of the repositories.
2. The location of repositories is fixed in the config file and is accepted only one location.
* I decide the directory layout in my home directory.

Additionally, I edit several repositories in a day, when I work hard.
Consequently, the progress of each repository is obscured; I cannot remember a lot of things.
Therefore, it is glad to see the last modified date of branches.

RRH is now growing. Please hack RRH itself.
Loading

0 comments on commit ffa7ec8

Please sign in to comment.