Improve ci (#3)

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @pavelzw

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly
+    groups:
+      dependencies:
+        patterns:
+          - "*"

.github/workflows/ci.yml

@@ -23,9 +23,12 @@ jobs:
         uses: actions/checkout@v4
       - name: Set up pixi
         uses: prefix-dev/setup-pixi@ba3bb36eb2066252b2363392b7739741bb777659
-      - name: Link packages
+      - name: Use local package
         run: |
-          mkdir -p ~/.local/share/typst/packages/preview/moderner-cv
-          ln -s $(pwd) ~/.local/share/typst/packages/preview/moderner-cv/0.1.0
+          sed -i 's/#import .*/#import "..\/lib.typ": */' template/example.typ
       - name: compile
         run: pixi run compile
+      - uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
+        with:
+          path: template/example.pdf
+          if-no-files-found: error

.github/workflows/update-lockfiles.yml

@@ -0,0 +1,36 @@
+name: Update lockfiles
+
+permissions:
+  contents: write
+  pull-requests: write
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: 0 5 1 * *
+
+jobs:
+  pixi-update:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
+      - name: Set up pixi
+        uses: prefix-dev/setup-pixi@ba3bb36eb2066252b2363392b7739741bb777659 # v0.8.1
+        with:
+          run-install: false
+      - name: Update lockfiles
+        run: |
+          set -euo pipefail
+          pixi update --json --no-install | pixi exec pixi-diff-to-markdown >> diff.md
+      - name: Create pull request
+        uses: peter-evans/create-pull-request@5e914681df9dc83aa4e4905692ca88beb2f9e91f # v7.0.5
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: Update pixi lockfile
+          title: Update pixi lockfile
+          body-path: diff.md
+          branch: update-pixi
+          base: main
+          labels: pixi
+          delete-branch: true
+          add-paths: pixi.lock

README.md

@@ -1,5 +1,16 @@
 # moderner-cv
 
+[![License][license-badge]][license]
+[![CI][ci-badge]][ci]
+[![Latest release][latest-release-badge]][typst-universe]
+
+[license-badge]: https://img.shields.io/github/license/pavelzw/moderner-cv?style=flat-square
+[license]: ./LICENSE
+[ci-badge]: https://img.shields.io/github/actions/workflow/status/pavelzw/moderner-cv/ci.yml?style=flat-square
+[ci]: https://github.com/pavelzw/moderner-cv/actions/
+[latest-release-badge]: https://img.shields.io/github/v/tag/pavelzw/moderner-cv?style=flat-square&label=latest&sort=semver
+[typst-universe]: https://typst.app/universe/package/moderner-cv
+
 This is a typst adaptation of LaTeX's [moderncv](https://github.com/moderncv/moderncv), a modern curriculum vitae class.
 
 ## Requirements
@@ -8,10 +19,20 @@ This template uses FontAwesome icons via the [fontawesome typst package](https:/
 In order to properly use it, you need to have fontawesome installed on your system or have typst configured (via `--font-path`) to use the fontawesome font files.
 You can download fontawesome [here](https://fontawesome.com/download).
 
+> [!TIP]
+> You can use typst in combination with [pixi](https://pixi.sh) to easily add fontawesome to your project and run it reproducibly anywhere.
+>
+> ```toml
+> [dependencies]
+> typst = ">=0.12.0"
+> typstyle = ">=0.12"
+> font-otf-fontawesome = "*"
+> ```
+
 ## Usage
 
 ```typst
-#import "@preview/moderner-cv:0.1.0": *
+#import "@preview/moderner-cv:0.1.1": *
 
 #show: moderner-cv.with(
   name: "Jane Doe",
@@ -20,6 +41,9 @@ You can download fontawesome [here](https://fontawesome.com/download).
     email: "jane.doe@example.com",
     github: "jane-doe",
     linkedin: "jane-doe",
+    // custom socials: (icon, link, body)
+    // any fontawesome icon can be used: https://fontawesome.com/search
+    website: ("link", "https://example.me", "example.me"),
   ),
 )
 
@@ -33,14 +57,4 @@ You can download fontawesome [here](https://fontawesome.com/download).
 ## Building and Testing Locally
 
 To build and test the template locally, you can run `pixi run watch` in the root of this repository.
-Please ensure to have linked this package to your local typst packages, see [here](https://github.com/typst/packages#local-packages):
-
-```bash
-# linux
-mkdir -p ~/.local/share/typst/packages/preview/moderner-cv
-ln -s $(pwd) ~/.local/share/typst/packages/preview/moderner-cv/0.1.0
-
-# macos
-mkdir -p ~/Library/Application\ Support/typst/packages/preview/moderner-cv
-ln -s $(pwd) ~/Library/Application\ Support/typst/packages/preview/moderner-cv/0.1.0
-```
+Please ensure to use the version of moderner-cv that is in this repository instead of the one on the typst universe by temporarily changing the import in [`example.typ`](./template/example.typ) to `#import "../lib.typ": *`.