Skip to content

Updating backend dev command - #196

Merged
JonnyTran merged 1 commit into
Extralit:developfrom
kyileiaye2021:docs/server-dev-command
Mar 1, 2026
Merged

JonnyTran merged 1 commit into
Extralit:developfrom
kyileiaye2021:docs/server-dev-command

Conversation

@kyileiaye2021

Copy link
Copy Markdown
Contributor

Description

Updates the development instructions in README.md to use pdm run server-dev instead of pdm run dev when running the backend server.

This aligns the README with the existing project scripts and other documentation, and helps avoid confusion during local development setup.

Related Tickets & Documents

Closes #195

What type of PR is this? (check all applicable)

  • Refactor
  • Feature
  • Bug Fix
  • Optimization
  • Documentation Update

Steps to QA

Added/updated tests?

  • Yes
  • No, and this is why: please replace this line with details on why tests
    have not been included
  • I need help with writing tests

Added/updated documentations?

  • Yes
  • No, and this is why: please replace this line with details on why tests
    have not been included
  • I need help with writing docs

Checklist

@JonnyTran

Copy link
Copy Markdown
Member

Thanks @kyileiaye2021 !

@JonnyTran
JonnyTran merged commit 6672dd6 into Extralit:develop Mar 1, 2026
JonnyTran added a commit that referenced this pull request Sep 16, 2026
Adds a top-level `permissions: contents: read` to the three workflows that had
none, and moves the write scopes in github-release, extralit.docs and extralit
onto the single job that actually needs them.

Closes code scanning alerts #176, #196, #252, #253, #313, #314.
JonnyTran added a commit that referenced this pull request Sep 16, 2026
* ci(server): give the docker build a registry layer cache

`cache-from`/`cache-to` were unset, so every CI build refetched the 231 MB lance
extension and re-ran both apt layers from scratch. None of the layer ordering in
the Dockerfile bought anything on CI.

Registry cache rather than `type=gha`: the image is ~1.9 GB, and `mode=max` on it
would churn through the 10 GB Actions cache quota. The cache tag follows
`SERVER_DOCKER_IMAGE`, so dev and release caches never mix — and neither do their
platform sets. `image-manifest=true,oci-mediatypes=true` is what Docker Hub will
accept for the cache manifest.

PR previews read the cache but do not write it: they push from divergent trees and
would only evict trunk's entries. The `latest` push rebuilds the same context, so
it reads the cache and does not re-export it.

* ci: give GITHUB_TOKEN read-only defaults

Adds a top-level `permissions: contents: read` to the three workflows that had
none, and moves the write scopes in github-release, extralit.docs and extralit
onto the single job that actually needs them.

Closes code scanning alerts #176, #196, #252, #253, #313, #314.

* ci(server): compute the build env with expressions, not bash

The 40-line if/else only ever branched on `inputs`, so it moves to a job-level
`env:` block. What's left in shell is IMAGE_TAG, the one value that reads an
earlier step's output. Docker Hub creds go straight to the login step instead of
through GITHUB_ENV.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS] Updating backend dev command

2 participants