jekyll-securitytxt 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19b2ae8b2d0e614e0a8de71daed37fbf2045a258030bc6ef48da08f19aa73c04
-  data.tar.gz: 3c3bf295fcc71999ac6a1e20a192d87354441d76ab8c8e76337a5692d84ad784
+  metadata.gz: 781ad29a0ac4d924c4d237b028a7cd8648602af05b70f73de7137871e842cc11
+  data.tar.gz: e0d92992aa601f7eb4a594fee6b234311f97c349a103349af280f7bf1750b866
 SHA512:
-  metadata.gz: 3b103c1689f8f96ba5eed716db80c6d46bb5ebee41e2e8b14304e7286a923ffee92543190fac7dd609d5c5919f68059e5b51b1046440633bea460ea9493ec68c
-  data.tar.gz: 8853a84942ef6836d4d00e469f3c726c93f29a303696cab17455ce0b5c5ba87385db19b4d37e5db02a3ea978bef3d2d36a806e5711bd006e2b94f5ad29873307
+  metadata.gz: 591fd1598c32a33d526676be6054e48534af2f5c139fba07aad1208fe7453cafc011717d319f0ea2028ac4c0a6e03501dd3bd1a0b32053bd727630c48edefc37
+  data.tar.gz: a22ddad70f618567683069828b0bf4a39328e234538512fb22fc341b2de369c58a7533a5a24785b9fbb5b942c4f75c108a945138ff91dcaaccf05a721b7d1fd6

data/README.md

@@ -18,15 +18,20 @@ end
 # in _config.yml
 security_txt:
   comment: If you find any security issues on this site, please contact me!
-  contact: "mailto:<YOUR-EMAIL>"
+  contact: 
+  - mailto:<YOUR-EMAIL>
+  - https://YOUR_DOMAIN/CONTACT
+  hiring:
+  - https://URL1
+  - https://URL2
   preferred_languages: "ko, en"
 ```
 
-if you 
+If you need a custom message? 
 ```yaml
 security_txt:
   custom_message: |
-      # If you would like to report a security issue you may report it to us via bugbounty platform
+      If you would like to report a security issue you may report it to us via bugbounty platform
       Contact: https://
 ```
 
@@ -48,4 +53,4 @@ security_txt:
 ```
 
 > [!TIP]
-> See here for information on the column. https://securitytxt.org*
+> See here for information on the column. https://securitytxt.org*

data/jekyll-securitytxt.gemspec

@@ -8,14 +8,15 @@ Gem::Specification.new do |spec|
   spec.authors = ["HAHWUL"]
   spec.email = ["hahwul@gmail.com"]
 
-  spec.summary = "Jekyll plugin for security.txt"
-  spec.description = "Jekyll plugin for security.txt"
+  spec.summary = "A Jekyll plugin for generating security.txt files"
+  spec.description = "This plugin helps you generate security.txt files for your Jekyll site, " \
+                     "providing security contact information and policies."
   spec.homepage = "https://github.com/hahwul/jekyll-securitytxt"
   spec.required_ruby_version = ">= 2.6.0"
   spec.license = "MIT"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/hahwul/jekyll-securitytxt"
 
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
@@ -26,5 +27,6 @@ Gem::Specification.new do |spec|
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.add_dependency "jekyll"
+
+  spec.add_runtime_dependency "jekyll", "~> 4.0"
 end

data/lib/jekyll/securitytxt/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Securitytxt
-    VERSION = "1.0.1"
+    VERSION = "1.0.3"
   end
 end

data/lib/jekyll/securitytxt.rb

@@ -5,7 +5,7 @@ require "jekyll"
 
 module Jekyll
   module Securitytxt
-    # Jekyll plugin for security.txt
+    # Jekyll plugin for generating security.txt
     class Generator < Jekyll::Generator
       safe true
       priority :lowest
@@ -13,35 +13,38 @@ module Jekyll
       # Plugin entry point.
       def generate(site)
         @site = site
-        @site.pages << verification_file unless a_verification_file_exist?
+        @site.pages << create_security_txt_file unless security_txt_file_exists?
       end
 
       private
 
       # Check if a security.txt file already exists in the source tree.
