Skip to content

Add build instructions for developers#2621

Merged
smatting merged 8 commits intodevelopfrom
smatting/build-docs
Aug 17, 2022
Merged

Add build instructions for developers#2621
smatting merged 8 commits intodevelopfrom
smatting/build-docs

Conversation

@smatting
Copy link
Contributor

@smatting smatting commented Aug 16, 2022

This PR

  • adds documentation for how to build wire-server to ./docs/developer/building.md (and link from README.md in project root)
  • includes hie.yaml in repo (so it doesn't have to be generated)
  • add makefile target for cabal.project.local file
  • update delete-cache-on-linker-errors makefile target: delete ~/.cabal/store instead of ~/.cabal

Checklist

  • The PR Title explains the impact of the change.
  • The PR description provides context as to why the change should occur and what the code contributes to that effect. This could also be a link to a JIRA ticket or a Github issue, if there is one.
  • If this PR changes development workflow or dependencies, they have been A) automated and B) documented under docs/developer/. All efforts have been taken to minimize development setup breakage or slowdown for co-workers.
  • changelog.d contains the following bits of information (details):
    • A file with the changelog entry in one or more suitable sub-sections. The sub-sections are marked by directories inside changelog.d.

@smatting smatting temporarily deployed to cachix August 16, 2022 13:58 Inactive
@smatting smatting temporarily deployed to cachix August 16, 2022 13:58 Inactive
@zebot zebot added the ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist label Aug 16, 2022
@smatting smatting changed the title Update build instructions for developers Add build instructions for developers Aug 16, 2022
@smatting smatting added the not-ok-to-test Not approved for running tests in CI, this label is ignored if ok-to-test also exists on a PR label Aug 16, 2022
@smatting smatting temporarily deployed to cachix August 16, 2022 14:09 Inactive
@smatting smatting temporarily deployed to cachix August 16, 2022 14:09 Inactive
@smatting smatting marked this pull request as ready for review August 16, 2022 14:10
Comment on lines +8 to +15
1. Create a `.envrc.local` file with these contents

```
export COMPILE_NGINX_USING_NIX=1
export WIRE_BUILD_WITH_CABAL=1
```

and reload the direnv via `direnv reload`
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to remove these variables in a separate PR

@smatting smatting requested a review from jschaul August 16, 2022 14:11
@smatting smatting temporarily deployed to cachix August 16, 2022 16:37 Inactive
@smatting smatting temporarily deployed to cachix August 16, 2022 16:37 Inactive
@smatting smatting temporarily deployed to cachix August 16, 2022 16:38 Inactive
@smatting smatting temporarily deployed to cachix August 16, 2022 16:38 Inactive
@smatting smatting temporarily deployed to cachix August 16, 2022 16:48 Inactive
@smatting smatting temporarily deployed to cachix August 16, 2022 16:48 Inactive
Copy link
Member

@jschaul jschaul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Looks good! Note that this may conflict with #2623 in that one makefile target so a rebase might be needed if that other PR is merged first.

Copy link
Contributor

@fisx fisx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This also conflicts with #2622, but it should be easy to fix: just rebase whoever goes second over the other, git mv docs/developer/building.md docs/src/developer/developer/building.md, and add a toc entry to docs/src/developer/index.rst.

@smatting
Copy link
Contributor Author

Thanks! Looks good! Note that this may conflict with #2623 in that one makefile target so a rebase might be needed if that other PR is merged first.

I removed the duplicated changes from this PR.

@smatting smatting merged commit 2df8b83 into develop Aug 17, 2022
@smatting smatting deleted the smatting/build-docs branch August 17, 2022 16:10
@smatting smatting mentioned this pull request Aug 17, 2022
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

not-ok-to-test Not approved for running tests in CI, this label is ignored if ok-to-test also exists on a PR ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants