gfsm 0.1.4 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ccdfca4c117dd359cdd7ad0b93c9ea99b47551cb8edc4028c680b75acc0dddc
-  data.tar.gz: e0959ca04f31bcaafb6643bdd248721814ac831e15225033280d6e97ad1f4ba3
+  metadata.gz: f1328d98b44c0777e42445b9ef8f67b9b88e37d8a7bdc517a3e6393b2543d2a3
+  data.tar.gz: 5ee4cf826f1c4b608bad7f58193db6c744e4c33868f31c5b477994a475bc69d6
 SHA512:
-  metadata.gz: 6f0ac6843c7a75407273d2d3826f3a2bf4aa24576bb35e3969591a2397b29935ce2e0541d91c05dd77adc5f6fce67e3a2b6f9c31294ce5a464e7e845b7eb9b68
-  data.tar.gz: 6f5dc0b736a34b8be9a25420a9d8b405cc87693ce954451ed6d287241798dc5473ede1b885b9c868c2529486d4ee4cfe6159a02bc2a3f273c13fef90d93461dd
+  metadata.gz: 50c2d64b74ed354024fffb5825c28e309e9ddfcdd99889613b2c12cbef85f4ee32cae3c3089e8e5a466bfc0c7abd150d1398c9a3f13bc57df81472ff57640c59
+  data.tar.gz: 178a21e2f2212bc7427bb0ac4b894ae83b4b3846ed1e9bd2b29287ba30500012397a69bdc77f8d408020ca055891f495bad7774a40a18c5d66ff63928ae8faf6

data/.gitlab-ci.yml

@@ -1,6 +1,7 @@
 stages:
   - version
   - deploy
+  - docker
   - release
 
 workflow:
@@ -56,6 +57,20 @@ Publish gem:
       when: never
     - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
 
+Upload docker image:
+  stage: docker
+  image: docker:20.10.16
+  services:
+    - docker:20.10.16-dind
+  script:
+    - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
+    - docker build -t $CI_REGISTRY/zille_marco/gitlab-flavored-semantic-versioning:latest -t $CI_REGISTRY/zille_marco/gitlab-flavored-semantic-versioning:v$RELEASE_VERSION .
+    - docker push --all-tags $CI_REGISTRY/zille_marco/gitlab-flavored-semantic-versioning
+  rules:
+    - if: '$CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH'
+      when: never
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+
 Create release:
   stage: release
   image: registry.gitlab.com/gitlab-org/release-cli:latest
@@ -67,6 +82,8 @@ Create release:
       artifacts: true
     - job: "Publish gem"
       artifacts: false
+    - job: "Upload docker image"
+      artifacts: false
   rules:
     - if: '$GEM_HOST_API_KEY == null'
       when: never

data/Dockerfile

@@ -0,0 +1,7 @@
+FROM ruby:2.7.5-alpine3.15
+
+RUN gem install gfsm
+
+COPY ./gfsmrc.yml ./gfsmrc.yml
+
+ENTRYPOINT [""]

data/README.md

@@ -56,8 +56,45 @@ At the moment there's no built-in testing platform, but I'm planning to use `rsp
 
 ### Using
 
-There are two ways to run this tool locally at the moment:
+This project is available as a Ruby gem, so to be able to use it is enough to run
 
 ```shell
-./bin/gfsm [args]
-```
+gem install gfsm
+```
+
+Once that command completes, the gem will be available and you can invoke it from the command line with
+
+```shell
+gfsm help
+```
+
+The main way this project can be used though, is inside a CI pipeline where you can invoke it to bump the version and/or update the changelog.
+
+In order to use is inside a CI job, the job itself could look something like this:
+
+```yaml
+stages:
+  - version
+
+update-version:
+  stage: version
+  image: ruby:2.7.5
+  before_script:
+    - gem install gfsm
+  script:
+    - gfsm version bump --force > .version
+    - gfsm changelog --force --output-file CHANGELOG.md
+    - echo "RELEASE_VERSION=$(<.version)" >> variables.env
+  artifacts:
+    reports:
+      dotenv: variables.env
+    paths:
+      - .version
+      - CHANGELOG.md
+```
+
+With this, subsequent jobs that depend on the `update-version` job will:
+- be able to get the new version form the `RELEASE_VERSION` environment variable
+- read the `CHANGELOG.md` file to get an updated changelog file
+
+To have a working example of the things described above you can have a look at the `.gitlab-ci.yml` of this project, which implements this exact concept.

data/lib/commands/changelog.rb

@@ -76,11 +76,15 @@ module GFSM
 
         version_bumper = GFSM::Tools::VersionBumper.new()
         version = version_bumper.compute_version!(force, prerelease, prerelease_name, repository_path, configuration_file_path)
