ci: add dependency status badge and improve documentation #102
+19
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…cted This change ensures that Outdated dependency badges accurately reflect the build status
Create comprehensive README documentation for the hedgehog-extras library, providing essential project information for users and contributors. Key additions: - Dependency status badge linking to cabal-outdated workflow - CI status badge for build health visibility - Clear project description explaining the library's purpose - Proper copyright and licensing information
newhoggy
force-pushed
the
newhoggy/cabal-dependencies-outdated-badge
branch
from
63ed961 to
786d7ae
Compare
carbolymer
approved these changes
Oct 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request
Description
This PR enhances the project's CI workflow to properly reflect dependency status and adds comprehensive documentation including a README with project overview and status badges.
Type of Change
Changes Made
Testing
Additional Notes
The cabal-outdated workflow now correctly exits with status code 1 when outdated dependencies are found, which will make the dependency status badge show a failure state instead of incorrectly showing success. This provides better visibility into the actual dependency health of the project.
The new README provides essential project information for users and contributors, including clear installation instructions for both Cabal and Stack package managers.