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

Fix BASEHREF handling in Docker Compose #248

Closed
wants to merge 2 commits into from
Closed

Conversation

FelixFrizzy
Copy link
Collaborator

@FelixFrizzy FelixFrizzy commented Jan 10, 2025

  • envsubst approach unsuitable because of overwriting the config files on startup
  • solved using bash script

Summary by CodeRabbit

Release Notes

  • Configuration Changes

    • Updated Docker Compose configuration for Skosmos development and live environments
    • Introduced a new helper script for managing base URL configuration
    • Modified configuration files to use hardcoded base URLs for both dev and live instances
  • Deployment Updates

    • Refined environment variable handling in Docker services
    • Added script-based configuration file processing
    • Simplified base URL management for Skosmos applications

- envsubst would overwrite existing skosmos config on every startup
- basehref now written to config.ttl with bash script
Copy link

coderabbitai bot commented Jan 10, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces a new approach to handling base URL configuration for Skosmos development and live environments. The changes involve creating a custom Bash script replace-basehref.sh to replace base href values in configuration files, modifying the docker-compose.yml to use this new script, and updating the configuration files for both Skosmos instances. The modifications replace environment variable substitution with a more explicit scripted method of configuration file manipulation.

Changes

File Change Summary
docker-compose.yml - Removed quotes from BASEHREFDEV and BASEHREFLIVE environment variables
- Added volume mapping for replace-basehref.sh in both skosmos-dev and skosmos-live services
- Updated command to use new script instead of envsubst
helperscripts/replace-basehref.sh - New Bash script added for replacing base href values
- Implements file backup and safe replacement mechanism
skosmos-dev/config.ttl - Removed dc: and void: prefixes
- Hardcoded skosmos:baseHref to "http://localhost:9000/skosmos-dev/"
skosmos-live/config.ttl - Removed dc: and void: prefixes
- Hardcoded skosmos:baseHref to "http://localhost:9000/skosmos-live/"
Deleted Files - skosmos-dev/config-template.ttl
- skosmos-live/config-template.ttl

Sequence Diagram

sequenceDiagram
    participant DC as Docker Compose
    participant Script as replace-basehref.sh
    participant ConfigFile as Config File
    
    DC->>Script: Execute with config file and base href
    Script->>ConfigFile: Read original configuration
    Script->>ConfigFile: Create backup
    Script->>ConfigFile: Replace baseHref value
    Script->>ConfigFile: Validate and save changes
Loading

Possibly Related PRs

Poem

🐰 A Rabbit's Configuration Tale 🐰

With scripts and configs, we dance and twirl,
Replacing base hrefs in a magical swirl
No more envsubst, we've found a new way
To configure Skosmos and brighten our day!

Hop, hop, configuration magic unfurled! 🌈


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9d5490d and 3d175cd.

📒 Files selected for processing (6)
  • docker-compose.yml (4 hunks)
  • helperscripts/replace-basehref.sh (1 hunks)
  • skosmos-dev/config-template.ttl (0 hunks)
  • skosmos-dev/config.ttl (1 hunks)
  • skosmos-live/config-template.ttl (0 hunks)
  • skosmos-live/config.ttl (1 hunks)

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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

codecov bot commented Jan 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.85%. Comparing base (bb9c84f) to head (3d175cd).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #248   +/-   ##
=======================================
  Coverage   93.85%   93.85%           
=======================================
  Files          49       49           
  Lines        1774     1774           
=======================================
  Hits         1665     1665           
  Misses        109      109           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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.

1 participant