saayam-for-all / saayam-for-all/devsecops

Add a smoke test workflow to validate repo structure on push

Open
#91 7 comments 0 reactions 2 assignees View on GitHub

@Revant-h is already working on this.

Since Apr 2, 2026.

enhancement good first issue
Dominant language
Python
Stars
2
Forks
17
Avg merge
1m
Merged PRs (30d)
1

Description

Overview

As a basic sanity check, we want a GitHub Actions workflow that verifies key files exist in
the repo whenever someone pushes to main. Simple way to catch accidental deletions of
important files like README or CONTRIBUTING.

Steps

  1. Create .github/workflows/repo-structure-check.yml
  2. Set it to trigger on push to main
  3. Add steps that check for the existence of README.md, CONTRIBUTING.md, and .gitignore
  4. Make sure the workflow fails with a clear message if any file is missing

Acceptance Criteria

  • .github/workflows/repo-structure-check.yml added
  • Workflow triggers on push to main
  • Workflow passes on current repo state
  • Fails with a helpful message if a required file is missing

Resources

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.