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/archtika: init at 1.0.1 #365218

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Conversation

thiloho
Copy link

@thiloho thiloho commented Dec 14, 2024

This PR adds the archtika package and its NixOS module.

archtika is a modern Content Management System (CMS) designed for the creation and management of documentation and blog websites. It focuses on simplicity, performance and maintainability, while providing essential features for content creators, such as:

  • Easy website creation with predefined templates
  • Markdown support with live preview
  • Collaboration features
  • Storage management
  • Change tracking
  • Automatic static site generation

Homepage: https://archtika.com
Repository: https://github.com/archtika/archtika

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • 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/)
  • 25.05 Release Notes (or backporting 24.11 and 25.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.

Add a 👍 reaction to pull requests you find important.

@github-actions github-actions bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: documentation This PR adds or changes documentation 8.has: changelog 8.has: module (update) This PR changes an existing module in `nixos/` 8.has: maintainer-list (update) This PR changes `maintainers/maintainer-list.nix` labels Dec 14, 2024
@NixOSInfra NixOSInfra added the 12. first-time contribution This PR is the author's first one; please be gentle! label Dec 14, 2024
@thiloho
Copy link
Author

thiloho commented Dec 14, 2024

Some improvements can be made, such as avoiding the with expressions (https://nix.dev/guides/best-practices#with-scopes), possibly using recursiveUpdate (https://nix.dev/guides/best-practices#updating-nested-attribute-sets) and other nitpicks.

I will look into this.

Copy link
Contributor

@SigmaSquadron SigmaSquadron left a comment

Choose a reason for hiding this comment

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

It's always great to see someone's first contribution is a massive NixOS module. Great work on this!

The following commits should be squashed:

  • archtika: fix allow-import-from-derivation error for npmarchtika: init at 1.0.1
  • nixos/manual: add archtika module to 25.05 release notes nixos/archtika: init module
  • archtika: fix formatting, add module description, remove trailing whitespace and archtika: refactor package and module definitions ➜ Both the package and module commit, as appropriate.

nixos/modules/services/web-apps/archtika.nix Outdated Show resolved Hide resolved
nixos/modules/services/web-apps/archtika.nix Outdated Show resolved Hide resolved
nixos/modules/services/web-apps/archtika.nix Show resolved Hide resolved
nixos/modules/services/web-apps/archtika.nix Outdated Show resolved Hide resolved
nixos/modules/services/web-apps/archtika.nix Outdated Show resolved Hide resolved
nixos/modules/services/web-apps/archtika.nix Outdated Show resolved Hide resolved
nixos/modules/services/web-apps/archtika.nix Outdated Show resolved Hide resolved
nixos/modules/services/web-apps/archtika.nix Outdated Show resolved Hide resolved
nixos/modules/services/web-apps/archtika.nix Outdated Show resolved Hide resolved
pkgs/by-name/ar/archtika/package.nix Show resolved Hide resolved
@ofborg ofborg bot added 2.status: merge conflict This PR has merge conflicts with the target branch 8.has: package (new) This PR adds a new package 11.by: package-maintainer This PR was created by the maintainer of the package it changes 10.rebuild-darwin: 1 and removed 2.status: merge conflict This PR has merge conflicts with the target branch labels Dec 15, 2024
@thiloho thiloho force-pushed the archtika-pkg branch 3 times, most recently from c30931a to 855e916 Compare December 25, 2024 18:47
@nixos-discourse
Copy link

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

https://discourse.nixos.org/t/prs-already-reviewed/2617/2167

@thiloho
Copy link
Author

thiloho commented Dec 26, 2024

Hi @Lassulus , seeing that you recently merged another pull request (#365006), could you please check this one? As far as I can see it should be ready.

pkgs/by-name/ar/archtika/package.nix Outdated Show resolved Hide resolved
pkgs/by-name/ar/archtika/package.nix Outdated Show resolved Hide resolved
nixos/modules/services/web-apps/archtika.nix Outdated Show resolved Hide resolved
nixos/modules/services/web-apps/archtika.nix Outdated Show resolved Hide resolved
nixos/modules/services/web-apps/archtika.nix Outdated Show resolved Hide resolved
nixos/modules/services/web-apps/archtika.nix Outdated Show resolved Hide resolved
nixos/modules/services/web-apps/archtika.nix Outdated Show resolved Hide resolved
nixos/modules/services/web-apps/archtika.nix Outdated Show resolved Hide resolved
nixos/modules/services/web-apps/archtika.nix Outdated Show resolved Hide resolved
nixos/modules/services/web-apps/archtika.nix Outdated Show resolved Hide resolved
@thiloho
Copy link
Author

thiloho commented Jan 7, 2025

I have also tested all the functionality again using the given steps and using a local setup in the repository, see https://github.com/archtika/archtika/blob/main/nix/module.nix

@nixos-discourse
Copy link

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

https://discourse.nixos.org/t/prs-already-reviewed/2617/2188

@h7x4 h7x4 added the 8.has: module (new) This PR adds a module in `nixos/` label Jan 17, 2025
@sarahec
Copy link
Contributor

sarahec commented Jan 27, 2025

I think what @SigmaSquadron was suggesting is that you pull all the pieces into individual derivations as /pkgs/by-name/ar/archtika/{package,service,api,webapp}.nix then import them into package.nix with let web-app = callPackage ./webapp.nix {}. (You can override or add parameters to the call as needed.)

As you approach the finish line, there's some git cleanup to do:

  1. Merging master pulled in some extraneous information (did you mean to add two names to maintainers?). So let me walk you through the nixpkgs way (from CONTRIBUTING.md):
git checkout archtika-pkg
# Back out the merge
git reset --hard HEAD~1
# Rebase onto master, nixpkgs-style
git checkout master
git fetch upstream master
git checkout archtika-pkg
git rebase master
# Fix any merge conflicts before pushing
git push --force-with-lease
  1. The maintainers list update should only contain your entry. I think you picked up someone else's in merging master. Step 1 should have fixed that.

@thiloho
Copy link
Author

thiloho commented Jan 27, 2025

Thanks, yes, I can remove the last merge commit by force pushing, I just did that on GitHub to fix a merge conflict.

As for the individual derivations suggested earlier, there could be two other files, web-app.nix and api.nix, which would then be used via callPackage, but I doubt that it is really necessary to split those very few lines in the one package file.

I just wanted to mention this PR on Matrix again, as nothing has happened here for two weeks since I made the post in the already reviewed Discourse thread. And I think this should be ready to be merged.

@sarahec
Copy link
Contributor

sarahec commented Jan 27, 2025

Reviews seem to be taking longer than usual lately. The automation we usually see doesn't seem to be working and that may be increasing reviewers' workload.

Since you're on Discourse, try pinging Sandro with a PM.

archtika: fix allow-import-from-derivation error for npm

archtika: fix package formatting

archtika: refactor package

archtika: update GitHub hash for version 1.0.1

archtika: add auto update script

archtika: refactor package

archtika: update version to 1.1.0

archtika: update GitHub hash to version 1.1.0
nixos/manual: add archtika module to 25.05 release notes

nixos/archtika: fix module formatting, add description and remove trailing whitespace

nixos/archtika: refactor module

nixos/archtika: refactor module

nixos/archtika: make SystemCallFilter addition for postgres systemd service
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: changelog 8.has: documentation This PR adds or changes documentation 8.has: maintainer-list (update) This PR changes `maintainers/maintainer-list.nix` 8.has: module (new) This PR adds a module in `nixos/` 8.has: module (update) This PR changes an existing module in `nixos/` 8.has: package (new) This PR adds a new package 10.rebuild-darwin: 1-10 10.rebuild-darwin: 1 10.rebuild-linux: 1-10 11.by: package-maintainer This PR was created by the maintainer of the package it changes 12. first-time contribution This PR is the author's first one; please be gentle!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants