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

haskell: document branch-off procedure for maintainers #138831

Draft
wants to merge 1 commit into
base: haskell-updates
Choose a base branch
from

Conversation

sternenseemann
Copy link
Member

Motivation for this change

Add documentation for the new frozen package workflow in relation to branch-off. This is added to haskell-updates since release-21.05 lacks HACKING.md. The actual changes will be forward ported to unstable after they are finalized and merged into release-21.05.

Things done
  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandbox = true set in nix.conf? (See Nix manual)
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • 21.11 Release Notes (or backporting 21.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Initial documentation of the branch-off procedure with the changes
in NixOS#138407 which are yet to be forward-ported.
them as a PR.

General information on the release process can be found in the
[NixOS Releaes Wiki](https://nixos.github.io/release-wiki/Release-Process-Walkthrough.html).
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
[NixOS Releaes Wiki](https://nixos.github.io/release-wiki/Release-Process-Walkthrough.html).
[NixOS Release Wiki](https://nixos.github.io/release-wiki/Release-Process-Walkthrough.html).

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
[NixOS Releaes Wiki](https://nixos.github.io/release-wiki/Release-Process-Walkthrough.html).
[NixOS Release Wiki](https://nixos.github.io/release-wiki/Release-Process.html).

General information on the release process can be found in the
[NixOS Releaes Wiki](https://nixos.github.io/release-wiki/Release-Process-Walkthrough.html).

The main objective for `haskellPackages` in the context of stable release
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
The main objective for `haskellPackages` in the context of stable release
The main objective for `haskellPackages` in the context of stable NixOS

@stale
Copy link

stale bot commented Apr 16, 2022

I marked this as stale due to inactivity. → More info

@stale stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Apr 16, 2022
@wolfgangwalther
Copy link
Contributor

Is this still relevant? If it is, it's probably more valuable to have this merged in master than hidden in this PR - even if still incomplete.

@stale stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Mar 4, 2024
Comment on lines +298 to +301
* On `master` and the release branch, update the `NEXT_NIXOS_RELEASE`
variable in `maintainers/scripts/haskell/regenerate-hackage-packages.sh`:
This value should always be the same as what the `.version` file at the
repository root of the `master` branch contains.
Copy link
Contributor

Choose a reason for hiding this comment

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

This variable doesn't exist in that file anymore.

them as a PR.

General information on the release process can be found in the
[NixOS Releaes Wiki](https://nixos.github.io/release-wiki/Release-Process-Walkthrough.html).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
[NixOS Releaes Wiki](https://nixos.github.io/release-wiki/Release-Process-Walkthrough.html).
[NixOS Release Wiki](https://nixos.github.io/release-wiki/Release-Process.html).

This value should always be the same as what the `.version` file at the
repository root of the `master` branch contains.

* On the release branch, run `maintainers/scripts/haskell/freeze-packages.sh`
Copy link
Contributor

Choose a reason for hiding this comment

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

This script doesn't exist anymore?


* Make sure the references to the stable release in the documentation are accurate.

* Document any steps forgotten here!
Copy link
Contributor

Choose a reason for hiding this comment

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

Any more ideas by now?

@maralorn
Copy link
Member

maralorn commented Mar 4, 2024

I think we never actually did what the docs say. So merging them without acting on that would be a lie.
A renewed push to make our stable-branch story better would of course be awesome.

@sternenseemann
Copy link
Member Author

This was an idea that was never implemented, see #138407.

@wegank wegank added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Mar 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md 6.topic: haskell
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants