gjp 0.16.0 → 0.16.1

data/README.md

@@ -6,7 +6,9 @@ The project objective is to strongly reduce manual packaging efforts by enabling
 
 ## Status
 
-`gjp` is a research project currently in alpha state. Basic concepts seem to be viable, packages are currently being built with the new approach to identify problem areas but not all basic features have been coded yet. If you are a packager you can try to use it (any feedback would be **very** welcome!), but be warned that anything can still change at this point. 
+`gjp` is a research project currently in alpha state. Basic concepts seem to be viable, packages are currently being built with the new approach to identify problem areas but not all basic features have been coded yet. If you are a packager you can try to use it (any feedback would be **very** welcome!), but be warned that anything can still change at this point.
+
+At the moment `gjp` is tested on openSUSE and can only output RPMs for the openSUSE and SLES distributions. Fedora, RHEL and other distros could be supported in the future.
 
 ## Contact
 
@@ -14,15 +16,17 @@ Are you using `gjp` or even just reading this? Let's get in touch!
 
     smoioli at suse dot de
 
+## Requirements and installation
 
-## Install
+* [Ruby 1.9](https://www.ruby-lang.org/en/);
+* [git](http://git-scm.com/);
+* a JDK that can compile whatever software you need to package;
+* only for the optional `set-up-nonet-user` subcommand, `sudo` and `iptables`;
 
-Via RubyGems:
+You can install gjp via RubyGems:
 
     $ gem install gjp
 
-Note: `gjp` requires `git` in order to work. Some non-essential subcommands also need `iptables`, `sudo` and a JDK.
-
 ## Workflow
 
 Building a package with `gjp` is quite unusual — this is a [deliberate choice](#motivation) to minimize packaging efforts.
@@ -34,7 +38,7 @@ The basic process is:
 * a `gjp` project is created;
 * sources are added to the project, `gjp` keeps track of them;
 * any other file that is needed for the build, except the JDK, is added in binary form (jars, the Maven executable, its plugins,  etc.). Again, `gjp` keeps track of what you add, noting that those were binary build dependencies and not sources;
-* a build is attempted. After the build is successful, `gjp` notes what files were produced and restores sources in their original state, making it a "repeatable dry-run build". `gjp` also retains any files that were automatically downloaded by Maven or other similar tools during the dry-run as binary build dependencies;
+* a build is attempted. After the build is successful, `gjp` tracks which files were produced and restores sources in their original state, making it a "repeatable dry-run build". `gjp` also retains any files that were automatically downloaded by Maven or other similar tools during the dry-run as binary build dependencies;
 * `gjp` produces spec files for two packages: one for the project itself and one for all of its binary build dependencies, called a **kit**;
 * kit and project packages can be submitted to [OBS](http://en.opensuse.org/openSUSE:Build_Service). Project package will rebuild cleanly because it needs no Internet access - all files were already downloaded during the dry-run above and are included in the kit.
 
@@ -48,19 +52,21 @@ Note that:
 
 In `gjp`, the build process can be in one of the following phases at any given moment:
 
-* gathering: in this phase you add sources and kit files. New projects start in this phase, you can always enter it later with `gjp gather`;
-* dry-running: in this phase you attempt a build. Any change in the sources will be reverted after it ends, while files added to the kit will be retained. You can enter this phase with `gjp dry-run`;
-* finishing: in this phase `gjp` generates specs and archive files. You can enter it running `gjp finish`;
+* **gathering**: in this phase you add sources and kit files. New projects start in this phase, you can always enter it later with `gjp gather`;
+* **dry-running**: in this phase you attempt a build. Any change in the sources will be reverted after it ends, while files added to the kit will be retained. You can enter this phase with `gjp dry-run`;
+* **finishing**: in this phase `gjp` generates specs and archive files. You can enter it running `gjp finish`;
 
 ### Sample project (commons-io)
 
+#### Initialization and first gathering phase
+
 Ceate a new `gjp` project, in this example named "galaxy":
 
     mkdir galaxy
     cd galaxy
     gjp init
 
-As you can see from the output, `gjp init` starts a new gathering phase in which you can add sources and kit files. It also generated a folder structure and assumes you respect it, in particular, you should place all your projects' source files in `src`. Every `src` subfolder will become a separate package named after the folder itself, so use the following commands to create a `commons-collections` folders and populate it:
+`gjp init` automatically starts a new gathering phase in which you can add sources and kit files. It also generated a folder structure and assumes you respect it, in particular, you should place all your projects' source files in `src`. Every `src` subfolder will become a separate package named after the folder itself, so use the following commands to create a `commons-collections` folders and populate it:
 
     cd src
     mkdir commons-collections
@@ -77,7 +83,11 @@ Now let's move to the kit (which, unsurprisingly, should be placed in the `kit`
     rm apache-maven-3.1.0-bin.zip
     cd ..
 
-Nothing else is needed for a first build. Let's call `gjp dry-run` to let `gjp` know we are building and then call Maven. Note that `gjp mvn` is used instead of plain `mvn`: `gjp` will take care of locating the Maven installation we have in the `kit` and ensure it will store all downloaded files there.
+This is actually everything needed to do a first dry-run build.
+
+#### First dry-run phase
+
+Let's call `gjp dry-run` to let `gjp` know we are building and then call Maven. Note that `gjp mvn` is used instead of plain `mvn`: `gjp` will take care of locating the Maven installation we have in the `kit` and ensure it will store all downloaded files there.
 
     gjp dry-run
     cd src/commons-collections/commons-collections-3.2.1-src/
@@ -86,6 +96,8 @@ Nothing else is needed for a first build. Let's call `gjp dry-run` to let `gjp`
 
 Success! At this point `gjp` took note of all needed files, and restored `src` as it was before the build. This should be sufficient to be able to repeat the build on a machine with no Internet access, but what if we wanted to be 100% sure of that?
 
+#### Second, networkless, dry-run phase
+
 `gjp` has a subcommand to setup a `nonet` user without Internet access, courtesy of `iptables`. You can simply retry the build using that user to see if it works. Note that the following commands will alter group permissions to allow both your current user and `nonet` to work on the same files. 
 
     gjp set-up-nonet-user
@@ -99,6 +111,8 @@ Success! At this point `gjp` took note of all needed files, and restored `src` a
 
 The above is obviously not mandatory, but it can be useful for debugging purposes.
 
+#### Second gathering phase: adding a build.sh file
+
 One last thing before generating packages is to setup a build script. By default `gjp` will generate a spec file which assumes a `build.sh` script in the source folder of your project that contains all commands needed to build the package itself. At the moment, this needs to be done manually, but it will hopefully be automated in a future release.
 
 Let's start a new gathering phase and add that:
@@ -112,19 +126,21 @@ Add the following lines:
     cd src/commons-collections/commons-collections-3.2.1-src/
     ../../../kit/apache-maven-3.1.0/bin/mvn -Dmaven.repo.local=`readlink -e ../../../kit/m2` -s`readlink -e ../../../kit/m2/settings.xml` package
 
+Note that `build.sh` gets called from the `gjp` project root, hence the `cd` line, and the Maven line was taken directly from `gjp mvn` output above and pasted verbatim.
 Now complete the gathering:
 
     gjp finish
     cd ../../..
 
-Note that `build.sh` gets called from the `gjp` project root, hence the `cd` line, and the Maven line was taken directly from `gjp mvn` output above and pasted verbatim.
+#### Generating archives and spec files
 
 The following command will generate the kit spec:
 
     gjp generate-kit-spec
     less specs/galaxy-kit.spec
 
-Nothing fancy here, just a bunch of binaries installed in a proper location. You can also edit the spec file manually if you want. When you later regenerate it, `gjp` will automatically try to reconcile changes with a [three-way merge](http://en.wikipedia.org/wiki/Three-way_merge#Three-way_merge).
+Nothing fancy here, the spec simply copies `kit` contents in a special directory to be available for later compilation of packages.
+You can also edit the spec file manually if you want. When you later regenerate it, `gjp` will automatically try to reconcile changes with a [three-way merge](http://en.wikipedia.org/wiki/Three-way_merge#Three-way_merge).
 
 You can also generate the corresponding .tar.xz file with:
 
@@ -138,14 +154,14 @@ You can then generate the project spec and archive files provided you have a pom
     gjp generate-package-archive commons-collections
     less specs/commons-collections.spec
 
-As you can see, this package BuildRequires its kit, contains only the source files and installs any .jar files that were produced during dry runs. Archive is generated from `file_lists/commons-collections_input`, which lists source files. Output files are in `file_lists/commons-collections_output` and are used to compile the `%install` and `%files` sections of the project spec (by default jar files are included, see `gjp generate-package-spec --help`).
+commons-collection BuldRequires galaxy-kit, its archive contains only source files and it will install any produced .jar file in `/usr/lib/java`. The archive is generated from `file_lists/commons-collections_input`, which lists source files. Output files are in `file_lists/commons-collections_output` and are used to compile the `%install` and `%files` sections of the project spec (by default only jar files are included, see `gjp generate-package-spec --help`).
 
     less file_lists/commons-collections_input
     less file_lists/commons-collections_output
 
 Packages are ready to be submitted to an OBS project. As OBS integration is not yet implemented, refer to OBS documentation to do that.
 
-### Kit sources
+#### Kit sources
 
 If kit sources are needed for license compliance, some extra work is needed. Fortunately, finding jar source files and adding them to the kit is much easier than packaging its contents in proper RPMs!
 
@@ -166,9 +182,11 @@ More comprehensive support is planned in future releases.
 
 You are advised to use [Maven Central](http://search.maven.org/) to search for sources and other information about projects.
 
-### Implementation note
+### Troubleshooting
 
-`gjp` internally uses `git` to keep track of files, any gjp project is actually also a `git` repo. Feel free to navigate it, you can commit, push and pull freely as long as the `gjp` tags are preserved.
+To know in which phase you are in, use `gjp status`.
+
+`gjp` internally uses `git` to keep track of files, any gjp project is actually also a `git` repo. Feel free to navigate it, you can commit, push and pull freely as long as the `gjp` tags are preserved. You can also delete commits and tags, effectively rewiding gjp history (just make sure to delete all tags pointing to a certain commit when you discard it).
 
 ## Motivation
 
@@ -207,3 +225,7 @@ Building software from a binary blob is unusual for Linux distros, and it surely
 and cloned with:
 
     git clone git@github.com:SilvioMoioli/gjp.git
+
+## License
+
+MIT license.

data/lib/gjp/project.rb

@@ -176,18 +176,26 @@ module Gjp
       `git commit -m "#{message}"`
 
       if tag != nil
-        latest_count = if latest_tag(tag) =~ /^gjp_.*_([0-9]+)$/
-          $1
-        else
-          0
-        end
-        `git tag gjp_#{tag}_#{latest_count.to_i + 1}`
+        `git tag gjp_#{tag}_#{latest_tag_count(tag) + 1}`
       end
     end
 
-    # returns the last tag given in a gjp snapshot
-    def latest_tag(tag)
-      `git describe --abbrev=0 --tags --match=gjp_#{tag}_* --always`.strip
+    # returns the last tag of its type corresponding to a
+    # gjp snapshot
+    def latest_tag(tag_type)
+      "gjp_#{tag_type}_#{latest_tag_count(tag_type)}"
+    end
+
+    # returns the last tag count of its type corresponding
+    # to a gjp snapshot
+    def latest_tag_count(tag_type)
+      `git tag`.split.map do |tag|
+        if tag =~ /^gjp_#{tag_type}_([0-9]+)$/
+          $1.to_i
+        else
+          0
+        end
+       end.max or 0
     end
 
     # reverts path contents as per latest tag

data/lib/gjp/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module Gjp
-  VERSION = "0.16.0"
+  VERSION = "0.16.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gjp
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.16.1
   prerelease: 
 platform: ruby
 authors: