Compare commits

...

8 Commits
1.1.1 ... 1.1.2

Author SHA1 Message Date
Petr Korolev
7b44c4aa78 Update to version 1.1.2 2014-11-12 11:06:21 +02:00
Petr Korolev
95bdd60c34 Merge branch 'new-features' 2014-11-12 11:06:01 +02:00
Petr Korolev
1357b3980d Fix bug with auto-detect project name, when there is dot signs in project name
add fix for username also
2014-11-12 11:05:03 +02:00
Petr Korolev
b30587ce14 update 2014-11-11 18:07:52 +02:00
Petr Korolev
18e0f937ea typo in readme 2014-11-11 11:07:59 +02:00
Petr Korolev
1af8e18f9f update 2014-11-11 11:00:34 +02:00
Petr Korolev
a458a1e378 update readme 2014-11-11 10:58:56 +02:00
Petr Korolev
bc3af7fa93 update changelog 2014-11-10 17:06:40 +02:00
4 changed files with 46 additions and 30 deletions

View File

@@ -1,5 +1,13 @@
# Changelog
## [1.1.1] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.1)
#### 10/11/14
- *Merged pull-request:* Remove duplicates of issues and pull-requests with same number [\#15](https://github.com/skywinder/Github-Changelog-Generator/pull/15)
- *Merged pull-request:* Sort issues by tags [\#14](https://github.com/skywinder/Github-Changelog-Generator/pull/14)
- *Merged pull-request:* Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/Github-Changelog-Generator/pull/13)
## [1.1.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.0)
#### 10/11/14
- *Implemented enhancement:* Detect username and project form origin [\#11](https://github.com/skywinder/Github-Changelog-Generator/issues/11)

View File

@@ -11,33 +11,39 @@ This script automatically generate change-log from your tags and merged pull-req
[sudo] gem install github_changelog_generator
## Usage
**It's really simple**:
- `cd` to your Project folder with configured git and just type:
github_changelog_generator
- from anywhere:
github_changelog_generator -u github-username -p github-project
In output you will get `CHANGELOG.md` file with *pretty Markdown-formatted* changelogs in your current directory.
As output you will get `CHANGELOG.md` file with *pretty Markdown-formatted* changelog.
### Params:
See `github_changelog_generator --help` for detailed usage.
## Params:
Type `github_changelog_generator --help` for detailed usage.
Usage: changelog_generator --user username --project project_name [options]
-u, --user [USER] Username of the owner of target GitHub repo (required)
-p, --project [PROJECT] Name of project on GitHub (required)
Usage: changelog_generator [options]
-u, --user [USER] Username of the owner of target GitHub repo
-p, --project [PROJECT] Name of project on GitHub
-t, --token [TOKEN] To make more than 50 requests this script required your OAuth token for GitHub. You can generate it on https://github.com/settings/applications
-h, --help Displays Help
-v, --[no-]verbose Run verbosely
-v, --[no-]verbose Run verbosely. Default is true
--[no-]issues Include closed issues to changelog. Default is true
--[no-]issues-without-labels Include closed issues without any labels to changelog. Default is true
--[no-]pull-requests Include pull-requests to changelog. Default is true
-l, --last-changes Generate log between last 2 tags only
-f, --date-format [FORMAT] Date format. Default is %d/%m/%y
-o, --output [NAME] Output file. Default is CHANGELOG.md
--labels x,y,z List of labels. Issues with that labels will be included to changelog. Default is 'bug,enhancement'a
--labels x,y,z List of labels. Issues with that labels will be included to changelog. Default is 'bug,enhancement'
## Examples:
Look at changelog in this project!
### This changelog: [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md)
Was generated by command:
- Look at changelog for **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
- This changelog: [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by command:
github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
@@ -46,13 +52,15 @@ Was generated by command:
Since GitHub allow to make only 50 requests without authentication it's recommended to run this scrip with key `-t [your-16-digit-token]` that you can easily **[generate it here](https://github.com/settings/applications)**.
So, if you got error like this:
>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete': GET https://api.github.com/repos/skywinder/ActionSheetPicker-3.0/git/commits/89678f7d7f66873c858e6cb07bf697192aca6768: 403 API rate limit exceeded for 195.88.177.9. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.) (Github::Error::Forbidden)
>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
It's time to generate this token or wait for 1 hour before GitHub reset counter for your IP.
It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
## License
## Am I missed some essential feature?
Github the Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
**Nothing is impossible!** Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's get this generator better together!
*Bug reports, feature requests, patches, well-wishes are always welcome!*
## Contributing
@@ -63,6 +71,6 @@ Github the Generator is released under the [MIT License](http://www.opensource.o
5. Push to the branch (`git push origin my-new-feature`)
6. Create a new Pull Request
**Bug reports, feature requests, patches, well-wishes, and rap demo tapes are always welcome!**
## License
*Improvements more than welcome - they are kindly requested! :)*
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).

View File

@@ -1,6 +1,6 @@
Gem::Specification.new do |s|
s.name = "github_changelog_generator"
s.version = "1.1.1"
s.version = "1.1.2"
s.default_executable = "github_changelog_generator"
s.required_ruby_version = '>= 1.9.3'

View File

@@ -56,9 +56,9 @@ class Parser
if !options[:user] && !options[:project]
remote = `git remote -vv`.split("\n")
match = /.*(?:[:\/])(\w*)\/((?:-|\w)*)\.git.*/.match(remote[0])
match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)\.git.*/.match(remote[0])
if match[1] && match[2]
if match && match[1] && match[2]
puts "Detected user:#{match[1]}, project:#{match[2]}"
options[:user], options[:project] = match[1], match[2]
end