Page MenuHomePhabricator

[Docs/nix] Document how to update flake and push artifacts
Changes PlannedPublic

Authored by varun on Jul 10 2023, 2:56 PM.
Tags
None
Referenced Files
Unknown Object (File)
Sat, Nov 23, 7:16 AM
Unknown Object (File)
Sat, Nov 23, 3:33 AM
Unknown Object (File)
Tue, Nov 19, 5:45 AM
Unknown Object (File)
Tue, Nov 19, 5:45 AM
Unknown Object (File)
Tue, Nov 19, 5:44 AM
Unknown Object (File)
Tue, Nov 19, 5:39 AM
Unknown Object (File)
Sun, Nov 3, 1:38 AM
Unknown Object (File)
Sun, Nov 3, 1:38 AM
Subscribers

Details

Reviewers
jon
Summary

Describe how to update nixpkgs and push the new development
environment packages.

Part of: https://linear.app/comm/issue/ENG-4372

Test Plan

Follow the docs

Diff Detail

Repository
rCOMM Comm
Branch
arcpatch-D8468
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

ashoat requested changes to this revision.Jul 11 2023, 8:24 AM

Please, please try harder to proofread your English. It's really frustrating to have to do basic English editing. I am confident you can do better if you put more effort into it.

docs/nix_workflows.md
5 ↗(On Diff #28565)
7 ↗(On Diff #28565)

What's a "pin" mean here? It's worth explaining that the pin here is a hash of the full repository state, rather than a hash of your local state, or a struct of individual hashes for individual packages. Nix's approach is rather unusual among package managers (at least in my experience), so it merits some explanation

10 ↗(On Diff #28565)

Wondering – what's different between this command vs. nix flake update?

15 ↗(On Diff #28565)
  1. You're mixing singular / plural. Perhaps you can check your grammar with Grammarly in the future before submitting docs diffs? I really, really would love to get to a point where I'm not the singular editor for Comm docs. It's not a great use of my team, and I'm confident that other folks on the team (such as yourself) could get better at this if you took it as a serious requirement. There are plenty of tools out there to help with English composition.
  2. You're not explaining what Cachix is. Please start with that.
19 ↗(On Diff #28565)
  1. "setup" is a noun. For the verb form, you should use "set up"
  2. "To setup to auth" is not a valid sentence construction
  3. You failed to capitalize Cachix here, despite capitalizing it elsewhere
This revision now requires changes to proceed.Jul 11 2023, 8:24 AM
jon marked 5 inline comments as done.

Address feedback

docs/nix_workflows.md
10 ↗(On Diff #28565)

update is pretty much the command --recreate-lock-file, in which all inputs will be updated. nix flake lock allows for --update-input which selects only one input.

The choice between update and lock seems somewhat arbitrary.

Also, nix flake update is the same as nix flake lock --recreate-lock-file

15 ↗(On Diff #28565)

Reworded this entirely

I simply can't be the first line reviewer for @jon's docs diffs anymore – this isn't a good use of my time, and frankly it's deeply frustrating for me. I feel like I'm saying the same things over and over.

@jon, please come up with a new plan for getting docs diffs through. That plan will still require my approval at the end, but by the time you add me as a reviewer, I should be able to simply accept the diff.

I think it's unlikely you'll be able to achieve this yourself. You'll need to use some combination of other reviewers and tools (such as Grammarly, which I've mentioned before but you're clearly still not using).

docs/nix_workflows.md
7

Lots of issues here. First of all, there's a comma splice. Are you using Grammarly like I suggested previously?

Second of all, you're not capitalizing the proper noun "Git".

Third of all, you're trying to explain something before it's referenced. People have no idea what you're talking about when you start referencing "the nixpkgs input" here

ashoat removed a reviewer: ashoat. ashoat added 1 blocking reviewer(s): varun.Aug 1 2023, 8:22 AM
ashoat added a subscriber: ashoat.

Please add me as a blocking reviewer before landing, once you're both sure I'll be able to simply accept the diff without needing to request any changes

varun planned changes to this revision.
varun edited reviewers, added: jon; removed: varun.