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

Include patched hackage-security for #3073 #3865

Merged
merged 1 commit into from
Feb 16, 2018

Conversation

snoyberg
Copy link
Contributor

NOTE: This is included via an extra-dep, which would constitute the
first time Stack would include a patched version of an upstream library.
This is due to the fact that
haskell/hackage-security#203 is likely not going
to be merged, despite fixing issues affecting Stack. This leaves us with
(AFAICT) 4 choices at the Stack level:

  1. Continue using the officially released upstream version of
    hackage-security, bugs and all
  2. Fork hackage-security on Hackage, and depend on the fork
  3. Inline the code from hackage-security into Stack itself, and drop the
    explicit dependency on hackage-security
  4. Include hackage-security via an extra-dep pointing at a Git commit.
    Our official builds will use the patched version of hackage-security,
    and anyone building from Hackage will end up with the unpatched version

This PR represents approach (4). If and when the PR is merged and
released to Hackage, this becomes a non-issue. But generally speaking,
we should have a policy in Stack for handling these kinds of upstream
issues cases.

Note: Documentation fixes for https://docs.haskellstack.org/en/stable/ should target the "stable" branch, not master.

Please include the following checklist in your PR:

  • Any changes that could be relevant to users have been recorded in the ChangeLog.md
  • The documentation has been updated, if necessary.

Please also shortly describe how you tested your change. Bonus points for added tests!

@borsboom
Copy link
Contributor

Looks like it got merged after all. Do we wait for a new release from upstream or use the patched version anyway?

@snoyberg
Copy link
Contributor Author

I've asked @hvr for clarification on the release timing of hackage-security in haskell/hackage-security#202 (comment). I'd say that, if the release isn't scheduled to happen this week, we move ahead with this PR, and then update to use the Hackage version when available. (Meanwhile, I'll update this PR to use the master branch of haskell/hackage-security instead.)

NOTE: This is included via an extra-dep, which would constitute the
first time Stack would include a patched version of an upstream library.
This is due to the fact that
haskell/hackage-security#203 is likely not going
to be merged, despite fixing issues affecting Stack. This leaves us with
(AFAICT) 4 choices at the Stack level:

1. Continue using the officially released upstream version of
   hackage-security, bugs and all
2. Fork hackage-security on Hackage, and depend on the fork
3. Inline the code from hackage-security into Stack itself, and drop the
   explicit dependency on hackage-security
4. Include hackage-security via an `extra-dep` pointing at a Git commit.
   Our official builds will use the patched version of hackage-security,
   and anyone building from Hackage will end up with the unpatched version

This PR represents approach (4). If and when the PR is merged and
released to Hackage, this becomes a non-issue. But generally speaking,
we should have a policy in Stack for handling these kinds of upstream
issues cases.
@snoyberg snoyberg force-pushed the 3073-fix-hackage-security branch from f1ab593 to e961238 Compare February 16, 2018 06:45
@snoyberg
Copy link
Contributor Author

I've pushed a commit to rebase against the latest stable branch and include further upstream changes on hackage-security (for better or worse, we should match upstream as closely as possible). Since we're probably not getting an answer any time soon, let's merge this as soon as CI goes green.

@borsboom borsboom merged commit 24728e6 into stable Feb 16, 2018
@snoyberg snoyberg deleted the 3073-fix-hackage-security branch February 16, 2018 12:10
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