Skip to content

Conversation

@cabberley
Copy link
Contributor

@cabberley cabberley commented Jun 6, 2025

Update README.md
Updated and fixed some pathing issues for config.json in the Docker sections

  • the current version stores config.json in '/share' not the older /app path. the readme had inconsistencies.
  • you can't map the volume as '/share/config.json' on a clean Docker Deploy as it will fail to start if config.json does not exit. So have sugegsted to mount the folder which will enable Docker to start and EMHASS to either read or create config.json appropriately.
  1. Changed documentation to describe mapping config.json by doing map '/emass/share:/share'
  2. Updated the docker run cmdlines to reflect the more robust mapping to the 'share' dir for config.json file storage on host.

Summary by Sourcery

Improve Docker section in README to standardize config.json storage and volume mount instructions

Documentation:

  • Clarify that EMHASS stores config.json in the container’s /share directory and recommend mounting the entire host folder (e.g. /emhass/share) instead of the file directly
  • Update all example docker run commands to use folder-based -v /emhass/share:/share mounts and adjust associated paths for robust config.json handling

cabberley added 2 commits June 7, 2025 09:19
Updated and fixed some pathing issues for config.json in the "Docker, things to note section"
- the current version stores config.json in '/share' now
- you can't map the volume as '/share/config.json' on a clean Docker Deploy as it will fail to start if ocnfig.json does not exit.

1. Changed documentation to describe mapping config.json by doing map '~/emass/share:/share'
2. Updated the docker run cmdlines to reflect the more robust mapping to the 'share' dir for config.json file storage on host.
@sourcery-ai
Copy link

sourcery-ai bot commented Jun 6, 2025

Reviewer's Guide

Updated README.md to fix path inconsistencies and improve robustness of Docker volume mounts by switching from single-file mappings to directory-level mappings for the EMHASS "share" folder.

File-Level Changes

Change Details Files
Standardize Docker volume mounting of config.json via directory-level mapping
  • Clarify that the "share" folder holds config.json and guide mounting it as a directory
  • Replace all "-v ./config.json:/share/config.json" with "-v /emhass/share:/share" in run commands
  • Adjust secrets_emhass.yaml volume flags to match new host directories
  • Ensure consistency across pull commands for both remote and locally built images
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sonarqubecloud
Copy link

sonarqubecloud bot commented Jun 6, 2025

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @cabberley - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@davidusb-geek davidusb-geek merged commit aad1c7b into davidusb-geek:master Aug 2, 2025
1 check passed
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