Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enhance README.md #259

Merged
merged 1 commit into from
Nov 2, 2016
Merged

enhance README.md #259

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 29 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ Module sync configurations for Vox Pupuli Modules

## How to use it

Installation:

```bash
git clone https://github.com/voxpupuli/modulesync_config.git
cd modulesync_config
Expand All @@ -17,17 +15,41 @@ bundle install
bundle exec msync update --help
```

Examples
--------
## Examples

module sync one specific module:
```
### module sync one specific module

```bash
bundle exec msync update -f {module_name} --message "modulesync {git-tag}"
```

module sync one module and review changes before submitting changes:
### module sync one module and review changes before submitting changes

```bash
bundle exec msync update -f {module_name} --noop
cd modules/{module_name}
# edit then git commit/push
```

### Syncing all modules

This will sync everything in the `managed_modules.yml`

```bash
bundle exec msync update --message "modulesync $(date +%Y-%m-%d)"
```

### Clean up old mess before syncing

```bash
find modules/* -maxdepth 0 -type d | while read module; do
cd $module
git status
git checkout master
git pull
git fetch origin --prune
git branch -d modulesync
cd ..
cd ..
done
```