jekyll-collection-pages 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 97a284bb86cc0d06f068f04d67815db35d54294af4449a7070b29d4d5ddca255
+  data.tar.gz: 35b687df7a07642a508ed417e26d1b32ba4c9627366370a9de711e786ba99b07
+SHA512:
+  metadata.gz: 8481bd3ea5c40e2dec1f7a5b007a6735e9162e874f4a5ee3407454163036f6427e6d1f2f6137ede947c4b8cb8438b3365b64358baa05c90f36a5b0df60d953de
+  data.tar.gz: a23a1f8ec7644c2151fdd36a159c2fe5b5adac1d673ccab2e79cf2b47968e96d7cc8a0ab0e82e6ea026556c00e2c82394fc8e8d4beeb1a827ca974f11f5f028f

data/.devcontainer/devcontainer.json

@@ -0,0 +1,27 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+	"name": "Ruby",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/base:ubuntu-24.04",
+	"features": {
+		"ghcr.io/devcontainers/features/ruby:1": {
+			"version": "3.3.4"
+		}
+	},
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	"forwardPorts": [
+		// Jekyll server
+		4000,
+		// Live reload server
+		35729
+	],
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": ".devcontainer/post-create.sh"
+	// Configure tool-specific properties.
+	// "customizations": {},
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

data/.devcontainer/post-create.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+# Install the version of Bundler.
+if [ -f Gemfile.lock ] && grep "BUNDLED WITH" Gemfile.lock > /dev/null; then
+    cat Gemfile.lock | tail -n 2 | grep -C2 "BUNDLED WITH" | tail -n 1 | xargs gem install bundler -v
+fi
+
+# If there's a Gemfile, then run `bundle install`
+# It's assumed that the Gemfile will install Jekyll too
+if [ -f Gemfile ]; then
+    bundle install
+fi
+
+# Get the current ruby version and set .ruby-version
+ruby_version=$(ruby -v | awk '{print $2}')
+printf %s "$ruby_version" > .ruby-version
+echo "Ruby version $ruby_version set in .ruby-version file"

data/.github/build.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+set -e
+bundle exec jekyll build -s demo

