MarkBind / markbind

MarkBind is a tool for generating content-heavy websites from source files in Markdown format
https://markbind.org/
MIT License
134 stars 123 forks source link

Using DangerJS to check changes coupling of implementation files to test or documentation files #2523

Closed KevinEyo1 closed 2 months ago

KevinEyo1 commented 2 months ago

What is the purpose of this pull request?

Overview of changes:

2140

Added a workflow that utilizes DangerJS to check that certain implementation files having changes, has changes in its corresponding test or documentation files.

Anything you'd like to highlight/discuss: Currently run on pull_request and logs the error in CI logs. Does not include implementation of manual/automatic coupling of files. Once that is implemented with good accuracy, workflow can change to failing the check instead of just logging the error.

Testing instructions: Based on test couplings, proper error logs should be found in CI logs

Proposed commit message: (wrap lines at 72 characters) It can be easy to miss out on updating test or documentation files when implementing or changing features.

Let's add a workflow utilizing DangerJS to aid in checking and alerting developers if they forget to do so.


Checklist: :ballot_box_with_check:


Reviewer checklist:

Indicate the SEMVER impact of the PR:

At the end of the review, please label the PR with the appropriate label: r.Major, r.Minor, r.Patch.

Breaking change release note preparation (if applicable):

Give a brief explanation note about:

  • what was the old feature that was made obsolete
  • any replacement feature (if any), and
  • how the author should modify his website to migrate from the old feature to the replacement feature (if possible).
github-actions[bot] commented 2 months ago

@KevinEyo1 Each PR must have a SEMVER impact label, please remember to label the PR properly.