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

[Chore] Update release checklist & fix base constraint #177

Merged
merged 3 commits into from
Sep 28, 2022

Conversation

dcastro
Copy link
Member

@dcastro dcastro commented Sep 28, 2022

Description

This PR:

  • Adds an item to the release checklist so we won't forget to upload xrefcheck to hackage.
  • Removes unnecessary extra-deps from stack.yaml
  • We accidentally removed the base constraint in Kirill.andreev/deriving strats by def #97 - but this is needed to build a release tarball with stack sdist, so let's add it back in.

Related issue(s)

None

✅ Checklist for your Pull Request

Ideally a PR has all of the checkmarks set.

If something in this list is irrelevant to your PR, you should still set this
checkmark indicating that you are sure it is dealt with (be that by irrelevance).

Related changes (conditional)

  • Tests

    • If I added new functionality, I added tests covering it.
    • If I fixed a bug, I added a regression test to prevent the bug from
      silently reappearing again.
  • Documentation

    • I checked whether I should update the docs and did so if necessary:
  • Public contracts

    • Any modifications of public contracts comply with the Evolution
      of Public Contracts
      policy.
    • I added an entry to the changelog if my changes are visible to the users
      and
    • provided a migration guide for breaking changes if possible

Stylistic guide (mandatory)

✓ Release Checklist

  • I updated the version number in package.yaml.
  • I updated the changelog and moved everything
    under the "Unreleased" section to a new section for this release version.
  • (After merging) I edited the auto-release.
    • Change the tag and title using the format vX.Y.Z.
    • Write a summary of all user-facing changes.
    • Deselect the "This is a pre-release" checkbox at the bottom.
  • (After merging) I updated xrefcheck-action.

Problem: `stack sdist` fails with the following message when there are no version constraints on `base`:

> Package check reported the following errors:
> The dependency 'build-depends: base' does not specify an upper bound on the version number. Each major release of the 'base' package changes the API in various ways and most packages will need some changes to compile with it. The recommended practice is to specify an upper bound on the version of the 'base' package. This ensures your package will continue to build when a new major version of the 'base' package is released. If you are not sure what upper bound to use then use the next  major version. For example if you have tested your package with 'base' version 4.5 and 4.6 then use 'build-depends: base >= 4.5 && < 4.7'.

Solution: Add a version constraint to `base`.
@dcastro dcastro requested a review from Sereja313 September 28, 2022 10:16
@dcastro dcastro merged commit c5096e5 into master Sep 28, 2022
@delete-merged-branch delete-merged-branch bot deleted the diogo/update-release-checklist branch September 28, 2022 11:23
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