Changes to README and gemspec #11
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Closes issue #4: Where is `ti help` [http://github.com/schacon/ticgit/issues#issue/4] - ti learned the 'help' command. - ti learned to display list of commands alphabetically. - Extract method 'handle_help' for use by execute! and parse_options! methods.
- Closes http://github.com/schacon/ticgit/issues/#issue/1 - Rakefile learned that Gem::manage_gems was removed in rubygems r1307.
- Bumped revision to 0.3.7 so that the source version is higher than the totally different (but previously identically-incremented) version on Rubygems. - Bumped spec date. - Replaced all soft quotes with hard quotes. - Sorted files list. - Prettied up the arrays.
- Added a prerequisites section.
- Addressed version issues that may affect certain users.
- Explained how to install git and ticgit gems without root access.
- Documented the -h flag accepted by many commands.
- Updated the authors section.
- Obfuscated the email addresses in the README.
+ GitHub and others display the README on the web, making the
addresses spam-bait.
+ There are important reasons to use a valid email address in
repositories and patches, but landing-page README files do not
have the same needs.
- Added a prerequisites section.
- Addressed version issues that may affect certain users.
- Explained how to install git and ticgit gems without root access.
- Documented the -h flag accepted by many commands.
- Updated the authors section.
- Obfuscated the email addresses in the README.
+ GitHub and others display the README on the web, making the
addresses spam-bait.
+ There are important reasons to use a valid email address in
repositories and patches, but landing-page README files do not
have the same needs.
- Mostly automatic installation, as long as rubygems and bundler are
present.
- Added Gemfile for bundler.
- Added minimum version requirements to Gemfile for git gem.
- Simplified installation instructions for both root and non-root users.
- Modified Rakefile extensively:
- Automatic installation of bundled gems to meet dependencies.
- Default task now builds and installs the current gem from source
in one easy step.
- Moved testing items into their own namespace.
- Lots of formatting changes.
- Authors section of README now references an external AUTHORS file.
- Obfuscated email addresses in AUTHORS file.
- Upstream rcov task remains broken.
- Better messages to indicate status of gem build/install. - Determining whether current version of non-bundled gem is already installed does not currently work; added to ToDo list.
Conflicts: README Conflicts caused by rebasing a misplaced commit. Resolved in favor of the bundler topic branch.
Sinatra and haml are required for proper operation of ticgitweb. They will now be installed by the rake task if missing.
-t and -s now take comma-separated lists. Prefixing an element with - means reject all tickets that match that tag/state
- Don't assume everyone already has rake installed. - Experienced rubyists can skip the rake installation line or not, as they choose.
- Higher visibility for the dependency on rubygems. - Made git dependency a little less verbose.
Documented the need for a newer version of rubygems because of a bundler dependency.
- Incorporated ticket_title patch from Debian maintainer Michael Schutte. [git://git.debian.org/~michi-guest/ticgit.git @ bcaff2c] - Closes Debian bug 514282. [http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=514282]
- bin/ti learned to detect if it was running inside a Git source tree. - bin/ti now automatically prefers the source version of the ticgit library when run from inside the Git tree. - Made path names OS-agnostic within by using File.join instead of hard-coded directory separators.
- Ensures that gem versions and dependencies are identified within the project. - Ensures that downstream packagers know what versions of each gem were tested together by the developers.
- Fixes missing CSS when rendering pages from ticgitweb. - Sass appears to be installed by the haml gem, but isn't brought in automatically when haml is required.
Add the ticgit.rb library from the source tree to the front of the load path. This allows ticgitweb to run without first creating and installing a ticgit gem, which is important when testing multiple branches of development.
- bin/ti learned an easier way to prefer the ticgit.rb library in the source tree over an installed gem. - bin/ti now uses same trick as bin/ticgitweb (see commit 253f646).
- Removed optional fields, especially those prone to clobbering between forks. This should make maintaining the gemspec among multiple clones easier. - Added dynamic date. Date will be updated on each rebuild of the gem. - Added dynamic versioning based on seconds since epoch. Version will be incremented on each rebuild of the gem.
|
Changes have since been incorporated into TicGit. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The major additions to this pull request are a revamped README that I hope will make it easier on new users, as well as some updates to the gemspec that will allow you to push out a ticgit-0.3.7 gem to resolve the issue I mentioned earlier by email.
Lots of other good stuff in there, too. Let me know if you have any questions!