jekyll-securitytxt 0.1.0.pre.pre.9 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58aeb260844728d59b29ab4fa10de67aafdc17b0933c5aab5e12d606d817f4f5
-  data.tar.gz: 143f72e10e722fe421fb6416276e2e42d68085f0d5804c3abe25fb75c32770ae
+  metadata.gz: 19b2ae8b2d0e614e0a8de71daed37fbf2045a258030bc6ef48da08f19aa73c04
+  data.tar.gz: 3c3bf295fcc71999ac6a1e20a192d87354441d76ab8c8e76337a5692d84ad784
 SHA512:
-  metadata.gz: 8ea535f95257369733ef29f173530a8f06b029ae23749e4a83e6b230a172c0c95a0be15b3c0759fd4de0eec111c2eac84b9d903763933a7bb617f7f05753c744
-  data.tar.gz: 372a62a8b92a3d5d8bea622b8c4f669fd1cb1b7e9ba69712d4440cb2c2b62a3a61eb685face590219573ac60b094a433bdef85336d6fd6406f9a5ba21c0c7be9
+  metadata.gz: 3b103c1689f8f96ba5eed716db80c6d46bb5ebee41e2e8b14304e7286a923ffee92543190fac7dd609d5c5919f68059e5b51b1046440633bea460ea9493ec68c
+  data.tar.gz: 8853a84942ef6836d4d00e469f3c726c93f29a303696cab17455ce0b5c5ba87385db19b4d37e5db02a3ea978bef3d2d36a806e5711bd006e2b94f5ad29873307

data/README.md

@@ -1,32 +1,51 @@
-# Jekyll::Securitytxt
+# jekyll-securitytxt
 
-TODO: Delete this and the text below, and describe your gem
+Jekyll plugin for [security.txt](https://www.rfc-editor.org/rfc/rfc9116)[^1]
 
-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/jekyll/securitytxt`. To experiment with that code, run `bin/console` for an interactive prompt.
+[^1]: RFC9116
 
 ## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+group :jekyll_plugins do
+  # ...
+  gem "jekyll-securitytxt"
+end
+```
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 the created tag, 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]/jekyll-securitytxt.
-# jekyll-securitytxt
+```yaml
+# in _config.yml
+security_txt:
+  comment: If you find any security issues on this site, please contact me!
+  contact: "mailto:<YOUR-EMAIL>"
+  preferred_languages: "ko, en"
+```
+
+if you 
+```yaml
+security_txt:
+  custom_message: |
+      # If you would like to report a security issue you may report it to us via bugbounty platform
+      Contact: https://
+```
+
+## Supported
+
+```yaml
+security_txt:
+  comment:
+  contact:
+  expires:
+  encryption:
+  preferred_languages:
+  acknowledgments:
+  policy:
+  hiring:
+  csaf:
+  canonical:
+  custom_message:
+```
+
+> [!TIP]
+> See here for information on the column. https://securitytxt.org*

data/lib/jekyll/securitytxt/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Securitytxt
-    VERSION = "0.1.0-pre.9"
+    VERSION = "1.0.1"
   end
 end

data/lib/jekyll/securitytxt.rb

@@ -29,7 +29,7 @@ module Jekyll
 
       # Get path of the template file.
       def source_path(file = "template.html")
-        File.expand_path "#{file}", __dir__
+        File.expand_path file.to_s, __dir__
       end
 
       # Path of the security.txt file.

data/lib/jekyll/template.html

@@ -28,3 +28,6 @@ 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 }}
+{% endif -%}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-securitytxt
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.pre.9
+  version: 1.0.1
 platform: ruby
 authors:
 - HAHWUL
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-18 00:00:00.000000000 Z
+date: 2024-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll