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.

Sign up for GitHub

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

Jump to bottom

nixos/gitlab: Update release notes and documentation #69313

Merged
merged 2 commits into from Sep 24, 2019
Merged

nixos/gitlab: Update release notes and documentation #69313

merged 2 commits into from Sep 24, 2019

Conversation

talyz
Copy link
Contributor

@talyz talyz commented Sep 23, 2019

Motivation for this change
  • Mention the switch from literal secrets to file-based ones in the release notes
  • Document the restriction imposed on services.gitlab.statePath in both its description and the release notes

This addresses issues raised in #68841 and #68972. This should be pulled into 19.09.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • 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 nix-review --run "nix-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.
Notify maintainers

cc @globin @flokli @aanderse @schneefux @mawis

@talyz
nixos/gitlab: Mention secret option transition in release notes
7e325c2 
Document the breaking secret option transition from literal secrets to
file-based ones.
@talyz
nixos/gitlab: Document the restriction introduced on statePath
dfc43f7 
The state path now, since the transition from initialization in
preStart to using systemd-tmpfiles, has the following restriction: no
parent directory can be owned by any other user than root or the user
specified in services.gitlab.user. This is a potentially breaking
change and the cause of the error isn't immediately obvious, so
document it both in the release notes and statePath description.
@veprbl veprbl added the 9.needs: port to stable A PR needs a backport to the stable release. label Sep 23, 2019
aanderse
aanderse approved these changes Sep 23, 2019
View reviewed changes
Copy link
Member

@aanderse aanderse left a comment

Choose a reason for hiding this comment

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

Thank you @talyz!

@flokli flokli merged commit e813eb2 into NixOS:master Sep 24, 2019
@flokli
Copy link
Contributor

flokli commented Sep 24, 2019

Backported to 19.09 in fbc7e7e and 74869e2.

@talyz talyz deleted the gitlab-documentation branch September 24, 2019 13:37
schneefux
schneefux reviewed Sep 24, 2019
View reviewed changes
Copy link
Contributor

@schneefux schneefux left a comment

Choose a reason for hiding this comment

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

👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@schneefux schneefux schneefux left review comments

@flokli flokli flokli approved these changes

@aanderse aanderse aanderse approved these changes

Assignees
No one assigned
Labels
6.topic: nixos 8.has: changelog 8.has: documentation 8.has: module (update) 9.needs: port to stable A PR needs a backport to the stable release. 10.rebuild-darwin: 0 10.rebuild-linux: 0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@talyz @flokli @aanderse @schneefux @veprbl