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

feat: royalty free images #40

Merged
merged 8 commits into from
Nov 19, 2024
Merged

feat: royalty free images #40

merged 8 commits into from
Nov 19, 2024

Conversation

mikejgray
Copy link
Collaborator

@mikejgray mikejgray commented Nov 17, 2024

chore: sync skill.json to locale folder

Closes #16

Summary by CodeRabbit

  • New Features

    • Introduced a new job in the workflow to automate synchronization of the skill.json file.
    • Updated the README.md with new image references and added a "License" section.
    • Enhanced skill.json with updated image paths and new credits for AI-generated images.
  • Bug Fixes

    • Corrected image paths in skill.json and README.md to ensure proper display.

chore: sync skill.json to locale folder
Copy link
Contributor

coderabbitai bot commented Nov 17, 2024

Walkthrough

The pull request introduces modifications across three files: a GitHub Actions workflow, a README file, and a JSON configuration file. A new job named sync has been added to the workflow to automate the synchronization of the skill.json file to a specified locale directory. The README file has updated image references and added new image credits along with a license section. The skill.json file has updated image paths and added credits related to the skill's theme.

Changes

File Path Change Summary
.github/workflows/update_skill_json.yml Added a new job sync with steps for checkout, syncing skill.json, and pushing changes.
README.md Updated image reference, added new image credits, and included a new section for the license.
skill.json Updated image paths in summary and short_description, and added new entries to credits.

Assessment against linked issues

Objective Addressed Explanation
Replace images (Issue #16)

Possibly related PRs

  • chore: release automations #33: Modifications to a GitHub Actions workflow for synchronizing the skill.json file, related to release automation processes.

Suggested reviewers

  • JarbasAl

Poem

In the realm of code, a change takes flight,
A sync job added, oh what a sight!
Images refreshed, credits anew,
With every update, our skills just grew.
Hopping through files, we dance and play,
Celebrating changes in a joyful way! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 429809f and 7c67d42.

📒 Files selected for processing (1)
  • .github/workflows/update_skill_json.yml (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/update_skill_json.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.

@github-actions github-actions bot added feature and removed feature labels Nov 17, 2024
@mikejgray mikejgray requested review from JarbasAl and a team November 17, 2024 22:06
@github-actions github-actions bot added feature and removed feature labels Nov 17, 2024
Copy link
Contributor

@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: 4

🧹 Outside diff range and nitpick comments (2)
.github/workflows/update_skill_json.yml (1)

19-20: Add validation before copying skill.json

The current implementation blindly copies the file without validating its existence or content.

Apply this diff to add basic validation:

      - name: Sync skill.json
        run: |
+         if [ ! -f "skill.json" ]; then
+           echo "Error: skill.json does not exist"
+           exit 1
+         fi
+         mkdir -p locale
          cp skill.json locale/skill.json
locale/skill.json (1)

4-5: Avoid duplicate content in summary and short_description fields.

The summary and short_description fields are identical. Consider making the short_description more concise and focused on the core functionality.

-    "short_description": "![Python](https://img.shields.io/badge/python-3.8-blue.svg) ![Python](https://img.shields.io/badge/python-3.9-blue.svg) ![Python](https://img.shields.io/badge/python-3.10-blue.svg) ![Python](https://img.shields.io/badge/python-3.11-blue.svg) Makes your voice assistant laugh like a maniac ![A ghostly face, laughing evilly.](./ui/images/2.jpg)",
+    "short_description": "Makes your voice assistant laugh like a maniac",
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 0eee088 and 58702f3.

⛔ Files ignored due to path filters (5)
  • sshot.png is excluded by !**/*.png
  • ui/images/0.jpg is excluded by !**/*.jpg
  • ui/images/1.jpg is excluded by !**/*.jpg
  • ui/images/2.jpg is excluded by !**/*.jpg
  • ui/images/3.jpg is excluded by !**/*.jpg
📒 Files selected for processing (4)
  • .github/workflows/update_skill_json.yml (1 hunks)
  • README.md (2 hunks)
  • locale/skill.json (1 hunks)
  • skill.json (2 hunks)
✅ Files skipped from review due to trivial changes (2)
  • README.md
  • skill.json
🔇 Additional comments (1)
locale/skill.json (1)

50-53: Verify presence and licensing of referenced images.

The credits section lists Pixabay images, which aligns with the PR objective of using properly licensed images. Let's verify their presence and licensing.

✅ Verification successful

All referenced images are present in the repository

The verification confirms that:

  • All four images (0.jpg through 3.jpg) exist in the ui/images/ directory
  • The only other image file is res/icon/laugh_icon.png, which is unrelated to this change
  • The image credits in locale/skill.json correctly document the Pixabay sources
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence and location of referenced images

# Check if the images exist in the ui/images directory
echo "Checking for referenced images..."
for i in {0..3}; do
  if [ -f "ui/images/${i}.jpg" ]; then
    echo "Found: ui/images/${i}.jpg"
  else
    echo "Missing: ui/images/${i}.jpg"
  fi
done

# Look for any other image files that might need licensing review
echo -e "\nChecking for other image files..."
fd -e jpg -e png -e gif -e jpeg

Length of output: 689

.github/workflows/update_skill_json.yml Outdated Show resolved Hide resolved
.github/workflows/update_skill_json.yml Show resolved Hide resolved
locale/skill.json Outdated Show resolved Hide resolved
locale/skill.json Outdated Show resolved Hide resolved
mikejgray and others added 3 commits November 17, 2024 16:21
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@github-actions github-actions bot added feature and removed feature labels Nov 17, 2024
@@ -7,7 +7,7 @@

Makes your voice assistant laugh like a maniac

![A ghostly face, laughing evilly.](./sshot.png)
![A ghostly face, laughing evilly.](./ui/images/2.jpg)
Copy link
Member

@JarbasAl JarbasAl Nov 18, 2024

Choose a reason for hiding this comment

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

images should be moved to "gui/all", this ensures in docker setups they are available across containers as the "gui" folder gets copied to a shared volume

should also pin ovos-bus-client>1.0.0 for this caching functionality

Copy link
Member

Choose a reason for hiding this comment

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

similarly, in the code we should no longer pass absolute paths to allow the cached path to resolve instead

self.gui.show_image(join(dirname(__file__), "ui", "images", str(pic) + ".jpg")) -> self.gui.show_image(str(pic) + ".jpg"))

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Do we have this documented somewhere? Wasn't aware this was an option

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Looks like this is in #38

@mikejgray mikejgray requested a review from JarbasAl November 19, 2024 00:19
Copy link
Member

@JarbasAl JarbasAl left a comment

Choose a reason for hiding this comment

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

wrong path for skill.json , should go into en-us subfolder

@mikejgray mikejgray requested a review from JarbasAl November 19, 2024 14:01
@github-actions github-actions bot added feature and removed feature labels Nov 19, 2024
@JarbasAl JarbasAl merged commit ad68596 into dev Nov 19, 2024
13 checks passed
mikejgray added a commit that referenced this pull request Nov 19, 2024
* feat: royalty free images
chore: sync skill.json to locale folder

* Update skill.json

* adjust action

* Sync skill.json

* add dependency to avoid race condition

* explicit license

* Update .github/workflows/update_skill_json.yml

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* move skill.json

---------

Co-authored-by: mikejgray <[email protected]>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@JarbasAl JarbasAl deleted the FEAT_RoyaltyFreeImages branch November 20, 2024 13:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

replace images
2 participants