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.

Sign up for GitHub

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

Jump to bottom

ci(workflow): add generate-doc-bundles workflow #355

Merged
merged 1 commit into from
Nov 28, 2023
Merged

ci(workflow): add generate-doc-bundles workflow #355

merged 1 commit into from
Nov 28, 2023

Conversation

ccamel
Copy link
Member

@ccamel ccamel commented Nov 28, 2023 •
edited
Loading

Context

As part of the training process for OKP4 GPT, there is a requirement to assemble comprehensive markdown files that consolidate various segments of our documentation. These segments include:

  1. A bundle comprising:

    • The Whitepaper
    • Technical Documentation
    • FAQs

  2. Another bundle containing:

    • Tutorials
    • Validators Documentation

PR scope

This PR introduces a new github workflow, manually triggerable, which aims to generate these specified bundles, making them available as downloadable artifacts. These artifacts will serve as primary (and canonical) inputs for the training phase of OKP4 GPT.

Usage

The workflow is manualy triggerable:

image

Once run, it will produce 2 downloadable artefacts:

image

Summary by CodeRabbit

  • Documentation
    • Implemented a new GitHub Actions workflow to automatically generate and upload documentation bundles for different sections of the project.

@ccamel ccamel self-assigned this Nov 28, 2023
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 28, 2023 •
edited
Loading

Note

Reviews Paused

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Walkthrough

The change involves the introduction of a GitHub Actions workflow designed to automate the generation of documentation bundles. Triggered by workflow calls, it employs a matrix strategy to handle multiple documentation sets, sets up Python, installs dependencies, merges Markdown files into bundles, and uploads these as artifacts, all while managing concurrency to ensure smooth operation across multiple runs.

Changes

File Path Change Summary
.github/workflows/generate-doc-bundles.yml Introduced a GitHub Actions workflow for generating documentation bundles with a matrix strategy, Python setup, dependencies installation, Markdown merging, and artifact uploading.

🐇✨
In the realm of code, where actions flow,
A rabbit crafted docs, with a seamless glow.
Bundles of knowledge, now swiftly compile,
In GitHub's embrace, they rest for a while. 📚💫

Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

@ccamel ccamel marked this pull request as ready for review November 28, 2023 14:06
coderabbitai[bot]
coderabbitai bot reviewed Nov 28, 2023
View reviewed changes
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.

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 54d7bdc and c8fffab.
Files selected for processing (1)
  • .github/workflows/generate-doc-bundles.yml (1 hunks)

.github/workflows/generate-doc-bundles.yml Outdated Show resolved Hide resolved
.github/workflows/generate-doc-bundles.yml Outdated Show resolved Hide resolved
bot-anik
bot-anik reviewed Nov 28, 2023
View reviewed changes
Copy link
Member

@bot-anik bot-anik left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Device URL
desktop http://localhost:3000/

Device URL
mobile http://localhost:3000/

Not what you expected? Are your scores flaky? GitHub runners could be the cause.
Try running on Foo instead

@ccamel ccamel force-pushed the ci/documentation-bundles branch from c8fffab to fd546f6 Compare November 28, 2023 14:13
coderabbitai[bot]
coderabbitai bot reviewed Nov 28, 2023
View reviewed changes
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.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 54d7bdc and fd546f6.
Files selected for processing (1)
  • .github/workflows/generate-doc-bundles.yml (1 hunks)
Additional comments: 1
.github/workflows/generate-doc-bundles.yml (1)
  • 6-8: Verify that the concurrency group name is sufficiently unique to prevent unintended cancellations across different branches or tags.

.github/workflows/generate-doc-bundles.yml Outdated Show resolved Hide resolved
@ccamel ccamel marked this pull request as draft November 28, 2023 14:22
@ccamel ccamel force-pushed the ci/documentation-bundles branch 2 times, most recently from 2d055ba to e2d3a2c Compare November 28, 2023 14:29
@ccamel ccamel force-pushed the ci/documentation-bundles branch from e2d3a2c to f6b3933 Compare November 28, 2023 14:39
@ccamel
Copy link
Member Author

ccamel commented Nov 28, 2023

@coderabbitai pause

@ccamel ccamel marked this pull request as ready for review November 28, 2023 14:42
@ccamel ccamel requested review from amimart and MdechampG November 28, 2023 14:42
amimart
amimart approved these changes Nov 28, 2023
View reviewed changes
Copy link
Member

@amimart amimart left a comment

Choose a reason for hiding this comment

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

LGTM!

@ccamel ccamel merged commit fd2ceb1 into main Nov 28, 2023
12 checks passed
@ccamel ccamel deleted the ci/documentation-bundles branch November 28, 2023 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@bot-anik bot-anik bot-anik left review comments

@amimart amimart amimart approved these changes

@MdechampG MdechampG Awaiting requested review from MdechampG

Assignees

@ccamel ccamel

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ccamel @amimart @bot-anik