haskell-updates: add documentation for workflow by cdepillabout · Pull Request #122728 · NixOS/nixpkgs

cdepillabout · 2021-05-12T13:53:05Z

This some documentation for is the workflow for the haskell-updates branch. This would mostly be a reference for @maralorn, @sternenseemann, and me. This would also be useful if someone else joined the nixpkgs haskell maintainer group.

I welcome any bikeshedding on what to name this document or where to put it.

This document will mostly be based on the comment from @maralorn in #122510 (comment).

This is related to #121403.

Rendered

cdepillabout · 2021-05-12T13:54:25Z

I plan on continuing to update this document while I work on getting #122719 ready to merge in. I will try to document everything I do in detail.

cdepillabout · 2021-05-27T12:51:19Z

This should be ready for review.

I'd especially appreciate reviews from @maralorn and @sternenseemann. Feel free to rewrite/add anything.

cdepillabout · 2021-05-27T13:00:56Z

pkgs/development/haskell-modules/HACKING.md

+### Additional Info
+
+Here are some additional tips that didn't fit in above.


At some point I'd like to add a section about marking packages broken on architectures other than x86_64-linux, but since we haven't really come to a conclusion on what to do about that, I haven't added it to this document.

cdepillabout · 2021-05-27T13:01:44Z

pkgs/development/haskell-modules/HACKING.md

+## Contributor Workflow
+
+(TODO: this section is to describe the type of workflow for non-committers to
+contribute to `haskell-updates`)


I plan on trying to write this at some point in the future.

Possibly either during Zurihac, or the next time it is my turn to take care of the haskell-updates workflow.

We should probably move the contributor workflow to the nixpkgs manual as well then. Not sure if the maintainer workflow belongs there though (probably not, as similar documentation like the release manager documentation is also managed separately)

I don't really like the "out of sight, out of mind" quality of the nixpkgs manual. I think it is way too easy not to update documentation when it doesn't live near the code.

However, I agree that it probably does make the most sense for the contributor workflow to live there.

maralorn · 2021-05-27T16:57:25Z

Do you want this to be merged now? I would be okay with saving this and improving on it. In the future we definitely need a consistent concept on how this documentation relates to the manual.

sternenseemann

Thanks for doing this! I like the step-by-step descriptions, I think this will be helpful in the future.

sternenseemann · 2021-05-27T17:54:33Z

pkgs/development/haskell-modules/HACKING.md

+## Contributor Workflow
+
+(TODO: this section is to describe the type of workflow for non-committers to
+contribute to `haskell-updates`)


We should probably move the contributor workflow to the nixpkgs manual as well then. Not sure if the maintainer workflow belongs there though (probably not, as similar documentation like the release manager documentation is also managed separately)

pkgs/development/haskell-modules/HACKING.md

sternenseemann · 2021-05-27T17:57:54Z

pkgs/development/haskell-modules/HACKING.md

+merging the `haskell-updates` branch into `master`.
+
+The goal of this workflow is to regularly merge the `haskell-updates` branch
+into the `master` branch, while making sure there are no evaluation errors or


I'd clarify this: A broken package technically fails to evaluate. I guess the main properties are currently:

No inacceptable regressions in terms of build failures (maintained, mergeable, ...)

No non-broken package that fails to build (on x86_64-linux)

Might've missed something?

I don't think this necessarily needs to be clarified in the overview here.

However, below there is a section called "Merge haskell-updates into master". It explains that all Haskell packages that fail to build should be marked broken, as well mentioning the maintained and mergeable jobs.

I'm going to go ahead and merge this in, but if you want to clean up that section (or even this overview/introduction), please feel free to either leave a message here or just commit directly to haskell-updates.

pkgs/development/haskell-modules/HACKING.md

sternenseemann · 2021-05-27T18:05:03Z

pkgs/development/haskell-modules/HACKING.md

+- The maintainers for any maintained Haskell packages that are newly broken
+  have been pinged on GitHub and given at least a week to fix their packages.
+  This is especially important for widely-used packages like `cachix`.
+


As per yesterday's discussion, we should make it a point here to merge master into haskell-updates and waiting for the rebuilds to finish before merging the PR.

Especially since I realized: Merging in master and hitting "eval" on hydra and seeing if anything new happens is really only a matter of a few minutes. I think we can afford to do that on every merge.

I've rearranged this in adfec8b. Hopefully it is somewhat more clear now.

pkgs/development/haskell-modules/HACKING.md

cdepillabout · 2021-05-28T01:03:24Z

Note to myself: probably should also add a explanation of running update-cabal2nix-unstable and when it is helpful to do so. @maralorn's comment reminded me of this: #124593 (comment)

Another note: probably should add a comment that we all hang out on Matrix.

Co-authored-by: sterni <sternenseemann@systemli.org>

…broken package list

…erging master into haskell-updates

cdepillabout · 2021-05-30T05:18:20Z

Note to myself: probably should also add a explanation of running update-cabal2nix-unstable and when it is helpful to do so. @maralorn's comment reminded me of this: #124593 (comment)

Another note: probably should add a comment that we all hang out on Matrix.

I've done this in commit 95e7f26.

I'm going to go ahead and merge this in, but if you guys want to comment on or fix up anything else, please continue to leave comments here and I will commit changes to this document directly to the haskell-updates branch. Or, definitely feel free to just commit changes directly yourselves!

haskell-updates: add documentation for workflow

3e84cfa

github-actions bot added the 6.topic: haskell General-purpose, statically typed, purely functional programming language label May 12, 2021

cdepillabout mentioned this pull request May 12, 2021

Bring the Haskell documentation back into nixpkgs #121403

Closed

ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux. labels May 12, 2021

cdepillabout added 2 commits May 15, 2021 18:10

haskell-updates: more documentation

f56b6e1

haskell-updates: more documentation

c40e194

sternenseemann closed this May 19, 2021

sternenseemann deleted the branch NixOS:haskell-updates May 19, 2021 01:53

sternenseemann reopened this May 19, 2021

cdepillabout mentioned this pull request May 19, 2021

haskell infrastructure: moving forward without peti #121140

Closed

haskell-updates: more documentation

3640440

cdepillabout marked this pull request as ready for review May 27, 2021 12:50

cdepillabout requested review from maralorn and sternenseemann as code owners May 27, 2021 12:50

haskell-updates: small fixes

efd2910

cdepillabout commented May 27, 2021

View reviewed changes

sternenseemann reviewed May 27, 2021

View reviewed changes

cdepillabout and others added 4 commits May 30, 2021 10:49

haskell-updates: more fixes for workflow documentation

532ce05

Co-authored-by: sterni <sternenseemann@systemli.org>

haskell-updates: add dot slash to commands in maintainer docs

dcc4f8e

haskell-updates: add link for HACKING.md

197dae2

haskell-updates: update workflow documentation to put goal first

bd6a1e1

cdepillabout force-pushed the haskell-updates-workflow branch from 7ea2cc7 to bd6a1e1 Compare May 30, 2021 02:54

cdepillabout added 2 commits May 30, 2021 13:19

haskell-updates: update workflow documentation to explain transitive …

6b80742

…broken package list

haskell-updates: update workflow documentation to expand section on m…

adfec8b

…erging master into haskell-updates

haskell-updates: update workflow documentation with a few small fixes

95e7f26

cdepillabout merged commit 718ab6d into NixOS:haskell-updates May 30, 2021

cdepillabout deleted the haskell-updates-workflow branch May 30, 2021 05:24

		### Additional Info

		Here are some additional tips that didn't fit in above.

Uh oh!

Conversation

cdepillabout commented May 12, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cdepillabout commented May 12, 2021

Uh oh!

cdepillabout commented May 27, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

maralorn commented May 27, 2021

Uh oh!

sternenseemann left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cdepillabout commented May 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cdepillabout commented May 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

cdepillabout commented May 12, 2021 •

edited

Loading

cdepillabout commented May 28, 2021 •

edited

Loading

cdepillabout commented May 30, 2021 •

edited

Loading