gitlab-release-notes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 55ea0aa0b213149f726ff26cc29e9cf7f9b50978f26cc545dd4e5fb0a51026f3
+  data.tar.gz: 3f773ccf4825aef2287144d35177b43f1a2c282affab5949d20ccaa3c2025ba6
+SHA512:
+  metadata.gz: 7ef6945f3d085a0d87bb532e18de60fd2a4de4f5f877b1c806748738ac78256df4f8ee48084fc5820ee4b786c7b7d1288729096ce2eac63d0b4195d17de32b5f
+  data.tar.gz: d6fd9fb74cf5ebf974f7d3a6d85e27aaa61d931164d143b8982c81ccff337f43436803f07f33254c945aa96467bc0e32e68a7843937c234147c87e0e6017b519

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gitlab_release_notes.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# GitlabReleaseNotes
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gitlab_release_notes`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gitlab_release_notes'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install gitlab_release_notes
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gitlab_release_notes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/gitlab_release_notes/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the GitlabReleaseNotes project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/gitlab_release_notes/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gitlab_release_notes"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/gitlab-release-notes

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'gitlab_release_notes'
+
+gl = GitlabReleaseNotes::Client.new
+if ENV['JIRA_URL'].nil? || ENV['JIRA_URL'].empty?
+  puts 'Please set Jira URL'
+  exit
+end
+if ARGV.length != 3
+  puts 'Mandatory Parameters are missing.'
+  exit
+end
+gitlab_project_id = ARGV[0]
+project_commit_tag = ARGV[1]
+project_path = ARGV[2]
+puts gl.publish_release_notes(gitlab_project_id, project_commit_tag, project_path)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gitlab_release_notes.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/gitlab_release_notes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gitlab-release-notes"
+  spec.version       = GitlabReleaseNotes::VERSION
+  spec.authors       = ["Mostafa Hussein"]
+  spec.email         = ["mostafa.hussein91@gmail.com"]
+
+  spec.summary       = %q{Populate GitLab project's release notes based on git commits.}
+  spec.description   = %q{Populate GitLab project's release notes based on git commits.}
+  spec.homepage      = "https://github.com/mostafahussein/gitlab-release-notes"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.add_dependency 'tzinfo', '~> 2.0', '>= 2.0.4'
+  spec.add_dependency 'git', '~> 1.8', '>= 1.8.1'
+  spec.add_dependency 'gitlab', '~> 4.17'
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/mostafahussein/gitlab-release-notes"
+  spec.metadata["changelog_uri"] = "https://github.com/mostafahussein/gitlab-release-notes/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables = ["gitlab-release-notes"]
+  spec.require_paths = ["lib"]
+end

data/lib/gitlab_release_notes.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "gitlab_release_notes/version"
+require 'tzinfo'
+require 'git'
+require 'gitlab'
+
+module GitlabReleaseNotes
+  class Error < StandardError; end
+  class Client
+    JIRA_URL = ENV['JIRA_URL']
+    JIRA_IDS_REGEX = ENV['JIRA_IDS_REGEX'] || '(\[([A-Z]{1,}-[0-9]{1,})\])(.*)'
+    TIME_ZONE = ENV['TZ'] || 'Africa/Cairo'
+    ELIGABLE_COMMITS_REGEX = ENV['ELIGABLE_COMMITS_REGEX'] || '(\[[A-Z]{1,}-[0-9]{1,}\]((?!Merge.*branch).)*$)'
+    APP_VERSIONS_REGEX = ENV['APP_VERSIONS_REGEX'] || 'v[0-9]{1,}\.[0-9]{1,}\.[0-9]{1,}'
+    RELEASE_NOTES_HEADER = ENV['RELEASE_NOTES_HEADER'] || '##### Release Notes'
+  
+    def log_filter(logs)
+      app_changelog = []
+      logs.each do |l|
+        if l.message.match(/#{ELIGABLE_COMMITS_REGEX}/)
+          app_changelog.append(l.message.gsub(/#{JIRA_IDS_REGEX}/,
+                                              "\\1(#{JIRA_URL}/browse/\\2)\\3<br>"))
+        end
+      end
+      app_changelog
+    end
+  
+    def tags_lister(repository)
+      app_versions = []
+      repository.tags.each do |t|
+        app_versions.append(t.name) \
+                       if t.name.match(/#{APP_VERSIONS_REGEX}/)
+      end
+      app_versions
+    end
+
+    def current_time
+      tz = TZInfo::Timezone.get(TIME_ZONE.to_s)
+      tz.now
+    end
+
+    def prepare_release_notes(repository_path)
+      repo = Git.open(repository_path)
+      release_notes = []
+      app_versions = tags_lister(repo)
+      if app_versions.length == 1
+        release_notes = log_filter(repo.log)
+      else
+        eligable_versions = app_versions.last(2)
+        release_notes = log_filter(repo.log.between(eligable_versions[0], eligable_versions[1]))
+      end
+      "#{RELEASE_NOTES_HEADER} (#{current_time})<br><hr> " + release_notes.uniq.join('')
+    end
+
+    def publish_release_notes(repository_id, release_tag, repository_path)
+      release_notes = prepare_release_notes(repository_path)
+      begin
+        Gitlab.create_release(repository_id, release_tag, release_notes)
+        "[#{release_tag}] Release notes have been created"
+      rescue Gitlab::Error::Conflict
+        Gitlab.update_release(repository_id, release_tag, release_notes)
+        "[#{release_tag}] Release notes have been updated"
+      end
+    end
+  end
+end

data/lib/gitlab_release_notes/version.rb

@@ -0,0 +1,3 @@
+module GitlabReleaseNotes
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: gitlab-release-notes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mostafa Hussein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: gitlab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.17'
+description: Populate GitLab project's release notes based on git commits.
+email:
+- mostafa.hussein91@gmail.com
+executables:
+- gitlab-release-notes
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/gitlab-release-notes
+- bin/setup
+- gitlab_release_notes.gemspec
+- lib/gitlab_release_notes.rb
+- lib/gitlab_release_notes/version.rb
+homepage: https://github.com/mostafahussein/gitlab-release-notes
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/mostafahussein/gitlab-release-notes
+  source_code_uri: https://github.com/mostafahussein/gitlab-release-notes
+  changelog_uri: https://github.com/mostafahussein/gitlab-release-notes/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Populate GitLab project's release notes based on git commits.
+test_files: []