kramdown-plantuml 1.0.1 → 1.1.2

data/.github/scripts/variables.sh

@@ -0,0 +1,72 @@
+#!/bin/bash
+set -o errexit # Abort if any command fails
+me=$(basename "$0")
+
+help_message="\
+Usage: echo $me <version>
+Generates variables based on the provided environment variable GITHUB_CONTEXT
+and <version> argument.
+GITHUB_CONTEXT: An environment variable containing a JSON string of the GitHub
+                context object. Typically generated with \${{ toJson(github) }}.
+     <version>: The version number corresponding to the current Git commit."
+
+initialize() {
+    github_context_json="$GITHUB_CONTEXT"
+    version="$1"
+
+    if [[ -z "$github_context_json" ]]; then
+        echo "Missing or empty GITHUB_CONTEXT environment variable." >&2
+        echo "$help_message"
+        exit 1
+    fi
+
+    if [[ -z "$version" ]]; then
+        echo "No version specified." >&2
+        echo "$help_message"
+        exit 1
+    fi
+
+    sha=$(echo "$github_context_json" | jq --raw-output .sha)
+    ref=$(echo "$github_context_json" | jq --raw-output .ref)
+
+    if [[ -z "$sha" ]]; then
+        echo "No 'sha' found in the GitHub context." >&2
+        echo "$help_message"
+        exit 1
+    fi
+
+    if [[ -z "$ref" ]]; then
+        echo "No 'ref' found in the GitHub context." >&2
+        echo "$help_message"
+        exit 1
+    fi
+}
+
+generate_variables() {
+    # Replace '+'' in the version number with '.'.
+    version="${version//+/.}"
+    # Replace '-' in the version number with '.'.
+    version="${version//-/.}"
+
+    if [[ "$ref" == refs/tags/* ]]; then
+        # Override GitVersion's version on tags, just to be sure.
+        version="${ref#refs/tags/}"
+    fi
+
+    # Convert the version number to all-lowercase because GPR only supports lowercase version numbers.
+    version=$(echo "$version" | tr '[:upper:]' '[:lower:]')
+
+    echo "Ref: $ref"
+    echo "Sha: $sha"
+    echo "Version: $version"
+    echo "::set-output name=ref::$ref"
+    echo "::set-output name=sha::$sha"
+    echo "::set-output name=version::$version"
+}
+
+main() {
+    initialize "$@"
+    generate_variables
+}
+
+main "$@"

data/.github/workflows/amend.yml

@@ -0,0 +1,19 @@
+name: amend
+
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  amend:
+    if: github.event.issue.pull_request != '' && contains(github.event.comment.body, '/amend')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          persist-credentials: false
+      - name: amend
+        env:
+          GITHUB_TOKEN: ${{ secrets.PUBLIC_REPO_TOKEN }}
+          GITHUB_CONTEXT: ${{ toJSON(github) }}
+        run: .github/scripts/amend.sh --user payex-dev --verbose

data/.github/workflows/no-java.yml

@@ -8,18 +8,15 @@ on:
 
 jobs:
   test:
-    name: No Java
     runs-on: ubuntu-latest
     container:
-      image: ruby:2.7.0-alpine3.11
+      image: ruby:2.7.2
 
     steps:
     - uses: actions/checkout@v2
 
     - name: Bundle install
-      run: |
-        find .
-        bundle install --jobs 4 --retry 3
+      run: bundle install --jobs 4 --retry 3
 
-    - name: Test with Rake
+    - name: RSpec
       run: bundle exec rspec --tag no_java

data/.github/workflows/no-plantuml.yml

@@ -8,19 +8,16 @@ on:
 
 jobs:
   test:
-    name: No PlantUML
     runs-on: ubuntu-latest
-    container:
-      image: ruby:2.7.0-alpine3.11
 
     steps:
     - uses: actions/checkout@v2
 
-    - name: Bundle install
-      run: bundle install --jobs 4 --retry 3
+    - name: Set up Ruby 2.7
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+        bundler-cache: true
 
-    - name: Remove plantuml.1.2020.5.jar
-      run:  rm bin/plantuml.1.2020.5.jar
-
-    - name: Test with Rake
+    - name: RSpec
       run: bundle exec rspec --tag no_plantuml

data/.github/workflows/ruby.yml

@@ -1,123 +1,176 @@
 name: Ruby Gem
 
-on:
-  push:
-    branches:
-    - '*'
-    tags:
-    - '*'
-  pull_request:
+on: [push, pull_request, pull_request_target]
 
 jobs:
-  build:
-    name: Build, Test and Publish Ruby Gem
+  version:
     runs-on: ubuntu-latest
 
+    outputs:
+      version: ${{ steps.variables.outputs.version }}
+
     steps:
     - uses: actions/checkout@v2
       with:
         fetch-depth: 0
 
-    - name: Fetch all history for all tags and branches
-      run: |
-        git fetch --prune --tags
-        echo "REF: ${{ github.ref }}"
-
-    - name: Install GitVersion
-      uses: gittools/actions/gitversion/setup@v0.9.2
-      if: startsWith(github.ref, 'refs/tags/') != true # Only use GitVersion for unstable builds
+    - name: Setup GitVersion
+      uses: gittools/actions/gitversion/setup@v0.9.10
       with:
-        versionSpec: '5.2.x'
+        versionSpec: '5.x.x'
 
     - name: Execute GitVersion
       id: gitversion
-      if: startsWith(github.ref, 'refs/tags/') != true
-      uses: gittools/actions/gitversion/execute@v0.9.2
+      uses: gittools/actions/gitversion/execute@v0.9.10
+
+    - name: Create variables
+      id: variables
+      env:
+        GITHUB_CONTEXT: ${{ toJson(github) }}
+      run: ./.github/scripts/variables.sh ${{ steps.gitversion.outputs.fullSemVer }}
+
+  plantuml:
+    needs: version
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
 
-    - name: Create gem version number
-      id: gemversion
-      uses: actions/github-script@0.9.0
+    - name: Setup Java
+      uses: actions/setup-java@v2
       with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
-        script: |
-          const gemVersion = (function() {
-            const ref = '${{ github.ref }}';
-            const tagPrefix = 'refs/tags/';
-
-            if (ref.startsWith(tagPrefix)) {
-              // If a tag ref is being built, just return the tag verbatim
-              return ref.substring(tagPrefix.length);
-            }
-
-            const escapedBranchName = '${{ steps.gitversion.outputs.escapedBranchName }}';
-            const commitsSinceVersionSource = '${{ steps.gitversion.outputs.commitsSinceVersionSourcePadded }}';
-            const preReleaseLabel = escapedBranchName + '.' + commitsSinceVersionSource;
-            const majorMinorPatch = '${{ steps.gitversion.outputs.majorMinorPatch }}';
-            return majorMinorPatch + preReleaseLabel;
-          })();
-
-          core.debug('Gem version: ' + gemVersion);
-          core.setOutput('version', gemVersion);
-
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
+        distribution: adopt
+        java-version: 14
+
+    - name: Cache Maven dependencies
+      uses: actions/cache@v2.1.6
       with:
-        ruby-version: 2.6.x
+        path: ~/.m2/repository
+        key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+        restore-keys: ${{ runner.os }}-maven-
 
-    - name: Setup Graphviz
-      uses: kamiazya/setup-graphviz@v1
+    - name: Version stamp
+      run: mvn versions:set -DnewVersion=${{ needs.version.outputs.version }}
 
-    - name: Cache dependencies
-      uses: actions/cache@v1
+    - name: Maven install
+      run: mvn install
+
+    - name: Upload plantuml.jar artifact
+      uses: actions/upload-artifact@v2
       with:
-        path: vendor/bundle
-        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
-        restore-keys: ${{ runner.os }}-gems-
+        name: plantuml.jar
+        path: ~/.m2/repository/**/plantuml*.jar
+
+  gem:
+    needs: [version, plantuml]
+    runs-on: ubuntu-latest
 
-    - name: Bundle install
-      run: |
-        gem install bundler
-        bundle config path vendor/bundle
-        bundle install --jobs 4 --retry 3
+    outputs:
+      name: ${{ steps.gem.outputs.name }}
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - uses: actions/download-artifact@v2
+      with:
+        name: plantuml.jar
+        path: bin/
+
+    - name: Version stamp
+      run: sed -i -e 's/0.0.1.dev/${{ needs.version.outputs.version }}/g' ${{ github.workspace }}/lib/kramdown-plantuml/version.rb
+
+    - name: Setup Ruby 2.7
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+        bundler-cache: true
+
+    - name: Setup Graphviz
+      uses: kamiazya/setup-graphviz@v1
+
+    - name: rubocop
+      run: bundle exec rubocop --fail-level warning --display-only-fail-level-offenses
 
     - name: Test with Rake
-      env:
-        GEM_VERSION: ${{ steps.gemversion.outputs.version }}
       run: bundle exec rake
 
+    - name: RSPec (debug)
+      env:
+        DEBUG: 1
+      run: bundle exec rspec --tag debug
+
+    - name: Codecov upload
+      run: bundle exec rake codecov:upload || echo 'Codecov upload failed'
+
     - name: Build gem
       id: gem
-      env:
-        GEM_VERSION: ${{ steps.gemversion.outputs.version }}
-      run: |
-        GEM_BUILD_NAME=$(gem build kramdown-plantuml.gemspec | awk '/File/ {print $2}')
-        echo "Gem filename: '${GEM_BUILD_NAME}'"
-        echo "::set-output name=name::${GEM_BUILD_NAME}"
+      run: .github/scripts/build-gem.sh
 
-    - name: Upload artifact
+    - name: Upload gem
       uses: actions/upload-artifact@v2-preview
       with:
         name: ${{ steps.gem.outputs.name }}
         path: ${{ steps.gem.outputs.name }}
 
+    - name: Inspect gem
+      run: .github/scripts/inspect-gem.sh --gem "${{ github.workspace }}/${{ steps.gem.outputs.name }}" --verbose
+
+    - name: Test gem
+      run: .github/scripts/test-gem.sh --workdir "${{ github.workspace }}/spec/fixture" --gemdir "${{ github.workspace }}" --verbose
+
+  publish-dev:
+    needs: [version, gem]
+    runs-on: ubuntu-latest
+    if: |
+        (github.event_name == 'pull_request_target' && github.actor == 'dependabot[bot]') ||
+        (github.event_name != 'pull_request_target' && github.actor != 'dependabot[bot]')
+
+    steps:
+    - uses: actions/checkout@v2
+      if: ${{ github.event_name != 'pull_request_target' }}
+
+    - uses: actions/checkout@v2
+      if: ${{ github.event_name == 'pull_request_target' }}
+      with:
+        ref: ${{ github.event.pull_request.head.sha }}
+
+    - uses: actions/download-artifact@v2
+      with:
+        name: ${{ needs.gem.outputs.name }}
+
+    - name: Set up Ruby 2.7
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+        bundler-cache: true
+
+    - name: Setup Graphviz
+      uses: kamiazya/setup-graphviz@v1
+
     - name: Publish to GPR
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        OWNER: SwedbankPay
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:github: Bearer ${GITHUB_TOKEN}\n" > $HOME/.gem/credentials
-        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} ${{ steps.gem.outputs.name }}
+      run: .github/scripts/publish-gem.sh --gem ${{ needs.gem.outputs.name }} --token "${{ secrets.GPR_TOKEN }}" --owner SwedbankPay --verbose
+
+    - name: Test gem
+      run: .github/scripts/test-gem.sh --workdir "${{ github.workspace }}/spec/fixture" --version ${{ needs.version.outputs.version }} --token "${{ secrets.GPR_TOKEN }}" --verbose
+
+    - name: Upload Jekyll site
+      uses: actions/upload-artifact@v2-preview
+      if: always()
+      with:
+        name: site
+        path: ${{ github.workspace }}/spec/fixture/_site
+
+  publish-prod:
+    needs: [version, gem]
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/') # Only publish tagged commits
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - uses: actions/download-artifact@v2
+      with:
+        name: ${{ needs.gem.outputs.name }}
 
     - name: Publish to RubyGems
-      if: startsWith(github.ref, 'refs/tags/') # Only publish tagged commits
-      env:
-        RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}\n" > $HOME/.gem/credentials
-        gem push ${{ steps.gem.outputs.name }}
+      run: .github/scripts/publish-gem.sh --gem ${{ needs.gem.outputs.name }} --token ${{ secrets.RUBYGEMS_API_KEY }} --verbose

data/.github/workflows/shell.yml

@@ -0,0 +1,11 @@
+name: Shell
+
+on: [push, pull_request]
+
+jobs:
+  shellcheck:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: ShellCheck
+        uses: bewuethr/shellcheck-action@v2

data/.gitignore

@@ -8,3 +8,12 @@
 /tmp/
 *.gem
 Gemfile.lock
+/target/
+*.jar
+/bin/
+.jekyll-cache
+_site
+.classpath
+.project
+.settings
+.vscode

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+  Exclude:
+    - "Rakefile"
+    - "_site/**/*.rb"
+    - "spec/**/*.rb"
+    - "vendor/**/.*"
+    - "vendor/**/*"
+Layout:
+  LineLength: 100
+  IndentationStyle:
+    IndentationWidth: 2
+Metrics/MethodLength:
+  Max: 20
+Naming/FileName:
+  Exclude:
+    - 'lib/kramdown-plantuml.rb'