Set up license guard, add license headers

.github/other/licenserc.yml

@@ -0,0 +1,30 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+# File format: see https://github.com/apache/skywalking-eyes/blob/main/test/testdata/.licenserc_language_config_test.yaml
+
+header:
+  license:
+    spdx-id: MPL-2.0
+
+  paths:
+    - '**/*.rs'
+    - '**/*.gd'
+    - '**/*.sh'
+    - '**/*.md'
+    - '.github/**/*.yml'
+
+  paths-ignore:
+    - 'ReadMe.md'
+    - '.github/ISSUE_TEMPLATE'
+
+  comment: on-failure
+
+  language:
+    GDScript:
+      extensions: ['.gd', '.sh']
+      comment_style_id: 'Hashtag'
+    Rust:
+      extensions: ['.rs']
+      comment_style_id: 'SlashAsterisk'

.github/workflows/cd.yml

@@ -1,8 +1,13 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
 name: "Deploy to GitHub Pages"
 
 on:
   push:
     branches: [master]
+  pull_request:
 
 env:
   # Use fixed versions for now, replace with 'latest' to auto-use latest
@@ -14,12 +19,13 @@ env:
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
-  contents: read
+#  contents: read
+  contents: write
   pages: write
   id-token: write
 
 jobs:
-  build-and-deploy:
+  build:
     runs-on: ubuntu-latest
 
     steps:
@@ -48,9 +54,37 @@ jobs:
       run: mdbook build
 
     - name: "Upload Pages artifact"
+      if: github.ref == 'refs/heads/master'
       uses: actions/upload-pages-artifact@v1
       with:
         path: book
 
     - name: "Deploy to GitHub Pages"
+      if: github.ref == 'refs/heads/master'
       uses: actions/deploy-pages@v2
+
+
+  license-guard:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: "Check license headers"
+        uses: apache/skywalking-eyes/[email protected]
+        with:
+          # log: debug # optional: set the log level. The default value is `info`.
+          config: .github/other/licenserc.yml
+          # token: # optional: the token that license eye uses when it needs to comment on the pull request.
+          # Set to empty ("") to disable commenting on pull request. The default value is ${{ github.token }}
+          # mode: # optional: Which mode License-Eye should be run in. Choices are `check` or `fix`. The default value is `check`.
+          mode: check
+#          mode: fix
+
+#      - name: "Commit changes"
+#        uses: EndBug/add-and-commit@v9
+#        env:
+#          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+#        with:
+#          author_name: 'Godot-Rust Automation'
+#          author_email: '[email protected]'
+#          message: 'Auto-apply license headers'

book.toml

@@ -1,3 +1,7 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
 [book]
 authors = ["The godot-rust developers"]
 multilingual = false

src/SUMMARY.md

@@ -1,3 +1,9 @@
+<!--
+  ~ This Source Code Form is subject to the terms of the Mozilla Public
+  ~ License, v. 2.0. If a copy of the MPL was not distributed with this
+  ~ file, You can obtain one at https://mozilla.org/MPL/2.0/.
+-->
+
 # Summary
 
 - [Introduction](index.md)

src/contribute/conventions.md

@@ -1,3 +1,9 @@
+<!--
+  ~ This Source Code Form is subject to the terms of the Mozilla Public
+  ~ License, v. 2.0. If a copy of the MPL was not distributed with this
+  ~ file, You can obtain one at https://mozilla.org/MPL/2.0/.
+-->
+
 # Code and API conventions
 
 

src/contribute/dev-tools.md

@@ -1,3 +1,8 @@
+<!--
+  ~ This Source Code Form is subject to the terms of the Mozilla Public
+  ~ License, v. 2.0. If a copy of the MPL was not distributed with this
+  ~ file, You can obtain one at https://mozilla.org/MPL/2.0/.
+-->
 
 # Dev tools and testing
 

src/contribute/index.md

@@ -1,3 +1,9 @@
+<!--
+  ~ This Source Code Form is subject to the terms of the Mozilla Public
+  ~ License, v. 2.0. If a copy of the MPL was not distributed with this
+  ~ file, You can obtain one at https://mozilla.org/MPL/2.0/.
+-->
+
 # Contributing to gdext
 
 This chapter provides deeper information for people who are interested in contributing to the library.

