Skip to content

Add various GH actions and enable upload to new WEB server #666

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

Merged
merged 8 commits into from
Apr 9, 2025

Conversation

igorpecovnik
Copy link
Member

@igorpecovnik igorpecovnik commented Apr 9, 2025

Create offline documentation on PR
Documentation website preview will be available in few minutes:

 Open WWW preview 

Create docs preview on PR

Documentation website preview will be available in a few minutes:


 Open WWW preview 

Create docs preview on PR

Documentation website preview will be available shortly:


 Open WWW preview 

Copy link

coderabbitai bot commented Apr 9, 2025

Warning

Rate limit exceeded

@igorpecovnik has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 31 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 849d683 and 0649ca8.

📒 Files selected for processing (1)
  • .github/workflows/pdf-at-pr.yaml (1 hunks)

Walkthrough

The changes modify the continuous integration workflow by updating job names and functionality. The job previously named "Create offline documentation to release" has been renamed to "Update documentation website," and the "build" job is now called "build-docs." A new job named "Generate HTML" has been added, which is conditional on the repository owner being 'Armbian.' The job's strategy has been simplified by explicitly setting the Python version to 3.8, and the steps for installing dependencies have been consolidated into a single command. The previous step for running mkdocs build --clean has been replaced with a new step labeled "Build documentation." The step for uploading a PDF artifact has been removed, and new steps have been introduced for installing an SSH key and deploying files to a remote server using rsync, including SSH connection details and a timeout setting. No changes were made to the declarations of exported or public entities.


🪧 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f01f4dd and aa5fdf3.

📒 Files selected for processing (1)
  • .github/workflows/release.yaml (1 hunks)
🔇 Additional comments (1)
.github/workflows/release.yaml (1)

33-39: SSH Key Installation Step: Validate Secrets and Configuration

The newly added step installs the SSH key using shimataro/ssh-key-action@v2. Please ensure that the secrets (KEY_UPLOAD and KNOWN_HOSTS_ARMBIAN_UPLOAD) are correctly set in your repository settings and that the provided SSH key is authorized on the target server.

@igorpecovnik igorpecovnik force-pushed the uploaddocs branch 6 times, most recently from f492782 to 60435c9 Compare April 9, 2025 11:13
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: 1

🧹 Nitpick comments (1)
.github/workflows/release.yaml (1)

42-42: Ensure Proper File Termination.
YAMLlint has flagged that there is no newline character at the end of the file. Please add a newline at the end of the file to adhere to best practices and avoid potential YAML parsing issues.

-# File currently ends at the last character of line 42 without a newline
+ 
🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 42-42: no new line character at the end of file

(new-line-at-end-of-file)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 67bd59c and 60435c9.

📒 Files selected for processing (1)
  • .github/workflows/release.yaml (1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.35.1)
.github/workflows/release.yaml

[error] 42-42: no new line character at the end of file

(new-line-at-end-of-file)

🔇 Additional comments (6)
.github/workflows/release.yaml (6)

18-22: Python Setup is Configured Correctly.
The Python setup step (lines 18–22) is properly set up with Python version 3.8, meeting the workflow's requirements.


23-27: Dependency Installation Step Review.
The install dependencies step (lines 23–27) is streamlined by combining the upgrade of pip and the installation of required packages. Just ensure that all necessary packages for building the documentation (e.g., mkdocs) are part of your requirements.txt file.


28-29: Build Documentation Command Verification.
The "Build docs" step (lines 28–29) runs mkdocs build --clean, which is clear and straightforward. Please confirm that this command produces the expected output for further deployment.


31-36: SSH Key Installation Step Validity.
The SSH key installation step (lines 31–36) leverages shimataro/ssh-key-action@v2 correctly with the necessary inputs. This should properly configure SSH for subsequent deployment.


38-42: Deployment Step (Rsync) Review.
The deployment step (lines 38–42) uses rsync with SSH on port 2222 and appropriate options such as --progress and -a.

  • Verify that the remote server details ([email protected]:storage/docs.armbian.com) are correct and that the trailing slash in site/ meets your deployment needs (to sync directory contents rather than the directory itself).
    Overall, this step is appropriately configured for deploying to the new server.
🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 42-42: no new line character at the end of file

(new-line-at-end-of-file)


13-17:

❓ Verification inconclusive

Validate the Checkout Step Settings.
The checkout step correctly uses actions/checkout@v4 with fetch-depth: 1, which is efficient. However, given the branch discrepancy noted earlier, ensure that checking out ref: main aligns with the intended branch for deployments.


Confirm Deployment Branch Alignment
The checkout step in .github/workflows/release.yaml (lines 13–17) correctly uses actions/checkout@v4 with fetch-depth: 1 for efficiency. However, please verify that checking out ref: main is indeed intended for deployments. If your release process targets a different branch, kindly update the reference accordingly.

@igorpecovnik igorpecovnik force-pushed the uploaddocs branch 8 times, most recently from 85aa387 to cacc752 Compare April 9, 2025 11:41
@igorpecovnik igorpecovnik changed the base branch from master to main April 9, 2025 15:36
@igorpecovnik igorpecovnik changed the title Enable upload to new server Adjust build action and enable upload to new WEB server Apr 9, 2025
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 (22)
docs/User-Guide_Armbian-Config/Localisation.md (1)

7-10: [Nitpick] Image Section Link Target
The new image section for “Change Global timezone” clearly enhances the visual guidance. However, the image link target is set to “#”, which appears empty and may trigger markdownlint (MD042). Consider providing a valid URL or a more descriptive placeholder if the image isn’t meant to be clickable.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

9-9: No empty links
null

(MD042, no-empty-links)

docs/User-Guide_Armbian-Config/Network.md (6)

8-10: [Nitpick] Basic Network Setup Image Link
The added image for “Basic Network Setup” boosts clarity. Note that the image link uses “#” as its target, which is effectively empty and might be flagged by markdownlint (MD042). Please consider updating this to an actual URL or a more meaningful placeholder if intended for navigation.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

9-9: No empty links
null

(MD042, no-empty-links)


