Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mslinn/commit
A streamlined git commit
https://github.com/mslinn/commit
commit git
Last synced: 8 days ago
JSON representation
A streamlined git commit
- Host: GitHub
- URL: https://github.com/mslinn/commit
- Owner: mslinn
- License: mit
- Created: 2024-12-21T01:26:12.000Z (14 days ago)
- Default Branch: master
- Last Pushed: 2024-12-21T02:03:23.000Z (14 days ago)
- Last Synced: 2024-12-21T02:32:38.344Z (14 days ago)
- Topics: commit, git
- Language: Ruby
- Homepage: https://mslinn.com/git/1050-commit.html
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# `Commit` [](https://badge.fury.io/rb/commit)
Runs git commit without prompting for a message.
Files larger than 2 GB are added to .gitignore instead of being committed.
This gem is further described in [A Streamlined Git Commit](https://mslinn.com/git/1050-commit.html).
## Installation
1) [Install the `rugged` gem.](https://mslinn.com/git/4400-rugged.html)
2) Type:
```ruby
gem install commit
```
## Usage
```shell
$ commit [options] [file...]
```
Where options are:
- `-a "tag message"`
- `-m "commit message"`
- `-v 0 # Minimum verbosity`
- `-v 1 # Default verbosity`
- `-v 2 # Maximum verbosity`
### Examples
```shell
$ commit # The default commit message is just a single dash (-)
$ commit -v 0
$ commit -m "This is a commit message"
$ commit -v 0 -m "This is a commit message"
$ commit -a 0.1.2
```
## Development
After checking out this git repository, install dependencies by typing:
```shell
$ bin/setup
```
You should do the above before running Visual Studio Code.
### Run the Tests
```shell
$ bundle exec rake test
```
### Interactive Session
The following will allow you to experiment:
```shell
$ bin/console
```
### Local Installation
To install this gem onto your local machine, type:
```shell
$ bundle exec rake install
```
### To Release A New Version
To create a git tag for the new version, push git commits and tags,
and push the new version of the gem to https://rubygems.org, type:
```shell
$ bundle exec rake release
```
## Contributing
Bug reports and pull requests are welcome at https://github.com/mslinn/commit.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).