[PR #1255] [MERGED] ci: change filename checks into steps with PR comment #2915

Closed
opened 2025-11-20 05:32:30 -05:00 by saavagebueno · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/community-scripts/ProxmoxVE/pull/1255
Author: @se-bastiaan
Created: 1/5/2025
Status: Merged
Merged: 1/6/2025
Merged by: @MickLesk

Base: mainHead: chore/post-comment-from-filename-checks


📝 Commits (2)

  • d034a1f Change filename checks into steps and post comment as result
  • 253796a Test

📊 Changes

2 files changed (+143 additions, -92 deletions)

View changed files

.github/workflows/check-lowercase.yml (+0 -92)
.github/workflows/validate-filenames.yml (+143 -0)

📄 Description

✍️ Description

This pull request includes significant changes to the GitHub Actions workflows for validating filenames. The changes involve replacing the check-lowercase.yml workflow with a new and improved validate-filenames.yml workflow. The new workflow consolidates validation steps and adds commenting on pull requests.

Workflow Consolidation and Improvement:

  • Removed the old .github/workflows/check-lowercase.yml workflow.
  • Added the new .github/workflows/validate-filenames.yml workflow, which consolidates the filename validation process.

Compared to the existing workflow:

  • The workflow should not fail when there are no changed file of a certain kind
  • The check on the filename is changed slightly to not include underscores or full-stops by removing the filename extension before checking the name

Like #1239 the comment placed by the workflow has start and end tags, to make it possible to add more information to a single comment from other workflows. In code it looks like:

<!-- validate-filenames-start -->
### Filename validation

:rocket: All files passed filename validation!


<!-- validate-filenames-end -->

Please remove unneeded lines!


🛠️ Type of Change

Please check the relevant options:

  • Bug fix (non-breaking change that resolves an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change unexpectedly)
  • New script (a fully functional and thoroughly tested script or set of scripts)

Prerequisites

The following steps must be completed for the pull request to be considered:

  • Self-review performed (I have reviewed my code to ensure it follows established patterns and conventions.)
  • Testing performed (I have thoroughly tested my changes and verified expected functionality.)
  • Documentation updated (I have updated any relevant documentation)

📋 Additional Information (optional)

Scherm­afbeelding 2025-01-05 om 13 13 38
Scherm­afbeelding 2025-01-05 om 13 18 29

Tested in my fork: https://github.com/se-bastiaan/ProxmoxVE/pull/3


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/community-scripts/ProxmoxVE/pull/1255 **Author:** [@se-bastiaan](https://github.com/se-bastiaan) **Created:** 1/5/2025 **Status:** ✅ Merged **Merged:** 1/6/2025 **Merged by:** [@MickLesk](https://github.com/MickLesk) **Base:** `main` ← **Head:** `chore/post-comment-from-filename-checks` --- ### 📝 Commits (2) - [`d034a1f`](https://github.com/community-scripts/ProxmoxVE/commit/d034a1f531c4d482ff6fe1191976bd0268384fcb) Change filename checks into steps and post comment as result - [`253796a`](https://github.com/community-scripts/ProxmoxVE/commit/253796a0731aed63b152f01691ec60647cb4bb33) Test ### 📊 Changes **2 files changed** (+143 additions, -92 deletions) <details> <summary>View changed files</summary> ➖ `.github/workflows/check-lowercase.yml` (+0 -92) ➕ `.github/workflows/validate-filenames.yml` (+143 -0) </details> ### 📄 Description ## ✍️ Description This pull request includes significant changes to the GitHub Actions workflows for validating filenames. The changes involve replacing the `check-lowercase.yml` workflow with a new and improved `validate-filenames.yml` workflow. The new workflow consolidates validation steps and adds commenting on pull requests. ### Workflow Consolidation and Improvement: * Removed the old `.github/workflows/check-lowercase.yml` workflow. * Added the new `.github/workflows/validate-filenames.yml` workflow, which consolidates the filename validation process. Compared to the existing workflow: * The workflow should not fail when there are no changed file of a certain kind * The check on the filename is changed slightly to not include underscores or full-stops by removing the filename extension before checking the name Like #1239 the comment placed by the workflow has start and end tags, to make it possible to add more information to a single comment from other workflows. In code it looks like: ``` <!-- validate-filenames-start --> ### Filename validation :rocket: All files passed filename validation! <!-- validate-filenames-end --> ``` - - - **_Please remove unneeded lines!_** - Related PR: #920 #1240 #1239 - Related Discussion: []()(if applicable) --- ## 🛠️ Type of Change Please check the relevant options: - [ ] Bug fix (non-breaking change that resolves an issue) - [x] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change unexpectedly) - [ ] New script (a fully functional and thoroughly tested script or set of scripts) --- ## ✅ Prerequisites The following steps must be completed for the pull request to be considered: - [x] Self-review performed (I have reviewed my code to ensure it follows established patterns and conventions.) - [x] Testing performed (I have thoroughly tested my changes and verified expected functionality.) - [ ] Documentation updated (I have updated any relevant documentation) --- ## 📋 Additional Information (optional) ![Scherm­afbeelding 2025-01-05 om 13 13 38](https://github.com/user-attachments/assets/cc2f76f1-9245-4c14-9563-4da4d1f5bbb1) ![Scherm­afbeelding 2025-01-05 om 13 18 29](https://github.com/user-attachments/assets/0fe199c2-406f-4bba-a099-163c11bade1c) Tested in my fork: https://github.com/se-bastiaan/ProxmoxVE/pull/3 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
saavagebueno added the pull-request label 2025-11-20 05:32:30 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: SVI/ProxmoxVE#2915