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: allow Tax Free Assets to be a draft before publishing #50

Closed
wants to merge 1 commit into from

Conversation

alfetopito
Copy link
Contributor

@alfetopito alfetopito commented Feb 7, 2025

Summary

Using the built-in draft state for Tax Free Assets model.

This way a manual inspection is required before enabling any entry.

Summary by CodeRabbit

  • New Features
    • Enabled a draft & publish workflow for tax-free asset content, allowing users to save content as drafts before final publishing.
    • Introduced a publication timestamp to help track when documents are published.

@alfetopito alfetopito self-assigned this Feb 7, 2025
Copy link

coderabbitai bot commented Feb 7, 2025

Walkthrough

The changes update two JSON schema files. In the tax-free-asset schema, the "draftAndPublish" option is enabled by switching its value from false to true. In the documentation schema, the generation date has been refreshed with a new timestamp and a new "publishedAt" property (a string in date-time format) has been added. These updates adjust the configuration for draft publishing and improve documentation metadata.

Changes

File Change Summary
src/api/.../tax-free-asset/schema.json Changed "draftAndPublish" from false to true to enable draft and publish functionality.
src/extensions/.../full_documentation.json Updated "x-generation-date" with a new timestamp; added new property "publishedAt" (string, date-time).

Sequence Diagram(s)

sequenceDiagram
  participant User
  participant API
  participant DB

  User->>API: Create tax-free-asset (draft)
  API->>DB: Save content as draft
  DB-->>API: Confirm draft saved
  API-->>User: Return draft content

  User->>API: Request publish of content
  API->>DB: Update content status to published
  DB-->>API: Confirm content published
  API-->>User: Return published content
Loading

Poem

I'm a coding rabbit with a joyful leap,
Drafts now dance before they take a final peep.
New timestamps mark a fresh, brave start,
And published dates add rhythm to our art.
Hopping through code, with a beat in my heart!


🪧 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

@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)
src/extensions/documentation/documentation/1.0.0/full_documentation.json (1)

27911-27914: Addition of publishedAt Property

The new "publishedAt" property has been correctly added with the expected "string" type and "date-time" format, aligning with the intent to track publication dates and enable draft functionality. To improve clarity and maintainability, consider adding a brief description for this field in the schema.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4bc424e and df4ea3c.

📒 Files selected for processing (2)
  • src/api/tax-free-asset/content-types/tax-free-asset/schema.json (1 hunks)
  • src/extensions/documentation/documentation/1.0.0/full_documentation.json (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: docker
🔇 Additional comments (2)
src/extensions/documentation/documentation/1.0.0/full_documentation.json (1)

14-18: Update to Generation Date

The updated "x-generation-date" field now reflects the new timestamp "2025-02-07T14:35:19.279Z", which is in line with the requirement for refreshing the documentation generation date. The ISO 8601 format appears correct and consistent.

src/api/tax-free-asset/content-types/tax-free-asset/schema.json (1)

10-12: Enable Draft and Publish Option in Schema

The update at line 11 correctly changes the "draftAndPublish" option from false to true, aligning with the PR objective of requiring manual inspection before publication. Ensure that any parts of your workflow or admin UI that manage Tax Free Assets are updated to handle the draft state appropriately.

@alfetopito
Copy link
Contributor Author

Actually, let's do without draft

@alfetopito alfetopito closed this Feb 11, 2025
@alfetopito alfetopito deleted the feat/mark-tax-free-unpublished branch February 11, 2025 18:33
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