Skip to content

ci: documentation: Add README.rst validation for new components #2793

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
Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

ci: documentation: Add README.rst validation for new components #2793

wants to merge 4 commits into from

Conversation

@amiclaus
Copy link
Contributor

@amiclaus amiclaus commented Oct 21, 2025 •
edited
Loading

Pull Request Description

Add check_new_components_readme function to validate that new drivers
and projects include proper README.rst documentation files.

The check examines newly added source files and ensures corresponding
README.rst files exist in the component directory structure.

image

PR Type

  • Bug fix (change that fixes an issue)
  • New feature (change that adds new functionality)
  • Breaking change (has dependencies in other repos or will cause CI to fail)

PR Checklist

  • I have followed the Coding style guidelines
  • I have complied with the Submission Checklist
  • I have performed a self-review of the changes
  • I have commented my code, at least hard-to-understand parts
  • I have build all projects affected by the changes in this PR
  • I have tested in hardware affected projects, at the relevant boards
  • I have signed off all commits from this PR
  • I have updated the documentation (wiki pages, ReadMe etc), if applies

@amiclaus
ci: add parse_commit_range function into lib.sh
47196a3 
Move duplicated parse_commit_range function from astyle.sh and
documentation.sh into shared lib.sh to eliminate code duplication.

Signed-off-by: Antoniu Miclaus <antoniu.miclaus@analog.com>
@amiclaus
ci: documentation: Add README.rst validation for new components
fd2c969 
Add check_new_components_readme function to validate that new drivers
and projects include proper README.rst documentation files.

The check examines newly added source files and ensures corresponding
README.rst files exist in the component directory structure.

Signed-off-by: Antoniu Miclaus <antoniu.miclaus@analog.com>
@amiclaus
add test driver
37a5c2c 
Add driver to test ci changes

Signed-off-by: Antoniu Miclaus <antoniu.miclaus@analog.com>
@amiclaus
adc_test: add README
954fd35 
Add README documentation.

Signed-off-by: Antoniu Miclaus <antoniu.miclaus@analog.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dbogdan dbogdan Awaiting requested review from dbogdan dbogdan will be requested when the pull request is marked ready for review dbogdan is a code owner

@rbolboac rbolboac Awaiting requested review from rbolboac rbolboac will be requested when the pull request is marked ready for review rbolboac is a code owner

@CiprianRegus CiprianRegus Awaiting requested review from CiprianRegus CiprianRegus will be requested when the pull request is marked ready for review CiprianRegus is a code owner

@buha buha Awaiting requested review from buha buha will be requested when the pull request is marked ready for review buha is a code owner

@SRaus SRaus Awaiting requested review from SRaus SRaus will be requested when the pull request is marked ready for review SRaus is a code owner

@AAndrisa AAndrisa Awaiting requested review from AAndrisa AAndrisa will be requested when the pull request is marked ready for review AAndrisa is a code owner

@danmois danmois Awaiting requested review from danmois danmois will be requested when the pull request is marked ready for review danmois is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@amiclaus