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

docs(chore): Uncomment 'released' tags for functions in v4.0.0 #2125

Merged
merged 1 commit into from
Jun 22, 2024

Conversation

hairyhenderson
Copy link
Owner

@hairyhenderson hairyhenderson commented Jun 22, 2024

Forgot to do this before the v4 release 🤦‍♂️ - this removes the unreleased text from the rendered docs.

Summary by CodeRabbit

  • Documentation
    • Updated release information for the following functions, indicating their availability in version 4.0.0:
      • aws.KMSEncrypt
      • coll.GoSlice
      • coll.Index
      • coll.JQ
      • coll.Set
      • coll.Unset
      • crypto.Ed25519GenerateKey
      • crypto.Ed25519GenerateKeyFromSeed
      • crypto.Ed25519DerivePublicKey
      • net.ParseAddr
      • net.ParsePrefix
      • net.ParseRange
      • strings.SkipLines

@hairyhenderson hairyhenderson self-assigned this Jun 22, 2024
Copy link

coderabbitai bot commented Jun 22, 2024

Warning

Review failed

The pull request is closed.

Walkthrough

The series of changes primarily involve updating the metadata of several function declarations across multiple YAML documents and their corresponding markdown documentation. This encompasses shifting various functions like aws.KMSEncrypt, coll.GoSlice, crypto.Ed25519GenerateKey, and others to state their release in v4.0.0. These updates imply that these functions are now officially released and are included in gomplate v4.0.0.

Changes

Files Change Summaries
docs-src/content/functions/aws.yml Updated aws.KMSEncrypt to show released: v4.0.0
docs-src/content/functions/coll.yml Updated functions (coll.GoSlice, coll.Index, coll.JQ, coll.Set, coll.Unset) to v4.0.0
docs-src/content/functions/crypto.yml Updated functions (crypto.Ed25519GenerateKey, crypto.Ed25519GenerateKeyFromSeed, crypto.Ed25519DerivePublicKey) to v4.0.0
docs-src/content/functions/net.yml Updated functions (net.ParseAddr, net.ParsePrefix, net.ParseRange) to v4.0.0
docs-src/content/functions/strings.yml Updated strings.SkipLines function to v4.0.0
docs/content/functions/aws.md Removed "Unreleased" status, added _Added in gomplate v4.0.0_ for aws.KMSEncrypt
docs/content/functions/coll.md Removed "Unreleased" status, added _Added in gomplate v4.0.0_ for various functions in coll
docs/content/functions/crypto.md Removed "Unreleased" status, added _Added in gomplate v4.0.0_ for various functions in crypto
docs/content/functions/net.md Introduced net.ParseAddr, net.ParsePrefix, and net.ParseRange for gomplate v4.0.0
docs/content/functions/strings.md Added strings.SkipLines function

Poem

In the code’s new dawn, a change took flight, ✨
Functions once hidden, now in clear sight. 📜
Version four lifts, as lines transform, 🌐
Changes ripple, like a springtime storm. 🌸
So here’s to progress, a rabbit’s delight,
Each update a hop, to endless new heights! 🐇🚀


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@hairyhenderson hairyhenderson merged commit e3b86e8 into main Jun 22, 2024
15 checks passed
@hairyhenderson hairyhenderson deleted the docs-mark-4.0-released branch June 22, 2024 14:54
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