Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
.git
.github
site/
scripts/
!scripts/package/
node_modules/
**/*/node_modules
packages/**/*/build
**/*.eslintcache
.pnp.*
.yarn/
dist/

.DS_Store
**/*.DS_Store
Expand All @@ -13,4 +18,5 @@ packages/**/*/build
**/*.env.test.local
**/*.env.production.local

.venv
.venv
venv
1 change: 0 additions & 1 deletion .eslintignore

This file was deleted.

51 changes: 0 additions & 51 deletions .eslintrc.json

This file was deleted.

78 changes: 78 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
name: "CodeQL Advanced"

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
schedule:
- cron: '42 10 * * 1'

jobs:
analyze:
name: Analyze (${{ matrix.language }})
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
permissions:
# required for all workflows
security-events: write

# required to fetch internal or private CodeQL packs
packages: read

# only required for workflows in private repositories
actions: read
contents: read

strategy:
fail-fast: false
matrix:
include:
- language: actions
build-mode: none
- language: go
build-mode: autobuild
- language: javascript-typescript
build-mode: none
steps:
- name: Checkout repository
uses: actions/checkout@v4

# Add any setup steps before running the `github/codeql-action/init` action.
# This includes steps like installing compilers or runtimes (`actions/setup-node`
# or others). This is typically only required for manual builds.
# - name: Setup runtime (example)
# uses: actions/setup-example@v1

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v4
with:
languages: ${{ matrix.language }}
build-mode: ${{ matrix.build-mode }}
# Ignore generated code
config: |
paths-ignore:
- docs/content/explorer/build
- docs/content/graphql/explorer/build

# If the analyze step fails for one of the languages you are analyzing with
# "We were unable to automatically build your code", modify the matrix above
# to set the build mode to "manual" for that language. Then modify this step
# to build your code.
# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
- name: Run manual build steps
if: matrix.build-mode == 'manual'
shell: bash
run: |
echo 'If you are using a "manual" build mode for one or more of the' \
'languages you are analyzing, replace this with the commands to build' \
'your code, for example:'
echo ' make bootstrap'
echo ' make release'
exit 1

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v4
with:
category: "/language:${{matrix.language}}"
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,15 @@
**/*/node_modules
**/*/.pnp
.pnp.js
.pnp.*
.yarn/

# testing
/coverage
**/*/coverage

/dist

# production
/packages/**/*/build

