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: gen next #7231

Merged
merged 1 commit into from Apr 25, 2024
Merged

docs: gen next #7231

merged 1 commit into from Apr 25, 2024

Conversation

james-d-elliott
Copy link
Member

@james-d-elliott james-d-elliott commented Apr 25, 2024

Summary by CodeRabbit

  • Chores
    • Updated Swagger UI to version 5.17.1 for improved stability and performance.
  • Documentation
    • Updated timestamp in the OpenID Connect integration documentation for accuracy.

Signed-off-by: James Elliott <james-d-elliott@users.noreply.github.com>
@authelia
Copy link

authelia bot commented Apr 25, 2024

Artifacts

These changes are published for testing on Buildkite, DockerHub and GitHub Container Registry.

Docker Container

  • docker pull authelia/authelia:docs-gen-next
  • docker pull ghcr.io/authelia/authelia:docs-gen-next

@james-d-elliott james-d-elliott marked this pull request as ready for review April 25, 2024 08:18
Copy link
Contributor

coderabbitai bot commented Apr 25, 2024

Important

Auto Review Skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent updates include an upgrade of the Swagger UI version from 5.15.2 to 5.17.1 to enhance API documentation capabilities. Additionally, the modification timestamp in the documentation for integrating OpenID Connect with Wiki.js has been adjusted to reflect more recent changes.

Changes

Files Change Summary
cmd/authelia-scripts/cmd/gen.go Updated Swagger UI version to "5.17.1".
docs/.../openid-connect/wikijs/index.md Updated date field to "2024-04-18T15:25:09+10:00".

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

@james-d-elliott james-d-elliott enabled auto-merge (squash) April 25, 2024 08:19
Copy link

netlify bot commented Apr 25, 2024

Deploy Preview for authelia-staging ready!

Name Link
🔨 Latest commit 230af13
🔍 Latest deploy log https://app.netlify.com/sites/authelia-staging/deploys/662a11de6035470008a05f68
😎 Deploy Preview https://deploy-preview-7231--authelia-staging.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.

@james-d-elliott james-d-elliott merged commit d0cf1c1 into master Apr 25, 2024
45 checks passed
@james-d-elliott james-d-elliott deleted the docs-gen-next branch April 25, 2024 09:36
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.

None yet

1 participant