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.

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

Check that Tech Docs are up-to-date #1151

Closed
gspetro-NOAA opened this issue Nov 7, 2024 · 0 comments · Fixed by #1152
Closed

Check that Tech Docs are up-to-date #1151

gspetro-NOAA opened this issue Nov 7, 2024 · 0 comments · Fixed by #1152
Labels
enhancement New feature or request

Comments

@gspetro-NOAA
Copy link
Collaborator

Description

Currently, we have Technical Documentation, but there is no way to ensure that it stays up-to-date as scripts are added or removed.

Solution

Add a GitHub action that checks for up-to-date Tech Docs and fails when they have not been updated.

Requirements**

A test must fail if the technical documentation does not reflect the PR contents.

Acceptance Criteria (Definition of Done)

All PRs are check for up-to-date technical documentation and receive a failing test when they are out-of-date.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
1 participant