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

doc: add section on swift #214612

Merged
merged 1 commit into from
Feb 6, 2023
Merged

doc: add section on swift #214612

merged 1 commit into from
Feb 6, 2023

Conversation

stephank
Copy link
Contributor

@stephank stephank commented Feb 4, 2023

Description of changes

A first take on documentation for Swift packaging.

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, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 23.05 Release Notes (or backporting 22.11 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
    • (Release notes changes) Ran nixos/doc/manual/md-to-db.sh to update generated release notes
  • Fits CONTRIBUTING.md.

@stephank
Copy link
Contributor Author

stephank commented Feb 5, 2023

Not sure who to ping for this, maybe @trepetti or @NixOS/documentation-team?

@domenkozar
Copy link
Member

Having these docs is much better than the current state, so I'm merging.

@domenkozar domenkozar merged commit 3b83771 into NixOS:master Feb 6, 2023
@stephank stephank deleted the feat/swift-docs branch February 6, 2023 17:16
@fricklerhandwerk
Copy link
Contributor

fricklerhandwerk commented Feb 7, 2023

Reviewed it after the fact, since I was on vacation. @stephank Awesome work, thanks a lot! @figsoda is this template amenable to be added to nix-init?

@figsoda
Copy link
Member

figsoda commented Feb 7, 2023

nix-init currently doesn't have support for multiple files, so the most it can do atm would be to recognize Package.swift and generate a plain-text-ish template without the dependencies

feel free to create an issue or pull request there

@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/tweag-nix-dev-update-44/25546/1

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.

5 participants