-      def a_verification_file_exist?
+      def security_txt_file_exists?
         file_pattern = %r{.well-known/security\.txt?}
         exists = @site.static_files.any? { |p| p.url =~ file_pattern }
-        warn_msg = "Found a security.txt file in source tree matching /#{file_pattern.source}/; not generating one..."
-        Jekyll.logger.warn "Jekyll-securitytxt", warn_msg if exists
+        if exists
+          Jekyll.logger.warn "Jekyll-securitytxt",
+                             "Found a security.txt file in source tree matching",
+                             "/#{file_pattern.source}/; not generating one..."
+        end
         exists
       end
 
       # Get path of the template file.
-      def source_path(file = "template.html")
-        File.expand_path file.to_s, __dir__
+      def template_file_path(file = "template.html")
+        File.expand_path(file.to_s, __dir__)
       end
 
       # Path of the security.txt file.
-      def securitytxt_path
+      def security_txt_file_path
         ".well-known/security.txt"
       end
 
       # Construct a file object from a template with content that can be added to generated pages
-      def verification_file
-        Jekyll.logger.info "Jekyll-securitytxt", "Generating #{securitytxt_path}"
-        page = PageWithoutAFile.new(@site, __dir__, "", securitytxt_path)
-        page.content = File.read(source_path)
+      def create_security_txt_file
+        Jekyll.logger.info "Jekyll-securitytxt", "Generating #{security_txt_file_path}"
+        page = PageWithoutAFile.new(@site, __dir__, "", security_txt_file_path)
+        page.content = File.read(template_file_path)
         page.data["layout"] = nil
         page
       end

data/lib/jekyll/template.html

@@ -2,25 +2,33 @@
 # {{ site.security_txt.comment }}
 {% endif -%}
 {% if site.security_txt.contact -%}
-Contact: {{ site.security_txt.contact }}
+{% for contact in site.security_txt.contact %}
+Contact: {{ contact }}
+{% endfor %}
 {% endif -%}
 {% if site.security_txt.expires -%}
 Expires: {{ site.security_txt.expires }}
 {% endif -%}
 {% if site.security_txt.encryption -%}
-Encryption: {{ site.security_txt.encryption }}
+{% for encryption in site.security_txt.encryption %}
+Encryption: {{ encryption }}
+{% endfor %}
 {% endif -%}
 {% if site.security_txt.preferred_languages -%}
 Preferred-Languages: {{ site.security_txt.preferred_languages }}
 {% endif -%}
 {% if site.security_txt.acknowledgments -%}
-Acknowledgments: {{ site.security_txt.acknowledgments }}
+{% for acknowledgment in site.security_txt.acknowledgments %}
+Acknowledgments: {{ acknowledgment }}
+{% endfor %}
 {% endif -%}
 {% if site.security_txt.policy -%}
 Policy: {{ site.security_txt.policy }}
 {% endif -%}
 {% if site.security_txt.hiring -%}
-Hiring: {{ site.security_txt.hiring }}
+{% for hiring in site. security_txt.hiring %}
+Hiring: {{ hiring }}
+{% endfor %}
 {% endif -%}
 {% if site.security_txt.csaf -%}
 CSAF: {{ site.security_txt.csaf }}
@@ -28,6 +36,8 @@ CSAF: {{ site.security_txt.csaf }}
 {% if site.security_txt.canonical -%}
 Canonical: {{ site.security_txt.canonical }}
 {% endif -%}
-{% if site.security_txt.custom_message -%}
-{{ site.security_txt.custom_message }}
+{% if site.security_txt.custom_messages -%}
+{% for custom_message in site.security_txt.custom_messages %}
+{{ custom_message }}
+{% endfor %}
 {% endif -%}

metadata

@@ -1,30 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-securitytxt
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - HAHWUL
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-19 00:00:00.000000000 Z
+date: 2024-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Jekyll plugin for security.txt
+        version: '4.0'
+description: This plugin helps you generate security.txt files for your Jekyll site,
+  providing security contact information and policies.
 email:
 - hahwul@gmail.com
 executables: []
@@ -61,8 +62,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
-summary: Jekyll plugin for security.txt
+summary: A Jekyll plugin for generating security.txt files
 test_files: []