src/index.md

@@ -1,3 +1,9 @@
+<!--
+  ~ This Source Code Form is subject to the terms of the Mozilla Public
+  ~ License, v. 2.0. If a copy of the MPL was not distributed with this
+  ~ file, You can obtain one at https://mozilla.org/MPL/2.0/.
+-->
+
 # Introduction
 
 Welcome to the **godot-rust book**! This is a work-in-progress user guide for **gdext**, the Rust binding for Godot 4.

src/intro/hello-world.md

@@ -1,3 +1,9 @@
+<!--
+  ~ This Source Code Form is subject to the terms of the Mozilla Public
+  ~ License, v. 2.0. If a copy of the MPL was not distributed with this
+  ~ file, You can obtain one at https://mozilla.org/MPL/2.0/.
+-->
+
 # Hello World
 
 This page shows you how to develop your own small extension library and load it from Godot.

src/intro/index.md

@@ -1,3 +1,9 @@
+<!--
+  ~ This Source Code Form is subject to the terms of the Mozilla Public
+  ~ License, v. 2.0. If a copy of the MPL was not distributed with this
+  ~ file, You can obtain one at https://mozilla.org/MPL/2.0/.
+-->
+
 # Getting Started
 
 This chapter guides you through the process of setting up **gdext** and developing your first application with it.

src/intro/objects.md

@@ -1,3 +1,9 @@
+<!--
+  ~ This Source Code Form is subject to the terms of the Mozilla Public
+  ~ License, v. 2.0. If a copy of the MPL was not distributed with this
+  ~ file, You can obtain one at https://mozilla.org/MPL/2.0/.
+-->
+
 # Managing objects in Rust
 
 This chapter covers the most central mechanism of the Rust bindings -- one that will accompany you from the Hello-World

src/intro/setup.md

@@ -1,3 +1,9 @@
+<!--
+  ~ This Source Code Form is subject to the terms of the Mozilla Public
+  ~ License, v. 2.0. If a copy of the MPL was not distributed with this
+  ~ file, You can obtain one at https://mozilla.org/MPL/2.0/.
+-->
+
 # Setup
 
 To use gdext, we need a few technologies.

src/toolchain/compatibility.md

@@ -1,3 +1,9 @@
+<!-- 
+    This Source Code Form is subject to the terms of the Mozilla Public
+    License, v. 2.0. If a copy of the MPL was not distributed with this
+    file, You can obtain one at https://mozilla.org/MPL/2.0/. 
+-->
+
 # Compatibility and stability
 
 The gdext library supports all stable Godot releases starting from Godot 4.0. 

src/toolchain/debugging.md

@@ -1,3 +1,9 @@
+<!--
+  ~ This Source Code Form is subject to the terms of the Mozilla Public
+  ~ License, v. 2.0. If a copy of the MPL was not distributed with this
+  ~ file, You can obtain one at https://mozilla.org/MPL/2.0/.
+-->
+
 # Debugging
 
 Extensions written in gdext can be debugged using LLDB, in a similar manner to other Rust programs. The primary difference is that LLDB will

src/toolchain/godot-version.md

@@ -1,3 +1,9 @@
+<!--
+  ~ This Source Code Form is subject to the terms of the Mozilla Public
+  ~ License, v. 2.0. If a copy of the MPL was not distributed with this
+  ~ file, You can obtain one at https://mozilla.org/MPL/2.0/.
+-->
+
 # Selecting a Godot version
 
 By default, `gdext` uses the latest stable release of Godot. This is desired in most cases, but it means that you cannot run your extension in

src/toolchain/index.md

@@ -1,3 +1,9 @@
+<!--
+  ~ This Source Code Form is subject to the terms of the Mozilla Public
+  ~ License, v. 2.0. If a copy of the MPL was not distributed with this
+  ~ file, You can obtain one at https://mozilla.org/MPL/2.0/.
+-->
+
 # Toolchain
 
 Beyond Rust, there are quite a few things that are handy to know when working with Godot. This chapter goes into more detail