Expand All @@ -34,3 +38,4 @@
**/*.eslintcache

.venv
venv
1 change: 1 addition & 0 deletions .yarnrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
nodeLinker: node-modules
6 changes: 3 additions & 3 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#-------------------------------------------------------------------------------
# Builder container for reproducible build environment

FROM python:3.12-alpine AS builder
FROM python:3.14-alpine AS builder

WORKDIR /usr/src/app
COPY ./docs /usr/src/app/build-temp/api-docs/docs
Expand All @@ -23,7 +23,7 @@ RUN cd /usr/src/app/build-temp/api-docs \
#-------------------------------------------------------------------------------
# Builder container for reproducible build environment

FROM golang:1.23-alpine AS go-builder
FROM golang:1.25-alpine AS go-builder

WORKDIR /go/src/app

Expand All @@ -39,7 +39,7 @@ RUN go mod verify \
#-------------------------------------------------------------------------------
# Build production container with only necessary artifacts

FROM alpine:3.20
FROM alpine:3.23

EXPOSE 3020

Expand Down
17 changes: 17 additions & 0 deletions build.Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
FROM node:24.13-alpine

ARG YARN_VERSION

RUN apk add --no-cache git python3 py3-setuptools make g++ \
build-base cairo-dev pango-dev giflib-dev
RUN corepack enable && corepack prepare yarn@${YARN_VERSION} --activate

WORKDIR /app
COPY packages ./packages
COPY scripts/package/docker-copy-dist.sh ./scripts/package/docker-copy-dist.sh
COPY .yarnrc.yml ./.yarnrc.yml
COPY package.json ./package.json
COPY yarn.lock ./yarn.lock
RUN yarn run ci
RUN cd packages/docs-app-graphiql && yarn run build
RUN cd packages/docs-app-swagger && yarn run build
22 changes: 15 additions & 7 deletions docs/content/contributing/building.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,23 @@ The docs project consists of two main components:
### **Requirements**

- MkDocs Project development
- Python 3.7+
- Python 3.12+
- Pip, package manager for Python
- React application development
- Node.js LTS version
- Yarn - [Installation info](https://yarnpkg.com/en/docs/install)
- React application development.
- Node.js LTS version 24
- Yarn 4.12 - [Installation info](https://yarnpkg.com/getting-started/install)
- Docker

### **MkDocs**

!!! note
It is highly recommended to utilize a virtual environment.

To initialize a fresh install of required packages / upgrade packages:
``` bash
pip install mkdocs-material mkdocs-exclude mkdocs-minify-plugin mkdocs-redirects
```

To build the MkDocs project, first install the python dependencies using pip:
``` bash
pip install -r requirements.txt
Expand Down Expand Up @@ -49,7 +57,7 @@ Apps:
To build the React applications, first install packages from the `yarn.lock` file:
``` bash
# From the project root directory
yarn ci
yarn run ci
```
To install or synchronize new or updated packages ascross all projects, utilize
the install command:
Expand All @@ -65,7 +73,7 @@ running the application.
Once application development is complete, to integrate into the existing MkDocs
project, utilize the scripts in the `package.json` file:
``` bash
yarn run build:clean-deploy
npm run build:docker
```

!!! note
Expand All @@ -83,6 +91,6 @@ script for running the container:
``` bash
./scripts/docker.run.sh
```
You should now have an instance running at: `localhost:3200/data-api/`
You should now have an instance running at: `localhost:3020/data-api/`

<br/>
13 changes: 0 additions & 13 deletions docs/content/explorer/build/asset-manifest.json

This file was deleted.

1 change: 1 addition & 0 deletions docs/content/explorer/build/assets/index-DsD0Z-UC.css

Large diffs are not rendered by default.

265 changes: 265 additions & 0 deletions docs/content/explorer/build/assets/index-Dw8Byc7A.js

Large diffs are not rendered by default.

24 changes: 23 additions & 1 deletion docs/content/explorer/build/index.html
Original file line number Diff line number Diff line change
@@ -1 +1,23 @@
<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="./favicon.ico"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="NEON Data API REST Explorer"/><link rel="manifest" href="./manifest.json"/><link href="https://fonts.gstatic.com" rel="preconnect" crossorigin=""><link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,400,400i,700%7CRoboto+Mono&amp;display=fallback"><title>NEON Data API REST Explorer</title><script defer="defer" src="./static/js/main.240f2395.js"></script><link href="./static/css/main.ab959d79.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<link rel="icon" href="./favicon.ico" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="theme-color" content="#000000" />
<meta
name="description"
content="NEON Data API REST Explorer"
/>
<link rel="manifest" href="./manifest.json" />
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin="">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,400,400i,700%7CRoboto+Mono&amp;display=fallback">
<title>NEON Data API REST Explorer</title>
<script type="module" crossorigin src="./assets/index-Dw8Byc7A.js"></script>
<link rel="stylesheet" crossorigin href="./assets/index-DsD0Z-UC.css">
</head>
<body>
<noscript>You need to enable JavaScript to run this app.</noscript>
<div id="root"></div>
</body>
</html>
2 changes: 0 additions & 2 deletions docs/content/explorer/build/static/css/main.ab959d79.css

This file was deleted.

This file was deleted.

3 changes: 0 additions & 3 deletions docs/content/explorer/build/static/js/main.240f2395.js

This file was deleted.

Loading