ci: add automated package publishing to Hackage #103
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
newhoggy
force-pushed
the
newhoggy/add-ability-to-publish-from-ci
branch
from
a070197 to
b89c092
Compare
Implements comprehensive automated publishing to Hackage with proper validation and error handling, while consolidating the CI/CD pipeline for more efficient releases. Publishing improvements: - Switch from curl-based uploads to native cabal upload command - Configure credentials via cabal config file instead of curl auth - Add automatic version extraction from cabal file - Implement duplicate upload detection to prevent failures - Support both candidate and production publishing modes Release workflow enhancements: - Merge separate publish job into release job for efficiency - Add write permissions for automated release creation - Support both tag-based and manual release triggers - Switch to softprops/action-gh-release for robust releases - Remove redundant artifact upload steps Configuration changes: - Add HACKAGE_USERNAME and HACKAGE_PASSWORD secret configuration - Install Haskell toolchain in release job for cabal commands This change significantly simplifies the deployment pipeline while adding proper error handling and validation to prevent common publishing issues like duplicate uploads or missing credentials.
newhoggy
force-pushed
the
newhoggy/add-ability-to-publish-from-ci
branch
from
b89c092 to
835a886
Compare
The README includes: - Project overview and purpose as a supplemental library for Hedgehog - Installation instructions for package.yaml and .cabal files - Detailed release workflow documentation covering both automatic and manual tagging processes - CI/CD pipeline integration with GitHub Actions - Hackage candidate upload and publication process - Build status badges for dependency tracking and CI status The release documentation is particularly comprehensive, explaining: - Automatic tag creation when version bumps are pushed to main - Manual tag creation process for direct control - Automated workflow steps including testing, validation, and Hackage candidate uploads - Post-workflow steps for reviewing and publishing candidates
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
This PR implements automated publishing workflow for Hackage packages with comprehensive validation and error handling to prevent duplicate uploads. The workflow enhancement enables automatic package deployment to Hackage as part of the CI pipeline, along with complete project documentation.
Type of Change
Changes Made
cabal uploadcommand for more reliable Hackage publishingsoftprops/action-gh-releasefor more robust GitHub releasesTesting
Additional Notes
The publishing workflow uses GitHub secrets for Hackage credentials (
HACKAGE_USERandHACKAGE_PASS) which need to be configured in the repository settings. The workflow is currently configured to publish packages as candidates by default, which allows for testing before final release. The README now provides complete documentation on the release process, including automatic tag creation on version bumps and the Hackage candidate review process.