38-44: [Nitpick] Fenced Code Block Separation in Footer Section
The footer section (lines 38–44) provides clear, step-by-step instructions. However, ensure that the fenced code block (starting at line 40 with the “```bash” block) is surrounded by blank lines to comply with markdownlint MD031 guidelines.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

40-40: Fenced code blocks should be surrounded by blank lines
null

(MD031, blanks-around-fences)


42-42: Fenced code blocks should be surrounded by blank lines
null

(MD031, blanks-around-fences)


86-88: [Nitpick] View Network Settings Image Link
The “View Network Settings” section adds a helpful image, yet the link target remains “#”. To avoid markdownlint MD042 warnings and improve clarity, consider using a valid URL or a more descriptive placeholder.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

88-88: No empty links
null

(MD042, no-empty-links)


266-269: [Nitpick] WireGuard Remove Image Link
The image inserted for the “WireGuard remove” section uses an empty link target (“#”). If a clickable URL is expected, please update it accordingly; otherwise, you may consider adding a comment to clarify that it’s intentional.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

268-268: No empty links
null

(MD042, no-empty-links)


287-289: [Nitpick] WireGuard Clients QR Codes Image Link
Similar to previous image sections, the “WireGuard clients QR codes” image uses “#” as the link target. To prevent markdownlint flag (MD042) and improve user clarity, consider providing a valid target URL if available.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

289-289: No empty links
null

(MD042, no-empty-links)


306-309: [Nitpick] WireGuard Purge Image Link
The “WireGuard purge with data folder” section introduces an image with an empty link target. A valid URL or explanatory note can help avoid markdownlint MD042 issues and clarify intent.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

308-308: No empty links
null

(MD042, no-empty-links)

.github/workflows/release.yaml (2)

28-30: [Nitpick] Dependency Installation Details
Consolidating dependency installation into a single command block is an efficient change. Please verify that all required packages (for example, mkdocs) are included in the requirements file to avoid potential build issues.


41-47: [Optional Refactor] Deployment Timeout and Error Handling
The new deployment step using rsync with a 3‑minute timeout is a valuable improvement. However, please verify that this timeout is sufficient for transferring larger documentation builds. Additionally, consider enhancing error logging or handling (if not already covered) to catch potential rsync failures.

docs/User-Guide_Armbian-Config/System.md (13)

12-16: [Nitpick] Alternative Kernels Image Link
The image for “Install alternative kernels” adds useful visual context, but its link target is “#” which might trigger markdownlint MD042. Consider replacing it with a valid URL or a clear placeholder if a destination isn’t intended.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

14-14: No empty links
null

(MD042, no-empty-links)


18-41: [Nitpick] Kernel Switching Warning Header Block
The detailed “Kernel Switching Warning” section is very informative and adds much-needed context. To further improve readability and adhere to markdownlint guidelines, ensure that headings and list items are properly surrounded by blank lines (MD022/MD032). A quick review of spacing here would enhance consistency.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

23-23: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


23-23: Trailing punctuation in heading
Punctuation: '!'

(MD026, no-trailing-punctuation)


24-24: Lists should be surrounded by blank lines
null

(MD032, blanks-around-lists)


28-28: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


30-30: Lists should be surrounded by blank lines
null

(MD032, blanks-around-lists)


34-34: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


36-36: Lists should be surrounded by blank lines
null

(MD032, blanks-around-lists)


101-104: [Nitpick] Device Tree Overlays Image Link
The “Manage device tree overlays” section includes an image with an empty link target (“#”). Please consider updating this link to provide a valid target or more descriptive placeholder as needed.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

103-103: No empty links
null

(MD042, no-empty-links)


134-138: [Nitpick] Edit Boot Environment Image Link
The image in the “Edit the boot environment” section uses “#” as its link target. To avoid potential markdownlint (MD042) warnings and to improve clarity, please consider providing a valid URL or alternative text indicating its purpose.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

136-136: No empty links
null

(MD042, no-empty-links)


162-167: [Nitpick] Internal Storage Installation Image Link
For the “Install to internal storage” section, the image’s link target is set to “#”. A proper URL or clarifying note would help prevent markdownlint MD042 errors and improve user guidance.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

165-165: No empty links
null

(MD042, no-empty-links)


392-394: [Nitpick] Disable Root Login Image Link
The “Disable root login” section uses an image with an empty link target. Please update the link target to a valid URL or add a clarifying comment if this is intentional.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

394-394: No empty links
null

(MD042, no-empty-links)


566-568: [Nitpick] Sandboxed SSH Server Image Link
The image for “Sandboxed & containerised SSH server” is helpful, yet its link target is “#”. To mitigate markdownlint MD042 issues, please consider providing a meaningful link target or annotation.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

567-567: No empty links
null

(MD042, no-empty-links)


648-650: [Nitpick] Change Shell to BASH Image Link
The image associated with “Change shell system wide to BASH” currently uses an empty (“#”) link target. Updating this to a valid URL or descriptive placeholder would be advisable.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

650-650: No empty links
null

(MD042, no-empty-links)


669-680: [Nitpick] ZSH Header Section Formatting
The header block explaining the benefits and features of ZSH is well written and informative. Please double-check that the surrounding blank lines and spacing meet markdownlint standards (e.g., MD022/MD032) to ensure consistency throughout the document.


719-721: [Nitpick] Firmware Upgrades Image Link
The “Enable Armbian firmware upgrades” section adds a crucial visual aid, though the image link target remains “#”. Consider updating this to a proper URL or detailed placeholder as needed.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

721-721: No empty links
null

(MD042, no-empty-links)


788-790: [Nitpick] Docker Base Images Update Image Link
In the section “Enable automating Docker container base images updating”, the image is linked with “#”. A more descriptive or valid URL would be beneficial for consistency and to address markdownlint MD042.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

790-790: No empty links
null

(MD042, no-empty-links)


847-850: [Nitpick] Automatic Package Updates Image Link
The image in the “Configure automatic package updates” section also uses an empty link target (“#”). Updating this link to a valid URL or an appropriate placeholder is recommended to prevent markdownlint warnings.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

849-849: No empty links
null

(MD042, no-empty-links)


850-850: [General Note] Markdownlint Consistency
Overall, the extensive additions in this document significantly enhance the user guide. It would be beneficial to review and address recurring markdownlint warnings (such as empty links, multiple consecutive blank lines, and improper spacing around headings and code fences) to ensure a uniformly polished appearance.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 60435c9 and 3c3e2d6.

⛔ Files ignored due to path filters (15)
  • docs/images/BNS001.png is excluded by !**/*.png
  • docs/images/LO001.png is excluded by !**/*.png
  • docs/images/SY001.png is excluded by !**/*.png
  • docs/images/SY005.png is excluded by !**/*.png
  • docs/images/SY010.png is excluded by !**/*.png
  • docs/images/SY101.png is excluded by !**/*.png
  • docs/images/SY201.png is excluded by !**/*.png
  • docs/images/SY202.png is excluded by !**/*.png
  • docs/images/SY204.png is excluded by !**/*.png
  • docs/images/SY210.png is excluded by !**/*.png
  • docs/images/UNAT02.png is excluded by !**/*.png
  • docs/images/VNS001.png is excluded by !**/*.png
  • docs/images/WG002.png is excluded by !**/*.png
  • docs/images/WG003.png is excluded by !**/*.png
  • docs/images/WG004.png is excluded by !**/*.png
📒 Files selected for processing (4)
  • .github/workflows/release.yaml (1 hunks)
  • docs/User-Guide_Armbian-Config/Localisation.md (1 hunks)
  • docs/User-Guide_Armbian-Config/Network.md (6 hunks)
  • docs/User-Guide_Armbian-Config/System.md (11 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/User-Guide_Armbian-Config/System.md

14-14: No empty links
null

(MD042, no-empty-links)


17-17: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)


23-23: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


23-23: Trailing punctuation in heading
Punctuation: '!'

(MD026, no-trailing-punctuation)


24-24: Lists should be surrounded by blank lines
null

(MD032, blanks-around-lists)


28-28: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


30-30: Lists should be surrounded by blank lines
null

(MD032, blanks-around-lists)


34-34: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


36-36: Lists should be surrounded by blank lines
null

(MD032, blanks-around-lists)


64-64: No empty links
null

(MD042, no-empty-links)


67-67: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)


103-103: No empty links
null

(MD042, no-empty-links)


136-136: No empty links
null

(MD042, no-empty-links)


165-165: No empty links
null

(MD042, no-empty-links)


184-184: Multiple top-level headings in the same document
null

(MD025, single-title, single-h1)


192-192: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


193-193: Lists should be surrounded by blank lines
null

(MD032, blanks-around-lists)


196-196: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


197-197: Lists should be surrounded by blank lines
null

(MD032, blanks-around-lists)


200-200: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


201-201: Lists should be surrounded by blank lines
null

(MD032, blanks-around-lists)


204-204: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


205-205: Lists should be surrounded by blank lines
null

(MD032, blanks-around-lists)


394-394: No empty links
null

(MD042, no-empty-links)


650-650: No empty links
null

(MD042, no-empty-links)


721-721: No empty links
null

(MD042, no-empty-links)


849-849: No empty links
null

(MD042, no-empty-links)

docs/User-Guide_Armbian-Config/Network.md

9-9: No empty links
null

(MD042, no-empty-links)


12-12: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)


40-40: Fenced code blocks should be surrounded by blank lines
null

(MD031, blanks-around-fences)


42-42: Fenced code blocks should be surrounded by blank lines
null

(MD031, blanks-around-fences)


88-88: No empty links
null

(MD042, no-empty-links)


268-268: No empty links
null

(MD042, no-empty-links)


289-289: No empty links
null

(MD042, no-empty-links)


308-308: No empty links
null

(MD042, no-empty-links)

docs/User-Guide_Armbian-Config/Localisation.md

9-9: No empty links
null

(MD042, no-empty-links)

🔇 Additional comments (3)
.github/workflows/release.yaml (3)

1-6: [Approval] Workflow Naming and Trigger Update
The workflow has been aptly renamed to “Update documentation website” and now triggers on the “main” branch. This change aligns nicely with the overall documentation deployment enhancements.


15-18: [Approval] Consistent Checkout Configuration
The checkout step correctly references the “main” branch and uses an appropriate fetch depth. This consistency helps ensure the proper revision is checked out during the workflow run.


34-39: [Approval] Documentation Build Step
The “Build documentation” step using mkdocs build --clean is clearly defined. Ensure that the generated site is correctly placed for the subsequent deployment step.

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

🧹 Nitpick comments (6)
.github/labeler.yml (3)

20-21: Improve YAML Array Comma Spacing for “Hardware” Label.

For better readability, please insert a space after each comma in the arrays.

Suggested diff:

-    - any-glob-to-any-file: ['patch/**/*','config/**/*']
-    - all-globs-to-all-files: ['!config/cli/**/*','!config/desktop/**/*','!config/distributions/**/*']
+    - any-glob-to-any-file: ['patch/**/*', 'config/**/*']
+    - all-globs-to-all-files: ['!config/cli/**/*', '!config/desktop/**/*', '!config/distributions/**/*']
🧰 Tools
🪛 YAMLlint (1.35.1)

[warning] 20-20: too few spaces after comma

(commas)


[warning] 21-21: too few spaces after comma

(commas)


[warning] 21-21: too few spaces after comma

(commas)


25-26: Improve YAML Array Comma Spacing for “Framework” Label.

Please add spaces after the commas to enhance readability in the array listing file patterns.

Suggested diff:

-    - any-glob-to-any-file: ['lib/**/*','tools/**/*','config/cli/**/*','extensions/**/*']
+    - any-glob-to-any-file: ['lib/**/*', 'tools/**/*', 'config/cli/**/*', 'extensions/**/*']
🧰 Tools
🪛 YAMLlint (1.35.1)

[warning] 26-26: too few spaces after comma

(commas)


[warning] 26-26: too few spaces after comma

(commas)


[warning] 26-26: too few spaces after comma

(commas)


54-54: Remove Trailing Whitespace.

There is trailing whitespace at the end of the comment on line 54. Removing it will help maintain a clean YAML format.

🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 54-54: trailing spaces

(trailing-spaces)

.github/labels.yml (3)

49-55: Typographical Corrections for Size Labels.

Please correct “less then” to “less than” and “more then” to “more than” in the descriptions for the size labels to improve clarity and professionalism.

Suggested diffs:

-  description: "PR with less then 50 lines"
+  description: "PR with less than 50 lines"
-  description: "PR with more then 50 and less then 250 lines"
+  description: "PR with more than 50 and less than 250 lines"

38-38: Remove Trailing Whitespace in “Good first issue” Description.

There appears to be an extra trailing space in the description for the "Good first issue" label.


43-45: Trim Trailing Space in “Python” Label Description.

The description for the "Python" label contains an unnecessary trailing space.

Suggested diff:

-  description: "Pull requests that update Python code "
+  description: "Pull requests that update Python code"
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3c3e2d6 and a2a5975.

📒 Files selected for processing (5)
  • .github/labeler.yml (1 hunks)
  • .github/labels.yml (1 hunks)
  • .github/workflows/clean-workflow-logs.yml (1 hunks)
  • .github/workflows/labels-from-yml.yml (1 hunks)
  • .github/workflows/pr-auto-labeler.yml (1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/clean-workflow-logs.yml

27-27: property "runs_to_keep" is not defined in object type {runs_older_than: string}

(expression)

🪛 YAMLlint (1.35.1)
.github/labeler.yml

[warning] 20-20: too few spaces after comma

(commas)


[warning] 21-21: too few spaces after comma

(commas)


[warning] 21-21: too few spaces after comma

(commas)


[warning] 26-26: too few spaces after comma

(commas)


[warning] 26-26: too few spaces after comma

(commas)


[warning] 26-26: too few spaces after comma

(commas)


[error] 54-54: trailing spaces

(trailing-spaces)

🔇 Additional comments (4)
.github/workflows/labels-from-yml.yml (1)

1-37: Well-Structured Label Synchronization Workflow.

The workflow file correctly defines trigger events (workflow_dispatch, push on .github/labels.yml, and pull_request) and sets appropriate permissions. The use of the crazy-max/ghaction-github-labeler@v5 action is appropriate and clear.

.github/labeler.yml (1)

1-58: Overall, Labeler Configuration Looks Good.

The file is well-organized, and the label rules are clearly defined. Once the minor style issues above are resolved, this configuration will be even easier to maintain.

🧰 Tools
🪛 YAMLlint (1.35.1)

[warning] 20-20: too few spaces after comma

(commas)


[warning] 21-21: too few spaces after comma

(commas)


[warning] 21-21: too few spaces after comma

(commas)


[warning] 26-26: too few spaces after comma

(commas)


[warning] 26-26: too few spaces after comma

(commas)


[warning] 26-26: too few spaces after comma

(commas)


[error] 54-54: trailing spaces

(trailing-spaces)

.github/workflows/pr-auto-labeler.yml (1)

1-61: Well-Structured Automatic PR Labeling Workflow.

The workflow efficiently defines jobs for label removal, category labeling, and size labeling with clear conditions and appropriate permissions. The actions and their versions are correctly referenced.

.github/labels.yml (1)

1-112: Overall Labels File is Well-Defined.

The labels are comprehensively defined and provide useful categorization for project management. Once you address the minor typographical issues noted above, the file will conform perfectly to best practices.

igorpecovnik and others added 2 commits April 9, 2025 17:52
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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 (2)
.github/labels.yml (2)

31-36: Grammar Improvement on Size Label Descriptions
In the descriptions for "size/small" and "size/medium", consider changing “then” to “than” for proper grammar. For example:

  • Change "PR with less then 50 lines" to "PR with less than 50 lines"
  • Change "PR with more then 50 and less then 250 lines" to "PR with more than 50 and less than 250 lines"

Apply the following diffs:

-  description: "PR with less then 50 lines"
+  description: "PR with less than 50 lines"
-  description: "PR with more then 50 and less then 250 lines"
+  description: "PR with more than 50 and less than 250 lines"

67-67: Remove Extraneous Trailing Line
Line 67 appears to contain an extraneous numeric entry with no associated content. Please remove it to ensure the YAML is clean and free of potential parsing issues.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a2a5975 and 650937b.

📒 Files selected for processing (5)
  • .github/labeler.yml (1 hunks)
  • .github/labels.yml (1 hunks)
  • .github/workflows/clean-workflow-logs.yml (1 hunks)
  • .github/workflows/labels-from-yml.yml (1 hunks)
  • .github/workflows/pr-auto-labeler.yml (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (4)
  • .github/labeler.yml
  • .github/workflows/labels-from-yml.yml
  • .github/workflows/clean-workflow-logs.yml
  • .github/workflows/pr-auto-labeler.yml
🔇 Additional comments (1)
.github/labels.yml (1)

1-66: Overall Structure and Label Definitions Look Good
The new YAML file clearly defines a comprehensive set of labels covering milestones, issue types, task sizes, statuses, and more. The structure is consistent and will work well with the integrated workflows for syncing labels.

@igorpecovnik igorpecovnik changed the title Adjust build action and enable upload to new WEB server Add various GH actions and enable upload to new WEB server Apr 9, 2025
@igorpecovnik igorpecovnik merged commit eab040c into main Apr 9, 2025
1 check passed
@igorpecovnik igorpecovnik deleted the uploaddocs branch April 9, 2025 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant