zishuo/rtsp-simple-server
1
0
Fork 0
mirror of https://github.com/aler9/rtsp-simple-server synced 2025-09-26 19:51:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: add linter (#4945)

Browse Source
This commit is contained in:
Alessandro Ros
2025-09-06 22:51:45 +02:00
committed by GitHub
parent 5f61395915
commit 3a4d4e1802
4 changed files with 48 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
.github/workflows/code_lint.yml vendored
View File

@@ -7,7 +7,7 @@ on:
branches: [ main ] branches: [ main ]
jobs: jobs:
golangci_lint: go:
runs-on: ubuntu-22.04 runs-on: ubuntu-22.04
steps: steps:
@@ -25,7 +25,7 @@ jobs:
with: with:
version: v2.4.0 version: v2.4.0
mod_tidy: go_mod:
runs-on: ubuntu-22.04 runs-on: ubuntu-22.04
steps: steps:
@@ -35,7 +35,15 @@ jobs:
with: with:
go-version: "1.24" go-version: "1.24"
- run: make lint-mod-tidy - run: make lint-go-mod
docs:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v5
- run: make lint-docs
api_docs: api_docs:
runs-on: ubuntu-22.04 runs-on: ubuntu-22.04
@@ -43,4 +51,4 @@ jobs:
steps: steps:
- uses: actions/checkout@v5 - uses: actions/checkout@v5
- run: make lint-apidocs - run: make lint-api-docs

4
Makefile
View File

@@ -1,5 +1,5 @@
BASE_IMAGE = golang:1.24-alpine3.20 BASE_IMAGE = golang:1.24-alpine3.20
LINT_IMAGE = golangci/golangci-lint:v2.4.0 GOLANGCI_LINT_IMAGE = golangci/golangci-lint:v2.4.0
NODE_IMAGE = node:20-alpine3.20 NODE_IMAGE = node:20-alpine3.20
.PHONY: $(shell ls) .PHONY: $(shell ls)
@@ -9,7 +9,7 @@ help:
@echo "" @echo ""
@echo "available actions:" @echo "available actions:"
@echo "" @echo ""
@echo " format format source files" @echo " format format code"
@echo " test run tests" @echo " test run tests"
@echo " test-32 run tests on a 32-bit system" @echo " test-32 run tests on a 32-bit system"
@echo " test-e2e run end-to-end tests" @echo " test-e2e run end-to-end tests"

28
docs/1-kickoff/1-introduction.md
View File

@@ -6,19 +6,19 @@ MediaMTX is a ready-to-use and zero-dependency live media server and media proxy
Main features: Main features:
* [Publish](/docs/usage/publish) live streams to the server with SRT, WebRTC, RTSP, RTMP, HLS, MPEG-TS, RTP - [Publish](/docs/usage/publish) live streams to the server with SRT, WebRTC, RTSP, RTMP, HLS, MPEG-TS, RTP
* [Read](/docs/usage/read) live streams from the server with SRT, WebRTC, RTSP, RTMP, HLS - [Read](/docs/usage/read) live streams from the server with SRT, WebRTC, RTSP, RTMP, HLS
* Streams are automatically converted from a protocol to another - Streams are automatically converted from a protocol to another
* Serve several streams at once in separate paths - Serve several streams at once in separate paths
* [Record](/docs/usage/record) streams to disk in fMP4 or MPEG-TS format - [Record](/docs/usage/record) streams to disk in fMP4 or MPEG-TS format
* [Playback](/docs/usage/playback) recorded streams - [Playback](/docs/usage/playback) recorded streams
* [Authenticate](/docs/usage/authentication) users with internal, HTTP or JWT authentication - [Authenticate](/docs/usage/authentication) users with internal, HTTP or JWT authentication
* [Forward](/docs/usage/forward) streams to other servers - [Forward](/docs/usage/forward) streams to other servers
* [Proxy](/docs/usage/proxy) requests to other servers - [Proxy](/docs/usage/proxy) requests to other servers
* [Control](/docs/usage/control-api) the server through the Control API - [Control](/docs/usage/control-api) the server through the Control API
* Reload the configuration without disconnecting existing clients (hot reloading) - Reload the configuration without disconnecting existing clients (hot reloading)
* [Monitor](/docs/usage/metrics) the server through Prometheus-compatible metrics - [Monitor](/docs/usage/metrics) the server through Prometheus-compatible metrics
* [Run hooks](/docs/usage/hooks) (external commands) when clients connect, disconnect, read or publish streams - [Run hooks](/docs/usage/hooks) (external commands) when clients connect, disconnect, read or publish streams
* Compatible with Linux, Windows and macOS, does not require any dependency or interpreter, it's a single executable - Compatible with Linux, Windows and macOS, does not require any dependency or interpreter, it's a single executable
Use the menu to navigate through the documentation. Use the menu to navigate through the documentation.

28
scripts/lint.mk
View File

@@ -1,21 +1,33 @@
define DOCKERFILE_APIDOCS_LINT define DOCKERFILE_DOCS_LINT
FROM $(NODE_IMAGE)
RUN yarn global add prettier@3.6.2
endef
export DOCKERFILE_DOCS_LINT
define DOCKERFILE_API_DOCS_LINT
FROM $(NODE_IMAGE) FROM $(NODE_IMAGE)
RUN yarn global add @redocly/cli@1.0.0-beta.123 RUN yarn global add @redocly/cli@1.0.0-beta.123
endef endef
export DOCKERFILE_APIDOCS_LINT export DOCKERFILE_API_DOCS_LINT
lint-golangci: lint-go:
docker run --rm -v "$(shell pwd):/app" -w /app \ docker run --rm -v "$(shell pwd):/app" -w /app \
$(LINT_IMAGE) \ $(GOLANGCI_LINT_IMAGE) \
golangci-lint run -v golangci-lint run -v
lint-mod-tidy: lint-go-mod:
go mod tidy go mod tidy
git diff --exit-code git diff --exit-code
lint-apidocs: lint-docs:
echo "$$DOCKERFILE_APIDOCS_LINT" | docker build . -f - -t temp echo "$$DOCKERFILE_DOCS_LINT" | docker build . -f - -t temp
docker run --rm -v "$(shell pwd)/docs:/s" -w /s temp \
sh -c "prettier --write ."
git diff --exit-code
lint-api-docs:
echo "$$DOCKERFILE_API_DOCS_LINT" | docker build . -f - -t temp
docker run --rm -v "$(shell pwd)/api:/s" -w /s temp \ docker run --rm -v "$(shell pwd)/api:/s" -w /s temp \
sh -c "openapi lint openapi.yaml" sh -c "openapi lint openapi.yaml"
lint: lint-golangci lint-mod-tidy lint-apidocs lint: lint-go lint-go-mod lint-docs lint-api-docs