Skip to content

Add jekyll-sitemap plugin to Jekyll config#7

Merged
OriNachum merged 2 commits into
mainfrom
add-jekyll-sitemap
Apr 8, 2026
Merged

Add jekyll-sitemap plugin to Jekyll config#7
OriNachum merged 2 commits into
mainfrom
add-jekyll-sitemap

Conversation

@OriNachum
Copy link
Copy Markdown
Contributor

Add jekyll-sitemap plugin to the Jekyll _config.yml to automatically generate a sitemap.xml for the documentation site. This improves SEO by helping search engines discover and index all pages.

Copilot AI review requested due to automatic review settings April 8, 2026 21:44
@qodo-code-review
Copy link
Copy Markdown

Review Summary by Qodo

Add jekyll-sitemap plugin to Jekyll configuration

✨ Enhancement

Grey Divider

Walkthroughs

Description
• Adds jekyll-sitemap plugin to Jekyll configuration
• Automatically generates sitemap.xml for documentation site
• Improves SEO by helping search engines discover pages
Diagram
flowchart LR
  A["Jekyll Config"] -- "adds plugin" --> B["jekyll-sitemap"]
  B -- "generates" --> C["sitemap.xml"]
  C -- "improves" --> D["SEO"]
Loading

Grey Divider

File Changes

1. _config.yml ✨ Enhancement +1/-0

Add jekyll-sitemap plugin to plugins list

• Adds jekyll-sitemap to the plugins list in Jekyll configuration
• Plugin will automatically generate sitemap.xml for the documentation site
• Enhances SEO by enabling search engines to discover all pages

_config.yml


Grey Divider

Qodo Logo

@qodo-code-review
Copy link
Copy Markdown

qodo-code-review Bot commented Apr 8, 2026

Code Review by Qodo

🐞 Bugs (2)   📘 Rule violations (0)   📎 Requirement gaps (0)   🎨 UX Issues (0)
🐞\ ≡ Correctness (1) ☼ Reliability (1)

Grey Divider


Action required

1. Invalid YAML indentation 🐞
Description
jekyll-sitemap is indented as if it were nested under jekyll-relative-links, which makes
_config.yml invalid YAML and prevents Jekyll from loading the config during build.
Code

_config.yml[R23-26]

plugins:
  - jekyll-seo-tag
  - jekyll-relative-links
+    - jekyll-sitemap
Evidence
In _config.yml, the plugins: entries are at the same list level with two-space indentation, but
the newly added - jekyll-sitemap line is indented further, creating an invalid structure (a nested
list under a scalar). The GitHub Pages workflow runs bundle exec jekyll build, which parses
_config.yml and will fail on invalid YAML.

_config.yml[23-27]
.github/workflows/pages.yml[24-37]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
`_config.yml` has an incorrectly-indented `jekyll-sitemap` entry under `plugins`, making the YAML invalid.

### Issue Context
All plugin list items must be at the same indentation level under `plugins:`.

### Fix Focus Areas
- _config.yml[23-27]

### Suggested change
Ensure the line is aligned like the other list items:
```yml
plugins:
 - jekyll-seo-tag
 - jekyll-relative-links
 - jekyll-sitemap
```

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


2. Missing sitemap gem dependency 🐞
Description
_config.yml enables the jekyll-sitemap plugin, but the gem is not declared in
Gemfile/Gemfile.lock, so bundle exec jekyll build in CI will fail when loading plugins.
Code

_config.yml[26]

+    - jekyll-sitemap
Evidence
The repo’s GitHub Pages build uses Bundler (bundle exec jekyll build). Gemfile and the lockfile
dependency list do not include jekyll-sitemap, so the plugin configured in _config.yml won’t be
available in the bundle and the build will fail once it tries to load configured plugins.

_config.yml[23-27]
Gemfile[1-6]
Gemfile.lock[170-175]
.github/workflows/pages.yml[24-37]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
`jekyll-sitemap` is configured as a Jekyll plugin but is not included in the Bundler dependencies, causing CI builds to fail.

### Issue Context
The GitHub Pages workflow runs `bundle exec jekyll build`, so all plugins listed in `_config.yml` must be present in `Gemfile` and locked in `Gemfile.lock`.

### Fix Focus Areas
- Gemfile[1-6]
- Gemfile.lock[170-175]

### Suggested change
1. Add to `Gemfile`:
```rb
gem "jekyll-sitemap"
```
2. Run `bundle install` and commit the updated `Gemfile.lock`.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

ⓘ The new review experience is currently in Beta. Learn more

Grey Divider

Qodo Logo

Comment thread _config.yml
Comment on lines 23 to +26
plugins:
- jekyll-seo-tag
- jekyll-relative-links
- jekyll-sitemap
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Action required

1. Invalid yaml indentation 🐞 Bug ≡ Correctness

jekyll-sitemap is indented as if it were nested under jekyll-relative-links, which makes
_config.yml invalid YAML and prevents Jekyll from loading the config during build.
Agent Prompt
### Issue description
`_config.yml` has an incorrectly-indented `jekyll-sitemap` entry under `plugins`, making the YAML invalid.

### Issue Context
All plugin list items must be at the same indentation level under `plugins:`.

### Fix Focus Areas
- _config.yml[23-27]

### Suggested change
Ensure the line is aligned like the other list items:
```yml
plugins:
  - jekyll-seo-tag
  - jekyll-relative-links
  - jekyll-sitemap
```

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

Comment thread _config.yml
plugins:
- jekyll-seo-tag
- jekyll-relative-links
- jekyll-sitemap
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Action required

2. Missing sitemap gem dependency 🐞 Bug ☼ Reliability

_config.yml enables the jekyll-sitemap plugin, but the gem is not declared in
Gemfile/Gemfile.lock, so bundle exec jekyll build in CI will fail when loading plugins.
Agent Prompt
### Issue description
`jekyll-sitemap` is configured as a Jekyll plugin but is not included in the Bundler dependencies, causing CI builds to fail.

### Issue Context
The GitHub Pages workflow runs `bundle exec jekyll build`, so all plugins listed in `_config.yml` must be present in `Gemfile` and locked in `Gemfile.lock`.

### Fix Focus Areas
- Gemfile[1-6]
- Gemfile.lock[170-175]

### Suggested change
1. Add to `Gemfile`:
```rb
gem "jekyll-sitemap"
```
2. Run `bundle install` and commit the updated `Gemfile.lock`.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds automatic sitemap generation for the Jekyll documentation site by enabling the jekyll-sitemap plugin in _config.yml, improving search engine discoverability.

Changes:

  • Add jekyll-sitemap to the Jekyll plugins list in _config.yml.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread _config.yml
plugins:
- jekyll-seo-tag
- jekyll-relative-links
- jekyll-sitemap
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

jekyll-sitemap is indented as if it were nested under the previous list item, which makes the YAML invalid (or at least not a third plugin entry). It should be aligned with the other plugin entries under plugins:.

Also, jekyll-sitemap isn’t currently listed in the Gemfile, so builds that use Bundler will fail unless the gem is added (and lockfile updated) alongside this config change.

Suggested change
- jekyll-sitemap
- jekyll-sitemap

Copilot uses AI. Check for mistakes.
@OriNachum OriNachum merged commit 899b48e into main Apr 8, 2026
2 checks passed
@OriNachum OriNachum deleted the add-jekyll-sitemap branch April 8, 2026 21:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants