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

Add create_daily action to Habitica #37998

Merged
merged 1 commit into from
Mar 25, 2025

Conversation

tr4nt0r
Copy link
Contributor

@tr4nt0r tr4nt0r commented Mar 15, 2025

Proposed change

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • New Features
    • Introduced a Habitica daily task creation feature that allows users to directly add new daily tasks to their Habitica characters.
    • Enhanced task customization with detailed configuration options, including task name, notes, priority, frequency, start date, recurring options, and more.
    • This update provides a more flexible and streamlined experience when managing daily tasks in Habitica.

@home-assistant
Copy link

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

@home-assistant home-assistant bot added in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch next This PR goes into the next branch labels Mar 15, 2025
Copy link

netlify bot commented Mar 15, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 5d72a77
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67d5df9034deea00086a369f
😎 Deploy Preview https://deploy-preview-37998--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@tr4nt0r tr4nt0r marked this pull request as ready for review March 15, 2025 20:10
Copy link
Contributor

coderabbitai bot commented Mar 15, 2025

📝 Walkthrough

Walkthrough

The pull request extends the Habitica integration by introducing a new action, habitica.create_daily. This action enables the creation of daily tasks for Habitica characters. The changes include a detailed table describing the attributes required to use the action, which distinguishes between mandatory and optional parameters such as config_entry, name, notes, priority, frequency, and others. The new action is added in the integration documentation file, positioned after the existing action for updating dailies.

Changes

File Path Change Summary
source/_integrations/habitica.markdown Added new action habitica.create_daily for creating daily tasks. Introduced a detailed table outlining attributes (e.g., config_entry, name, notes, add_checklist_item, priority, start_date, frequency, every_x, repeat, repeat_monthly, reminder, tag, and alias) with their descriptions and constraints.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant HI as Habitica Integration
    participant HA as Habitica API

    U->>HI: Request to create a new daily task
    HI->>HA: Send daily task details (config, name, notes, etc.)
    HA-->>HI: Return confirmation response
    HI-->>U: Deliver success status
Loading

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

🪧 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.
  • @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 or @coderabbitai title 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
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: 0

🧹 Nitpick comments (1)
source/_integrations/habitica.markdown (1)

422-424: Fix Typographical Mistake in the Priority Description

There is a duplicated word in the description of the priority parameter ("The the difficulty"). Correcting this typo will improve clarity and professionalism.

-| `priority`     | yes      | The the difficulty of a daily. Valid values: `trivial`, `easy`, `medium`, `hard`
+| `priority`     | yes      | The difficulty of a daily. Valid values: `trivial`, `easy`, `medium`, `hard`
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 14a797f and 8e4edf6.

📒 Files selected for processing (1)
  • source/_integrations/habitica.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/habitica.markdown

[duplication] ~425-~425: Possible typo: you repeated a word.
Context: ... | | priority | yes | The the difficulty of a daily. Valid values: `t...

(ENGLISH_WORD_REPEAT_RULE)

🔇 Additional comments (1)
source/_integrations/habitica.markdown (1)

415-424: New Action Documentation Added for habitica.create_daily

The new section for the habitica.create_daily action is well integrated into the existing documentation. The table clearly distinguishes between mandatory and optional parameters, ensuring consistency with similar actions. Overall, the documentation is comprehensive and follows the established structure.

@tr4nt0r tr4nt0r force-pushed the habitica_create_daily branch from 8e4edf6 to 5d72a77 Compare March 15, 2025 20:14
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: 0

🧹 Nitpick comments (1)
source/_integrations/habitica.markdown (1)

415-434: New Action Documentation for habitica.create_daily

The new documentation block is clear and consistent with existing Habitica action entries. The table effectively delineates which attributes are mandatory versus optional, and the descriptions align well with similar actions (e.g., create_reward and create_todo).

A couple of minor refinements to consider:

  • Consistency: In the notes row, consider removing the word "new" so that it reads “The notes for the Habitica daily” for consistency with similar sections.
  • Clarity: Optionally, you might add a brief note or example indicating the expected format for the start_date field, which could help users understand its expected value.
-| `notes`        | yes      | The new notes for the Habitica daily.                                                        |
+| `notes`        | yes      | The notes for the Habitica daily.                                                              |
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8e4edf6 and 5d72a77.

📒 Files selected for processing (1)
  • source/_integrations/habitica.markdown (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo and removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Mar 16, 2025
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

Thank you, @tr4nt0r 👍

@c0ffeeca7 c0ffeeca7 added the awaits-parent Awaits the merge of an parent PR label Mar 18, 2025
@home-assistant home-assistant bot added the parent-merged The parent PR has been merged already label Mar 25, 2025
@frenck frenck merged commit ee018fe into home-assistant:next Mar 25, 2025
7 checks passed
@home-assistant home-assistant bot removed in-progress This PR/Issue is currently being worked on parent-merged The parent PR has been merged already awaits-parent Awaits the merge of an parent PR labels Mar 25, 2025
@tr4nt0r tr4nt0r deleted the habitica_create_daily branch March 25, 2025 09:33
@github-actions github-actions bot locked and limited conversation to collaborators Mar 26, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants