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

Remove mike versioning #34

Merged
merged 1 commit into from
Jul 21, 2024
Merged

Remove mike versioning #34

merged 1 commit into from
Jul 21, 2024

Conversation

klaasnicolaas
Copy link
Member

@klaasnicolaas klaasnicolaas commented Jul 21, 2024

Remove the versioning via Mike, because this still works with a separate branch and unfortunately I can't get that to work.

Summary by CodeRabbit

  • New Features

    • Introduced a new documentation build process using MkDocs, enhancing the project's documentation capabilities.
  • Bug Fixes

    • Removed outdated deployment steps, streamlining the workflow and eliminating potential deployment issues.
  • Chores

    • Removed the dependency on the mike package to simplify documentation management.

@klaasnicolaas klaasnicolaas added the cleanup Cleanup of code. label Jul 21, 2024
Copy link
Contributor

coderabbitai bot commented Jul 21, 2024

Walkthrough

Walkthrough

The changes reflect a transition from deploying application versions to building project documentation. The GitHub Actions workflow now focuses on using MkDocs instead of Mike for documentation management. This includes the removal of versioning configurations and dependencies related to Mike, simplifying the documentation setup and possibly indicating a new strategy for managing documentation without versioned releases.

Changes

Files Change Summary
.github/workflows/deploy.yaml Replaced deployment step using Mike with a documentation build step using MkDocs.
mkdocs.yml Removed version section from extra configuration, simplifying documentation versioning management.
pyproject.toml Removed dependency on the Mike package, indicating a shift in documentation management strategy.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub Actions
    participant MkDocs

    User->>GitHub Actions: Trigger Documentation Build
    GitHub Actions->>MkDocs: Build Documentation
    MkDocs-->>GitHub Actions: Return Built Documentation
    GitHub Actions-->>User: Documentation Build Complete
Loading

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 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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 98996e4 and 53070e4.

Files ignored due to path filters (1)
  • poetry.lock is excluded by !**/*.lock
Files selected for processing (3)
  • .github/workflows/deploy.yaml (1 hunks)
  • mkdocs.yml (1 hunks)
  • pyproject.toml (1 hunks)
Files skipped from review due to trivial changes (2)
  • mkdocs.yml
  • pyproject.toml
Additional comments not posted (2)
.github/workflows/deploy.yaml (2)

40-41: LGTM! MkDocs setup for building documentation is correctly added.

The step to build documentation using MkDocs is correctly implemented.


42-44: LGTM! Artifact upload setup is correctly added.

The step to upload the built documentation as artifacts is correctly implemented.

@klaasnicolaas klaasnicolaas merged commit 372b1a3 into main Jul 21, 2024
1 check passed
@klaasnicolaas klaasnicolaas deleted the klaas-2024-024 branch August 23, 2024 15:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup Cleanup of code.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant