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

nixos/doc/release-process: remove #107140

Closed

Conversation

jonringer
Copy link
Contributor

@jonringer jonringer commented Dec 18, 2020

Motivation for this change

The related documentation on the release process has moved
to https://github.com/NixOS/release-wiki

Doesn't make sense to export the release process to users.

cc @worldofpeace

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs 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/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

@jonringer
Copy link
Contributor Author

bump, @worldofpeace

@jtojnar
Copy link
Contributor

jtojnar commented Jan 6, 2021

Would it make sense to al least link the wiki in the manual?

@jonringer
Copy link
Contributor Author

It would, let me add that

@jonringer jonringer force-pushed the remove-release-process-manual branch from b383f4d to f4ff261 Compare January 12, 2021 03:55
@jonringer
Copy link
Contributor Author

done

@@ -8,359 +8,9 @@
<title>Release process</title>

<para>
Going through an example of releasing NixOS 19.09:
This section has been moved to <link xlink:href="https://github.com/NixOS/release-wiki">the release wiki</link>.
Copy link
Contributor

Choose a reason for hiding this comment

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

It doesn't make sense to link it to the wiki like this. Instead there needs to be a section explaining the how and why of the release process, and then say "If you're interested in how a NixOS release actually happens please see https://nixos.github.io/release-wiki/` and that's the rendered link. Speaking of which the github action is failing there.

Edit: should be fixed now

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 wouldn't really expect for the release process to be there in the first place. I think this mostly benefits people who are used to it being there.

New users will probably find it confusing that it's mentioned at all.

@stale
Copy link

stale bot commented Jul 11, 2021

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 Jul 11, 2021
@siraben
Copy link
Member

siraben commented Jan 8, 2022

Any updates on this? Looks like it's a good idea to remove unnecessary info about release process in the manual.

@stale stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jan 8, 2022
@jonringer
Copy link
Contributor Author

let me deal with conflicts

@jonringer
Copy link
Contributor Author

Nevermind. This is a duplicate of #124418 now. closing

@jonringer jonringer closed this Jan 8, 2022
@jonringer jonringer deleted the remove-release-process-manual branch January 8, 2022 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants