Skip to content

docs: add semantic-release section #17

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: add semantic-release section #17

wants to merge 1 commit into from

Conversation

drlkf
Copy link

@drlkf drlkf commented Aug 7, 2025

I've managed to implement automatic semantic-release CI that uploads new
versions to Hackage automatically in my recently transferred
megaparsec-utils
package, I think it could be useful for other members to be able to do the same.

This new section documents how to make it work for your repository if you want
to use it as well.

EDIT: turns out I had forgotten to remove the HACKAGE_TOKEN secret, and since using the haskell_github_trust token, it does not have permissions to upload, even candidates. Is it conceivable to convert haskell_github_trust to an uploader on Hackage? Otherwise, people might have to configure their own personal token in the repositories, which is not ideal. Let me know what you think :)

@drlkf drlkf requested a review from jamesdbrock August 7, 2025 20:45
@drlkf drlkf marked this pull request as draft August 7, 2025 21:05
@jamesdbrock
Copy link
Member

Thanks @drlkf ! I have two things to say about this.

First, it is not possible to make the haskell_github_trust Hackage account an uploader account because this is against the Hackage policies.

Second, I would like to keep the main README terse and focused on explaining the basic organizational rules. I would prefer to have instructions about automatic release in a separate markdown file which is linked to from the main README file.

@drlkf
Copy link
Author

drlkf commented Aug 8, 2025

it is not possible to make the haskell_github_trust Hackage account an uploader account because this is against the Hackage policies.

Ah I see, I'll contact the Hackage admin to see if they have a solution for organization accounts.

I would prefer to have instructions about automatic release in a separate markdown file which is linked to from the main README file.

Will do!

@drlkf drlkf force-pushed the semantic-release branch 4 times, most recently from 87f0865 to fe965a3 Compare August 8, 2025 18:18
@drlkf drlkf force-pushed the semantic-release branch from fe965a3 to ddbfe34 Compare August 8, 2025 18:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants