Skip to content

Commit 3e01f86

Browse files
address codeql comments and simplify root level config files (#136)
* chore: update dependencies * ci: improve checkout steps in ops workflow * chore: codeql linting * fix: update ci pre-commit checks to conditionally skip main branch protection when pushing to main branch * fix: update command for root dependency audit in security workflow * fix: simplify pre-commit checks command in validate workflow * refactor: move contribution guidelines, code of conduct, security policy; and renovate, codecov, and trivyignore config to .github dir to declutter root dir * chore: remove root level Python version file * refactor: update CITATION.cff with author emails and affiliations; remove codemeta.json * chore: remove auto-install-peers option from .npmrc * refactor: update justfile scripts for consistency and clarity; remove echo statements Co-authored-by: Copilot <copilot@github.com> * feat: move installation and self-hosting documentation from repo root to docs site * refactor: yml -> yaml where aligning with standard syntax * test(docs): replace visual regression tests with structural regression tests and ARIA snapshots * chore: update uvicorn version to 0.46.0 in uv.lock * refactor: align spacing in prod_compose definition for consistency * fix: address codeql
1 parent 5e13df2 commit 3e01f86

104 files changed

Lines changed: 720 additions & 520 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.cspell.yml renamed to .cspell.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ cache:
2121
useCache: true
2222
cacheStrategy: content
2323
ignorePaths:
24-
- .cspell.yml
24+
- .cspell.yaml
2525
- .cspellcache
2626
- .devcontainer
2727
- .dockerignore
2828
- .git
2929
- .gitignore
30-
- .trivyignore
30+
- .github/trivyignore
3131
- .vscode
3232
- package-lock.json
3333
- pnpm-lock.yaml
@@ -55,6 +55,7 @@ words:
5555
- shellcheck
5656
- subrepo
5757
- subrepos
58+
- tootallnate
5859
- trivyignores
5960
- trixie
6061
- tsvector

.devcontainer/backend/devcontainer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "relab-backend",
3-
"dockerComposeFile": ["../../compose.yml", "../../compose.dev.yml"],
3+
"dockerComposeFile": ["../../compose.yaml", "../../compose.dev.yaml"],
44
"service": "api",
55
"runServices": ["api", "redis", "postgres"],
66
"workspaceFolder": "/opt/relab/backend",

.devcontainer/devcontainer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "relab-fullstack",
3-
"dockerComposeFile": ["../compose.yml", "../compose.dev.yml"],
3+
"dockerComposeFile": ["../compose.yaml", "../compose.dev.yaml"],
44
"service": "app-site",
55
"runServices": ["api", "redis", "postgres", "docs-site", "web-site", "app-site"],
66
"workspaceFolder": "/opt/relab",

.devcontainer/docs/devcontainer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "relab-docs",
3-
"dockerComposeFile": ["../../compose.yml", "../../compose.dev.yml"],
3+
"dockerComposeFile": ["../../compose.yaml", "../../compose.dev.yaml"],
44
"service": "docs-site",
55
"runServices": ["docs-site"],
66
"workspaceFolder": "/opt/relab/docs",

.devcontainer/frontend-app/devcontainer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "relab-frontend-app",
3-
"dockerComposeFile": ["../../compose.yml", "../../compose.dev.yml"],
3+
"dockerComposeFile": ["../../compose.yaml", "../../compose.dev.yaml"],
44
"service": "app-site",
55
"runServices": ["app-site"],
66
"workspaceFolder": "/opt/relab/frontend-app",

.devcontainer/frontend-web/devcontainer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "relab-frontend-web",
3-
"dockerComposeFile": ["../../compose.yml", "../../compose.dev.yml"],
3+
"dockerComposeFile": ["../../compose.yaml", "../../compose.dev.yaml"],
44
"service": "web-site",
55
"runServices": ["web-site"],
66
"workspaceFolder": "/opt/relab/frontend-web",
File renamed without changes.

CONTRIBUTING.md renamed to .github/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Thanks for contributing. RELab is a research platform developed at CML, Leiden University. The goal of this document is simple: get you productive without making you dig through the repo first.
44

5-
This page is for code and documentation changes. If you mainly want to run or deploy the stack, use [INSTALL.md](INSTALL.md).
5+
This page is for code and documentation changes. If you mainly want to run or deploy the stack, see [Install & Self-Host](https://docs.cml-relab.org/architecture/install/).
66

77
## Start Here
88

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
blank_issues_enabled: false
22
contact_links:
33
- name: Contribution guide
4-
url: https://github.com/CMLPlatform/relab/blob/main/CONTRIBUTING.md
4+
url: https://github.com/CMLPlatform/relab/blob/main/.github/CONTRIBUTING.md
55
about: Read this first if you need repo conventions, setup help, or contribution guidance.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ _What problem does this solve or why is it worth merging?_
2323

2424
## Checklist
2525

26-
- [ ] I've read the [contributing guidelines](../CONTRIBUTING.md)
26+
- [ ] I've read the [contributing guidelines](CONTRIBUTING.md)
2727
- [ ] Code follows style guidelines and passes quality checks (`just ci`)
2828
- [ ] Unit tests added/updated and passing locally (`just test`)
2929
- [ ] Documentation updated (if applicable)

0 commit comments

Comments
 (0)