Merge pull request #435 from owasp-noir/dev

Release v0.18.0

.gitattributes

@@ -1,2 +1,4 @@
 * linguist-vendored
-*.cr linguist-vendored=false
+*.cr linguist-vendored=false
+*.rb linguist-vendored=false
+Rakefile linguist-vendored=false

.github/ISSUE_TEMPLATE/bug_report.md

@@ -23,7 +23,7 @@ If applicable, add screenshots to help explain your problem.
 
 **Versions**
  - OS: [e.g. macos, linux]
- - Version [e.g. v0.17.0]
+ - Version [e.g. v0.18.0]
 
 **Additional context**
 Add any other context about the problem here.

.github/labeler.yml

@@ -22,6 +22,9 @@
 🏷️ tagger:
   - changed-files:
       - any-glob-to-any-file: [src/tagger/**, src/models/tag.cr]
+🚔 passive-scan:
+  - changed-files:
+      - any-glob-to-any-file: [src/passive_scan/**, src/models/passive_scan.cr]
 💊 spec:
   - changed-files:
       - any-glob-to-any-file: spec/**

.github/workflows/ci.yml

@@ -3,12 +3,13 @@ name: CI
 on:
   pull_request_target:
     branches: [main, dev]
+    paths: ['**/*.cr', shard.yml, Dockerfile]
 jobs:
   build-crystal:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        crystal-version: [1.10.1, 1.11.2, 1.12.2, 1.13.1]
+        crystal-version: [1.10.1, 1.11.2, 1.12.2, 1.13.3, 1.14.0]
     steps:
       - uses: actions/checkout@v4
       - uses: MeilCli/setup-crystal-action@v4

.github/workflows/contributors.yml

@@ -16,4 +16,6 @@ jobs:
       - uses: wow-actions/contributors-list@v1
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          round: true
+          round: false
+          includeBots: true
+

.github/workflows/deadlinks.yml

@@ -0,0 +1,30 @@
+---
+    name: DeadLink
+    # Controls when the workflow will run
+    on:
+      # Allows you to run this workflow manually from the Actions tab
+      workflow_dispatch:
+    # A workflow run is made up of one or more jobs that can run sequentially or in parallel
+    jobs:
+      # This workflow contains a single job called "build"
+      build:
+        # The type of runner that the job will run on
+        runs-on: ubuntu-latest
+
+        # Steps represent a sequence of tasks that will be executed as part of the job
+        steps:
+          - name: Find Broken Link
+            uses: hahwul/[email protected]
+            id: broken-link
+            with:
+              command: sitemap
+              target: https://owasp-noir.github.io/noir/sitemap.xml
+          - name: Create an issue
+            uses: dacbd/create-issue-action@main
+            with:
+              token: ${{ github.token }}
+              title: DeadLink Issue
+              body: |
+                ```json
+                ${{ steps.broken-link.outputs.output }}
+                ```

.github/workflows/ghcr_publish.yml

@@ -7,7 +7,6 @@ name: GHCR Publish
 on:
   push:
     branches: [main, dev]
-    tags: [v*.*.*]
   release:
     types: [published]
   workflow_dispatch:

.github/workflows/jekyll.yml

@@ -1,31 +1,30 @@
+---
 # This workflow uses actions that are not certified by GitHub.
 # They are provided by a third-party and are governed by
 # separate terms of service, privacy policy, and support
 # documentation.
 
 # Sample workflow for building and deploying a Jekyll site to GitHub Pages
 name: Deploy Jekyll site to Pages
-
 on:
   # Runs on pushes targeting the default branch
   push:
-    branches: ["dev"]
+    branches: [dev]
+    paths:
+      - docs/**/*
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
-
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
   contents: read
   pages: write
   id-token: write
-
 # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
 # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
 concurrency:
-  group: "pages"
+  group: pages
   cancel-in-progress: false
-
 jobs:
   # Build job
   build:
@@ -34,12 +33,12 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       - name: Setup Ruby
-        uses: ruby/setup-ruby@8575951200e472d5f2d95c625da0c7bec8217c42 # v1.161.0
+        uses: ruby/setup-ruby@8575951200e472d5f2d95c625da0c7bec8217c42  # v1.161.0
         with:
-          ruby-version: '3.2' # Not needed with a .ruby-version file
-          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-          cache-version: 0 # Increment this number if you need to re-download cached gems
-          working-directory: docs # Needed if your Gemfile is not in the root directory
+          ruby-version: '3.2'  # Not needed with a .ruby-version file
+          bundler-cache: true  # runs 'bundle install' and caches installed gems automatically
+          cache-version: 0  # Increment this number if you need to re-download cached gems
+          working-directory: docs  # Needed if your Gemfile is not in the root directory
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v4
@@ -65,4 +64,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v4
+        uses: actions/deploy-pages@v4

.gitignore

@@ -4,7 +4,8 @@
 *.dwarf
 .DS_Store
 .vscode
+ameba.sh
 
 # Ignore the public directory for Jekyll
 /docs/_site/
-/docs/.jekyll-cache/
+/docs/.jekyll-cache/

CONTRIBUTING.md

@@ -65,6 +65,12 @@ ameba --fix
 # https://github.com/crystal-ameba/ameba#installation
 ```
 
+or 
+
+```bash
+rake lint:all
+```
+
 ## 🧭 Code structure
 
 - spec: 
@@ -89,3 +95,25 @@ To ensure a smooth integration of your contributions, please follow these steps:
 * Submit your PR to the dev branch for review.
 
 By doing so, you'll help us keep our project up-to-date and well-organized. Your efforts are greatly appreciated, and we're excited to see what you'll bring to the project!
+
+### Setting up the Documentation Site
+
+To set up the documentation site locally, follow these steps:
+
+#### Install Dependencies
+
+We use Rake tasks to manage dependencies. Run the following command to install the necessary dependencies:
+
+```sh
+rake docs:install
+```
+
+#### Serve the Documentation Site
+
+After installing the dependencies, you can serve the documentation site locally using the following Rake task:
+
+```sh
+rake docs:serve
+```
+
+This will start a local server, and you can view the documentation by navigating to http://localhost:4000 in your web browser.