Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: add jekyll build to ci #172

Merged
merged 4 commits into from
Nov 2, 2024
Merged

Conversation

maehr
Copy link
Member

@maehr maehr commented Oct 30, 2024

Pull request

Proposed changes

Types of changes

  • New feature (non-breaking change which adds functionality).
  • Enhancement (non-breaking change which enhances functionality)
  • Bug Fix (non-breaking change which fixes an issue).
  • Breaking change (fix or feature that would cause existing functionality to change).

Checklist

  • I have read the CONTRIBUTING document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

Summary by CodeRabbit

  • New Features

    • Introduced a new Continuous Integration job for Jekyll to enhance the build process.
  • Chores

    • Optimized dependency management with bundler caching in the Jekyll job.

Copy link

changeset-bot bot commented Oct 30, 2024

⚠️ No Changeset found

Latest commit: 4ea229b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@maehr maehr requested a review from koilebeit October 30, 2024 17:09
Copy link

coderabbitai bot commented Oct 30, 2024

Walkthrough

The changes in this pull request introduce a new job named jekyll to the existing GitHub Actions Continuous Integration workflow. This job is dependent on the prettier job and runs on an Ubuntu 22.04 environment. It involves checking out the repository, setting up Ruby, and building the project with Jekyll in production mode. Bundler caching is utilized for dependency management. The prettier job remains unchanged except for a newline addition.

Changes

File Change Summary
.github/workflows/ci.yml Added a new job jekyll dependent on prettier, configured for Jekyll build on Ubuntu 22.04.

Possibly related PRs

Suggested reviewers

  • koilebeit

🐰 In the garden, where we play,
A new job hops in today!
With Jekyll's magic, builds will flow,
Prettier first, then watch it grow.
In Ubuntu's arms, we craft with glee,
A workflow bright, as bright can be! 🌼


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 729a3de and 4ea229b.

📒 Files selected for processing (1)
  • .github/workflows/ci.yml (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/ci.yml

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5f70da8 and 8b4f0a8.

📒 Files selected for processing (1)
  • .github/workflows/ci.yml (1 hunks)
🧰 Additional context used
🪛 yamllint
.github/workflows/ci.yml

[error] 30-30: trailing spaces

(trailing-spaces)

🔇 Additional comments (2)
.github/workflows/ci.yml (2)

38-42: Excellent security practice using pinned action version.

Using a specific commit hash for ruby/setup-ruby action is a security best practice as it prevents supply chain attacks.


44-47: Verify Jekyll configuration and dependencies.

Let's ensure all necessary Jekyll configuration files are present and properly set up.

✅ Verification successful

Jekyll configuration is properly set up, but Gemfile.lock is missing

The verification shows that:

  • _config.yml exists with proper configuration (url, title, description)
  • Gemfile exists with Jekyll dependency
  • Only Gemfile.lock is missing, which is expected to be generated after running bundle install

The missing Gemfile.lock won't affect the build since GitHub Actions will generate it during the workflow execution.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify Jekyll configuration and dependencies

# Check for required Jekyll files
echo "Checking Jekyll configuration files..."
files_to_check=("_config.yml" "Gemfile" "Gemfile.lock")
missing_files=0

for file in "${files_to_check[@]}"; do
  if [ ! -f "$file" ]; then
    echo "Missing required file: $file"
    missing_files=1
  fi
done

# Check Jekyll configuration
if [ -f "_config.yml" ]; then
  echo "Validating _config.yml content..."
  rg -A 5 "^(url|baseurl|title|description):" "_config.yml" || echo "Basic Jekyll configuration might be incomplete"
fi

# Check Gemfile for Jekyll dependency
if [ -f "Gemfile" ]; then
  echo "Checking Jekyll dependency in Gemfile..."
  rg "^gem ['\"]jekyll['\"]" "Gemfile" || echo "Jekyll gem might be missing in Gemfile"
fi

Length of output: 1932

.github/workflows/ci.yml Outdated Show resolved Hide resolved
.github/workflows/ci.yml Show resolved Hide resolved
maehr and others added 2 commits October 30, 2024 19:56
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@maehr maehr requested a review from mtwente November 1, 2024 08:26
Copy link

@koilebeit koilebeit left a comment

Choose a reason for hiding this comment

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

I can't test it locally:
[Continuous Integration/prettier] ❗ ::error::Input required and not supplied: token

@maehr
Copy link
Member Author

maehr commented Nov 1, 2024

I can't test it locally: [Continuous Integration/prettier] ❗ ::error::Input required and not supplied: token

Which token?

@maehr maehr mentioned this pull request Nov 1, 2024
7 tasks
@koilebeit
Copy link

I can't test it locally: [Continuous Integration/prettier] ❗ ::error::Input required and not supplied: token

Which token?

I have no idea. I have adapted the omeka tokens locally - they work

@maehr
Copy link
Member Author

maehr commented Nov 1, 2024

@koilebeit better?

@maehr maehr merged commit 802aaa7 into Stadt-Geschichte-Basel:main Nov 2, 2024
3 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Nov 10, 2024
7 tasks
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