data/.github/bump.sh

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+VERSION_FILE="VERSION"
+
+if [[ $# -lt 1 || $# -gt 2 ]]; then
+  echo "Usage: $0 <version> [--dry-run]"
+  exit 1
+fi
+
+new_version="$1"
+
+if ! [[ "$new_version" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+  echo "Invalid version format: $new_version"
+  echo "Expected format: x.y.z (e.g., 1.2.3)"
+  exit 1
+fi
+
+if [[ ! -f "$VERSION_FILE" ]]; then
+  echo "Version file not found: $VERSION_FILE"
+  exit 1
+fi
+
+echo "Bumping version to $new_version in $VERSION_FILE"
+sed -i.bak -E 's/[0-9]+\.[0-9]+\.[0-9]+/'"$new_version"'/' "$VERSION_FILE"
+rm -f "$VERSION_FILE.bak"
+
+echo "Updated to version $new_version"

data/.github/dependabot.yml

@@ -0,0 +1,12 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for more information:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+# https://containers.dev/guide/dependabot
+
+version: 2
+updates:
+ - package-ecosystem: "devcontainers"
+   directory: "/"
+   schedule:
+     interval: weekly

data/.github/pr-labeler.yml

@@ -0,0 +1,7 @@
+breaking: ['major/*', 'breaking/*']
+bug: ['fix/*', 'bugfix/*', 'bug/*']
+dependencies: ['deps/*', 'dependendies/*']
+docs: ['docs/*', 'doc/*']
+feature: ['feature/*', 'feat/*', 'new/*']
+maintenance: ['chore/*', 'maint/*', 'noop/*', 'no-op/*', 'dev/*', 'devops/*']
+skip-changelog: ['skip/*']

data/.github/release-drafter.yml

@@ -0,0 +1,40 @@
+name-template: "Release $RESOLVED_VERSION"
+tag-template: "$RESOLVED_VERSION"
+template: |
+  # What’s Changed
+
+  $CHANGES
+categories:
+  - title: ':zap: Breaking'
+    label: 'breaking'
+  - title: ':rocket: New'
+    label: 'feature'
+  - title: ':bug: Bug Fixes'
+    label: 'bug'
+  - title: ':toolbox: Maintenance'
+    label: 'maintenance'
+  - title: ':memo: Documentation'
+    label: 'docs'
+  - title: 'Dependency Updates'
+    label: 'dependencies'
+    collapse-after: 3
+
+version-resolver:
+  major:
+    labels:
+      - 'breaking'
+      - 'major'
+  minor:
+    labels:
+      - 'feature'
+      - 'minor'
+  patch:
+    labels:
+      - 'bug'
+      - 'maintenance'
+      - 'docs'
+      - 'dependencies'
+      - 'security'
+
+exclude-labels:
+  - 'skip-changelog'

data/.github/release.sh

@@ -0,0 +1,69 @@
+#!/bin/bash
+
+# Function to load environment variables from .env file if it exists
+load_env_file() {
+  env_file=".env"
+  if [ -f "$env_file" ]; then
+    echo "Loading environment variables from $env_file..."
+    export $(cat "$env_file" | xargs)
+  fi
+}
+
+# Function to build the gem and get the path of the generated gem file
+build_gem() {
+  gemspec_file="$1"
+
+  # Check if gemspec file exists
+  if [ ! -f "$gemspec_file" ]; then
+    echo "Error: Gemspec file '$gemspec_file' not found."
+    exit 1
+  fi
+
+  # Build the gem
+  gem_file=$(gem build "$gemspec_file" | awk '/File:/ {print $2}')
+
+  echo "$gem_file"
+}
+
+# Function to set up RubyGems credentials
+setup_rubygems_credentials() {
+  if [ -z "$RUBYGEMS_USERNAME" ] || [ -z "$RUBYGEMS_API_KEY" ]; then
+    echo "Error: RUBYGEMS_USERNAME and RUBYGEMS_API_KEY environment variables must be set."
+    exit 1
+  fi
+
+  mkdir -p ~/.gem
+  echo -e "---\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials
+  chmod 0600 ~/.gem/credentials
+}
+
+# Function to upload the gem to RubyGems
+upload_gem() {
+  gem_file="$1"
+
+  # Check if gem file exists
+  if [ ! -f "$gem_file" ]; then
+    echo "Error: Gem file '$gem_file' not found."
+    exit 1
+  fi
+
+  # Push the gem to RubyGems
+  gem push "$gem_file" --host https://rubygems.org
+}
+
+# Usage example
+if [ "$#" -ne 1 ]; then
+  echo "Usage: $0 <path_to_gemspec_file>"
+else
+  load_env_file
+  gemspec_file="$1"
+  generated_gem_file=$(build_gem "$gemspec_file")
+  echo "Generated gem file: $generated_gem_file"
+
+  # Set up RubyGems credentials
+  setup_rubygems_credentials
+
+  # Upload the gem to RubyGems
+  upload_gem "$generated_gem_file"
+  echo "Pushed gem file: $generated_gem_file"
+fi

data/.github/test.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -e
+
+bundle exec rake spec

data/.github/workflows/ci.yml

@@ -0,0 +1,92 @@
+name: CI jekyll plugin
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    name: RuboCop Lint
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run RuboCop
+        run: bundle exec rubocop
+  # test job
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        # Test active versions of ruby and github pages combo
+        ruby: ['3.2', '3.3', '3.4']
+        jekyll: ['3.10.0', '4.3.4', '4.4.0', '4.4.1'] 
+        include:
+          - ruby: '3.3.4'
+            jekyll: '3.10.0'
+    name: Test Ruby ${{ matrix.ruby }} / Jekyll ${{ matrix.jekyll }}
+    env:
+      JEKYLL_VERSION: ${{ matrix.jekyll }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+      - name: Test spec
+        run: .github/test.sh
+
+      - name: Show installed gems
+        if: failure()
+        run: bundle list
+
+  integration:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        # Test active versions of ruby and github pages combo
+        ruby: ['3.2', '3.3', '3.4']
+        jekyll: ['3.10.0', '4.3.4', '4.4.0', '4.4.1'] 
+        include:
+          - ruby: '3.3.4'
+            jekyll: '3.10.0'
+    name: Build Ruby ${{ matrix.ruby }} / Jekyll ${{ matrix.jekyll }}
+    env:
+      JEKYLL_VERSION: ${{ matrix.jekyll }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+      - name: Run build
+        run: .github/build.sh
+
+  ci_success:
+    runs-on: ubuntu-latest
+    needs: [lint, test, integration]
+    steps:
+      - name: Confirm all dependencies succeeded
+        run: echo "All matrix and lint tests passed successfully."

data/.github/workflows/pr_labeler.yml

@@ -0,0 +1,16 @@
+name: PR labeler
+on:
+  pull_request:
+    types: [opened]
+
+jobs:
+  pr-labeler:
+    permissions:
+      contents: read # for TimonVS/pr-labeler-action to read config file
+      pull-requests: write # for TimonVS/pr-labeler-action to add labels in PR
+    runs-on: ubuntu-latest
+    steps:
+      - uses: TimonVS/pr-labeler-action@v5
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          configuration-path: .github/pr-labeler.yml # optional, .github/pr-labeler.yml is the default value

data/.github/workflows/release.yml

@@ -0,0 +1,23 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1.190.0
+        with:
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+          cache-version: 1 # Increment this number if you need to re-download cached gems
+      - name: Release
+        run: .github/release.sh jekyll-collection-pages.gemspec
+        env:
+          RUBYGEMS_USERNAME: ${{ secrets.RUBYGEMS_USERNAME }}
+          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}

data/.github/workflows/release_draft.yml

@@ -0,0 +1,61 @@
+name: Draft release
+
+on:
+  push:
+    branches:
+      - main  # Updates the PR only if it already exists
+  workflow_dispatch:  # Manually trigger to create a new PR
+
+jobs:
+  draft-release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write  # Required for updating release notes
+    outputs:
+      tag_name: ${{ steps.release-draft.outputs.tag_name }}
+      version: ${{ steps.release-draft.outputs.resolved_version }}
+      changelog: ${{ steps.release-draft.outputs.body }}
+    steps:
+      - name: Checkout main branch
+        uses: actions/checkout@v4
+
+      - name: Run Release Drafter
+        id: release-draft
+        uses: release-drafter/release-drafter@v6
+        with:
+          config-name: release-drafter.yml
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+
+  bump-version:
+    runs-on: ubuntu-latest
+    needs: draft-release
+    if: ${{ needs.draft-release.outputs.version }}
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Checkout main branch
+        uses: actions/checkout@v4
+
+      - name: Bump version
+        run: |
+          version="${{ needs.draft-release.outputs.version }}"
+          echo "Preparing release for version $version"
+          .github/bump.sh "$version"
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+      
+      - name: Update version in gemfile
+        run: bundle install
+
+      - name: Create Draft Pull Request
+        uses: peter-evans/create-pull-request@v7
+        with:
+          commit-message: "Bump version to ${{ needs.draft-release.outputs.tag_name }}"
+          branch: release/draft
+          title: "Bump to version ${{ needs.draft-release.outputs.tag_name }}"
+          body: |
+            This PR bumps the version to `${{ needs.draft-release.outputs.tag_name }}`.
+          token: ${{ secrets.PR_TOKEN }}

data/.github/workflows/site.yml

@@ -0,0 +1,91 @@
+# Workflow for building and deploying a Jekyll site to GitHub Pages
+name: site
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+  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"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+        with:
+          enablement: true # Enable github pages if it's not
+      - name: Build
+        run: bundle exec jekyll build -s demo
+        env:
+          JEKYLL_ENV: production
+          JEKYLL_GITHUB_TOKEN: ${{ github.token }}
+      - name: HTMLProofer
+        uses: athackst/htmlproofer-action@v0.3.0
+        with:
+          ignore_urls: |
+            https://opensource.org/license/mit/
+          swap_urls: |
+            ^${{ steps.pages.outputs.base_path }}:
+            ^.*${{ steps.pages.outputs.host }}${{ steps.pages.outputs.base_path }}:
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  # Deployment job
+  deploy:
+    if: github.ref == 'refs/heads/main' # Only deploy from the main branch
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+      actions: read
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+
+  site_success:
+    if: always()
+    runs-on: ubuntu-latest
+    needs: [build]
+    steps:
+      - run: exit 1
+        # see https://stackoverflow.com/a/67532120/4907315
+        if: >-
+          ${{
+               contains(needs.*.result, 'failure')
+            || contains(needs.*.result, 'cancelled')
+          }}
+      - run: echo "All steps completed successfully"
+      - name: Check rate limit
+        run: |
+          gh api \
+            -H "Accept: application/vnd.github+json" \
+            -H "X-GitHub-Api-Version: 2022-11-28" \
+            /rate_limit
+        env:
+          GH_TOKEN: ${{ github.token }}

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.DS_Store
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+_site/
+**/.jekyll-cache/
+Gemfile.lock
+.env

data/.rubocop.yml

@@ -0,0 +1,43 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+
+# Naming cops
+# ----------------------------------------
+Naming/FileName:
+  Exclude:
+    - lib/jekyll-collection-pages.rb   # gem entry point must match require name
+    - lib/**/jekyll-collection-pages.rb
+
+# Layout cops
+# ----------------------------------------
+Layout/LineLength:
+  Max: 150
+  AllowedPatterns:
+    - '\A# '   # allow long comment URLs/notes
+
+# Metrics cops
+# ----------------------------------------
+Metrics/AbcSize:
+  Max: 23
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+Metrics/ClassLength:
+  Max: 240
+Metrics/CyclomaticComplexity:
+  Max: 11
+Metrics/MethodLength:
+  Max: 20
+Metrics/ModuleLength:
+  Max: 240
+Metrics/ParameterLists:
+  Max: 4
+Metrics/PerceivedComplexity:
+  Max: 13
+
+# Style cops
+# ----------------------------------------
+Style/Documentation:
+  Enabled: false   # tiny gems / plugins rarely need top-level class docs

data/.rubocop_todo.yml

@@ -0,0 +1,33 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-11-10 23:46:57 UTC using RuboCop version 1.81.7.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/jekyll/collection_pages.rb'
+
+# Offense count: 3
+# Configuration parameters: CountComments, Max, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/jekyll/collection_pages.rb'
+
+# Offense count: 3
+# Configuration parameters: Max, CountKeywordArgs, MaxOptionalParameters.
+Metrics/ParameterLists:
+  Exclude:
+    - 'lib/jekyll/collection_pages.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: AllowedReceivers.
+# AllowedReceivers: Thread.current
+Style/HashEachMethods:
+  Exclude:
+    - 'spec/jekyll_collection_pages_spec.rb'

data/.ruby-version

@@ -0,0 +1 @@
+3.3.4

data/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "rubyLsp.rubyVersionManager": {
+        "identifier": "none"
+    },
+}

data/.vscode/tasks.json

@@ -0,0 +1,58 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "bundle install",
+            "type": "shell",
+            "command": "bundle install",
+            "problemMatcher": []
+        },
+        {
+            "label": "bundle update",
+            "type": "shell",
+            "command": "bundle update"
+        },
+        {
+            "label": "test",
+            "type": "shell",
+            "command": ".github/test.sh",
+            "group": {
+                "kind": "test",
+                "isDefault": true
+            }
+        },
+        {
+            "label": "lint",
+            "type": "shell",
+            "command": "bundle exec rubocop",
+            "group": "build",
+            "problemMatcher": []
+        },
+        {
+            "label": "format",
+            "type": "shell",
+            "command": "bundle exec rubocop -A",
+            "problemMatcher": []
+        },
+        {
+            "label": "demo: build",
+            "type": "shell",
+            "command": "bundle exec jekyll build -s demo --verbose",
+            "problemMatcher": []
+        },
+        {
+            "label": "demo: serve",
+            "type": "shell",
+            "command": "bundle exec jekyll serve -s demo --verbose --livereload",
+            "problemMatcher": []
+        },
+        {
+            "label": "gem: build",
+            "type": "shell",
+            "command": "gem build *.gemspec",
+            "problemMatcher": []
+        }
+    ]
+}