Merge pull request #106 from kommitters/v1.1

Release v1.1.7
kommitters · Sep 12, 2022 · e18abdb · e18abdb
2 parents faa91c6 + 2b24e85
commit e18abdb
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 23 deletions.
diff --git a/.github/workflows/scorecards.yml b/.github/workflows/scorecards.yml
@@ -3,7 +3,7 @@ on:
   # Only the default branch is supported.
   branch_protection_rule:
   schedule:
-    - cron: '44 19 * * 4'
+    - cron: '0 0 * * 0'
   push:
     branches: [ "main" ]
 
@@ -17,20 +17,17 @@ jobs:
     permissions:
       # Needed to upload the results to code-scanning dashboard.
       security-events: write
-      # Used to receive a badge. (Upcoming feature)
+      # Used to receive a badge.
       id-token: write
-      # Needs for private repositories.
-      contents: read
-      actions: read
-
+
     steps:
       - name: "Checkout code"
-        uses: actions/checkout@a12a3943b4bdde767164f792f33f40b04645d846 # v3.0.0
+        uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # v3.0.2
         with:
           persist-credentials: false
 
       - name: "Run analysis"
-        uses: ossf/scorecard-action@3e15ea8318eee9b333819ec77a36aca8d39df13e # v1.1.1
+        uses: ossf/scorecard-action@68bf5b3327e4fd443d2add8ab122280547b4a16d # v2.0.2
         with:
           results_file: results.sarif
           results_format: sarif
@@ -41,22 +38,22 @@ jobs:
           # repo_token: ${{ secrets.SCORECARD_READ_TOKEN }}
 
           # Publish the results for public repositories to enable scorecard badges. For more details, see
-          # https://github.com/ossf/scorecard-action#publishing-results. 
-          # For private repositories, `publish_results` will automatically be set to `false`, regardless 
+          # https://github.com/ossf/scorecard-action#publishing-results.
+          # For private repositories, `publish_results` will automatically be set to `false`, regardless
           # of the value entered here.
           publish_results: true
 
       # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
       # format to the repository Actions tab.
       - name: "Upload artifact"
-        uses: actions/upload-artifact@6673cd052c4cd6fcf4b4e6e60ea986c889389535 # v3.0.0
+        uses: actions/upload-artifact@3cea5372237819ed00197afe530f5a7ea3e805c8 # v3.1.0
         with:
           name: SARIF file
           path: results.sarif
           retention-days: 5
-      
+
       # Upload the results to GitHub's code scanning dashboard.
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@5f532563584d71fdef14ee64d17bafb34f751ce5 # v1.0.26
+        uses: github/codeql-action/upload-sarif@c7f292ea4f542c473194b33813ccd4c207a6c725 # v2.1.21
         with:
           sarif_file: results.sarif
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.1.7 (12.09.2022)
+
+* Add OpenSSF BestPractices & Scorecard badges
+* Add CDN version documentation
+
 ## 1.1.6 (23.08.2022)
 
 * Fix bug dropping images or videos into the editor incorrectly causes reordering of blocks.

diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
-![](https://badgen.net/badge/Editor.js/v2.0/blue)
-
 # EditorJS Drag/Drop Plugin
+![](https://badgen.net/badge/Editor.js/v2.0/blue)
+[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/6468/badge)](https://bestpractices.coreinfrastructure.org/projects/6468)
+[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/kommitters/editorjs-drag-drop/badge)](https://api.securityscorecards.dev/projects/github.com/kommitters/editorjs-drag-drop)
 
 Drag/Drop feature for [Editor.js](https://editorjs.io).
 
@@ -22,6 +23,16 @@ Include module at your application
 import DragDrop from 'editorjs-drag-drop';
 ```
 
+### Load from CDN
+
+You can load a specific version of the package from [jsDelivr CDN](https://www.jsdelivr.com/package/npm/editorjs-drag-drop).
+
+Require this script on a page with Editor.js.
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/editorjs-drag-drop"></script>
+```
+
 ## Usage
 
 ```javascript
@@ -46,7 +57,7 @@ const editor = new EditorJS({
 ```
 ### Usage with React.
 
-If you are using React, you could create a function to handle the onReady property, the function will store the DragDrop instance. Then, you must call the function in onReady in the editorJS instance.   
+If you are using React, you could create a function to handle the onReady property, the function will store the DragDrop instance. Then, you must call the function in onReady in the editorJS instance.
 
 ```javascript
 const handleReady = (editor) => {
@@ -81,23 +92,23 @@ If you are using [react-editor-js](https://github.com/Jungwoo-An/react-editor-js
 ........
 export const ReactEditor = () => {
   const editorCore = React.useRef(null)
-    
+
   const handleInitialize = React.useCallback((instance) => {
     editorCore.current = instance
   }, [])
-    
+
   const handleReady = () => {
-    const editor = editorCore.current._editorJS; 
+    const editor = editorCore.current._editorJS;
     new Undo({ editor })
     new DragDrop(editor);
   };
-      
+
   const ReactEditorJS = createReactEditorJS()
   return(
-  <ReactEditorJS 
+  <ReactEditorJS
     onInitialize={handleInitialize}
     onReady = {handleReady}
-    tools={....} 
+    tools={....}
     defaultValue={....}
   />
   )

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "editorjs-drag-drop",
-  "version": "1.1.6",
+  "version": "1.1.7",
   "keywords": [
     "drag",
     "drop",