gfsm 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02114eeeebd6ba1a3adf4a555b5359bf7ea7920da2d90a07a15fc1c1af24b929
-  data.tar.gz: 3ce23b247e05df130cd0315c7cb71a187c2f7a5fc8529aced4c0a08063b1e558
+  metadata.gz: b9e0ba6497503d24cc631e5a561879a5b8fddd9b0b98243b4b92d2f05f5add90
+  data.tar.gz: ac56fb2b77daf823e235cf7c06e6ca8ad29d585f261e83a90506efe7a3f30fd2
 SHA512:
-  metadata.gz: 6430792b7dde9fc4d9bffa77ca3957fd85a912ce0aeca0cfdca24e04a870d86d12e44bfbe11d5f35392e03a21a05af2689289a1eb67ff63c16f8bf8582a51c80
-  data.tar.gz: 38b14dba33e0eccc6e57b657fcdb0caa234a93d2bbe1b8b806dde83cd40629030a15831f31479531de8398c800f8d2d076def5bbd4b64c0f4537884c3d18c3f2
+  metadata.gz: 99373328bcc6e18fa2bd4c588a98fca5ff359fa83c2f1281049236a23f5f8631aafb9676ab813461dd2a6b87a89a83a3b595cc81db9d7266f141d412ca0c8f61
+  data.tar.gz: 1928c819f0a3bc20d324cacfb038506ed6eaf0cacb425070bcd09c4f85ea65bde18374cd4029aa2808552b2e6a71f4e46169811a3404e034177f9c0c32a2ab66

data/.gitlab-ci.yml

@@ -1,6 +1,7 @@
 stages:
   - version
   - deploy
+  - docker
   - release
 
 workflow:
@@ -56,19 +57,33 @@ 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
   script:
     - |
       release-cli create --name "Release v$RELEASE_VERSION" --description CHANGELOG.md --tag-name "v$RELEASE_VERSION"
-  tags:
-    - unix
   needs:
     - job: "Update version"
       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/tools/commits_extractor.rb

@@ -11,7 +11,7 @@ module GFSM
         repo = Git.open(repo_path)
 
         begin
-          last_tag_name = repo.describe(nil, { abbrev: 0 })
+          last_tag_name = repo.describe(nil, { :tags => true, :abbrev => 0 })
         rescue
           last_tag_name = nil
         end

data/lib/tools/current_version_loader.rb

@@ -10,7 +10,7 @@ module GFSM
         repo = Git.open(repo_path)
 
         begin
-          last_tag_name = repo.describe(nil, { abbrev: 0 })
+          last_tag_name = repo.describe(nil, { :tags => true, :abbrev => 0 })
         rescue
           last_tag_name = nil
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gfsm
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Zille Marco
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-04 00:00:00.000000000 Z
+date: 2022-08-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