-        subdivisions = version_bumper.subdivisions
+        subdivisions = version_bumper.subdivisions.to_a
+        subdivisions.sort_by! { |subdivision_data| subdivision_data[0].priority }.reverse!
 
         changelog_entries = ""
 
-        subdivisions.each do |change_type, commits|
+        subdivisions.each do |subdivision_data|
+          change_type = subdivision_data[0]
+          commits = subdivision_data[1]
+          
           changelog_entries += "\n#{change_type.to_changelog_entry}\n\n"
 
           commits.each do |commit|

data/lib/data/configuration.rb

@@ -18,7 +18,7 @@ module GFSM
           end
         end
 
-        @change_types.sort_by! { |change_type| change_type.priority }.reverse!
+        @change_types
       end
 
       def get_change_type_from_category(category)

data/lib/gfsm.rb

@@ -7,11 +7,11 @@ require 'data/configuration'
 require 'data/version'
 
 # Load the tools
-require 'tools/commits_extractor'
 require 'tools/commits_subdivider'
 require 'tools/current_version_loader'
-require 'tools/version_bumper'
+require 'tools/git_utilities'
 require 'tools/output'
+require 'tools/version_bumper'
 
 # Load the commands
 require 'commands/base_command'

data/lib/tools/current_version_loader.rb

@@ -7,13 +7,9 @@ module GFSM
   module Tools
     class CurrentVersionLoader
       def self.load_current_version(repo_path = ".")
-        repo = Git.open(repo_path)
-
-        begin
-          last_tag_name = repo.describe(nil, { abbrev: 0 })
-        rescue
-          last_tag_name = nil
-        end
+        last_tag_name = GFSM::Tools::GitUtilities.extract_last_tag_name(
+          GFSM::Tools::GitUtilities.load_repo(repo_path)
+        )
 
         return GFSM::Data::Version.new("0.0.0") unless last_tag_name
 

data/lib/tools/{commits_extractor.rb → git_utilities.rb}

@@ -4,17 +4,28 @@ require 'git'
 
 module GFSM
   module Tools
-    class CommitsExtractor
+    class GitUtilities
       CHANGELOG_TRAILER_REGEX = /^(?<name>Changelog):\s*(?<category>.+)$/i
 
-      def self.extract_commits_with_changelog_trailer(repo_path = ".")
-        repo = Git.open(repo_path)
+      def self.load_repo(repo_path)
+        Git.open(repo_path)
+      end
 
+      def self.extract_last_tag_name(repo)
         begin
-          last_tag_name = repo.describe(nil, { abbrev: 0 })
+          current_sort_order = repo.config("tag.sort")
+
+          repo.config("tag.sort", "-v:refname")
+          tags = repo.tags
+          repo.config("tag.sort", current_sort_order)
+
+          tags[0].name if !tags.empty?
         rescue
-          last_tag_name = nil
         end
+      end
+
+      def self.extract_commits_with_changelog_trailer(repo)
+        last_tag_name = self.extract_last_tag_name(repo)
 
         begin
           commits = last_tag_name ? repo.log.between(last_tag_name, 'HEAD') : repo.log

data/lib/tools/version_bumper.rb

@@ -10,7 +10,9 @@ module GFSM
 
       def compute_version!(force, prerelease, prerelease_name, repository_path, configuration_file_path)
         configuration = GFSM::Data::Configuration.new(configuration_file_path)
-        changelog_commits = GFSM::Tools::CommitsExtractor.extract_commits_with_changelog_trailer(repository_path)
+        changelog_commits = GFSM::Tools::GitUtilities.extract_commits_with_changelog_trailer(
+          GFSM::Tools::GitUtilities.load_repo(repository_path)
+        )
 
         @version = GFSM::Tools::CurrentVersionLoader.load_current_version(repository_path)
         @subdivisions = GFSM::Tools::CommitsSubdivider.subdivide_commits(configuration, changelog_commits)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gfsm
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.3.1
 platform: ruby
 authors:
 - Zille Marco
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-04 00:00:00.000000000 Z
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yaml
@@ -65,6 +65,7 @@ files:
 - ".gitlab-ci.yml"
 - ".tool-versions"
 - ".vscode/launch.json"
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -80,9 +81,9 @@ files:
 - lib/data/configuration.rb
 - lib/data/version.rb
 - lib/gfsm.rb
-- lib/tools/commits_extractor.rb
 - lib/tools/commits_subdivider.rb
 - lib/tools/current_version_loader.rb
+- lib/tools/git_utilities.rb
 - lib/tools/output.rb
 - lib/tools/version_bumper.rb
 homepage: https://gitlab.com/zillemarco/gitlab-flavored-semantic-versioning