Update docs #107
Update docs #107
Conversation
remote th-packages
|
I wonder if we should have the changelog.md based on week numbers? Say we just write down every friday/monday what happend to the repo the week before and note down the relevant migrations? @rvl what do you think? We could also start some versioning, but an implicit one based on week numbers may be better? |
There was a problem hiding this comment.
Looks good, I like the changelog. Although I think it would be fine if docs/migration.md were rolled in to the same file.
Something to think about later - looking at the doc in iohk-nix.md I think it would be better implemented as a "skeleton" project in iohk-nix. This skeleton could also serve as a test case for stack-to-nix regeneration and so on.
|
@angerman Let's not overthink it ... versioning is probably not necessary. Users will be getting this by picking the latest git rev on master. I believe the changelog should be updated with the PR which introduces the change, and we should not accept PRs without adequate documentation. |
Changes needed to support improved handling of `source-repository-package` in `cabal.project`. Currently the `haskell.nix` `cabalProject` functions replace these with regular `packages:` pointing at the downloaded source and these are not treated the same by `cabal`. We are planning to change it so: * `haskell.nix` will use `git` to create local repos and a replacement `source-repoository-package`. * Once the `plan.json` is generated and `plan-to-nix ` has replace these the `/nix/store` paths (so that materialization can work). * Have the src mapped to `fetchgit` in haskell.nix. For this to work we need to be able to identify the `source-repository-packages`. This change added `url`, `rev` and `sha256` attributes to the `src` for `source-repository-packages`. It also fixes an issue where the `source-repository-package` is expected to be in `hackage` and allows fixes a problem with the cache if a `source-repository-package` did not have a sha256 provided (not needed if it is coming from `/nix/store`). Used by input-output-hk#1166
Changes needed to support improved handling of `source-repository-package` in `cabal.project`. Currently the `haskell.nix` `cabalProject` functions replace these with regular `packages:` pointing at the downloaded source and these are not treated the same by `cabal`. We are planning to change it so: * `haskell.nix` will use `git` to create local repos and a replacement `source-repoository-package`. * Once the `plan.json` is generated and `plan-to-nix ` has replace these the `/nix/store` paths (so that materialization can work). * Have the src mapped to `fetchgit` in haskell.nix. For this to work we need to be able to identify the `source-repository-packages`. This change added `url`, `rev` and `sha256` attributes to the `src` for `source-repository-packages`. It also fixes an issue where the `source-repository-package` is expected to be in `hackage` and allows fixes a problem with the cache if a `source-repository-package` did not have a sha256 provided (not needed if it is coming from `/nix/store`). Used by input-output-hk#1166
remote th-packages