🚀 Doc & CI Boost — Ranking Optimization #113
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| name: CI Boost — Quality Gate | ||
| on: | ||
| push: | ||
| branches: [main, master] | ||
| pull_request: | ||
| branches: [main, master] | ||
|
|
||
| jobs: | ||
| quality: | ||
| runs-on: ubuntu-latest | ||
| strategy: | ||
| matrix: | ||
| node-version: [18, 20, 22] | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: ${{ matrix.node-version }} | ||
| cache: 'npm' | ||
|
|
||
| - name: Install dependencies | ||
| run: npm ci || npm install | ||
|
Comment on lines
+22
to
+23
There was a problem hiding this comment. 🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win 🧩 Analysis chain🏁 Script executed: #!/bin/bash
set -e
printf '%s\n' '--- workflow ---'
cat -n .github/workflows/ci-boost.yml
printf '%s\n' '--- lockfiles and package metadata ---'
git ls-files '*package*.json' '*package*.lock' | sort
for f in $(git ls-files '*package*.json' '*package*.lock' | sort); do
printf '\n--- %s ---\n' "$f"
sed -n '1,220p' "$f"
done
printf '%s\n' '--- npm configuration references ---'
rg -n 'npm ci|npm install|package-lock|ci-boost' .github package.json package-lock.json 2>/dev/null || trueRepository: Flamki/stellarmind Length of output: 12655 🏁 Script executed: #!/bin/bash
set -e
python3 - <<'PY'
import json
from pathlib import Path
pkg = json.loads(Path("package.json").read_text())
lock = json.loads(Path("package-lock.json").read_text())
root = lock["packages"][""]
checks = {
"lockfileVersion": lock.get("lockfileVersion"),
"package_name_matches": pkg.get("name") == root.get("name"),
"package_version_matches": pkg.get("version") == root.get("version"),
"dependencies_match": pkg.get("dependencies", {}) == root.get("dependencies", {}),
"devDependencies_match": pkg.get("devDependencies", {}) == root.get("devDependencies", {}),
"root_has_integrity_entries": all(
isinstance(v, dict) and "version" in v and "resolved" in v and "integrity" in v
for k, v in lock["packages"].items()
if k.startswith("node_modules/")
),
}
for key, value in checks.items():
print(f"{key}: {value}")
PYRepository: Flamki/stellarmind Length of output: 318 🌐 Web query:
💡 Result: The npm documentation distinguishes between npm install and npm ci based on their intended use cases, handling of lockfiles, and behavior during dependency mismatches [1][2]. npm install npm install is the standard command for installing dependencies in a project [2]. It respects existing package-lock.json or npm-shrinkwrap.json files, using them to ensure the installed dependency tree matches the one defined in the lockfile, provided the versions remain compatible with the ranges specified in package.json [3][4]. If there is a mismatch between package.json and package-lock.json, or if you add new dependencies, npm install will resolve the dependencies and update the package-lock.json file to reflect the new state [3][5]. It is designed for interactive development and general project management [3]. npm ci npm ci is designed for automated environments such as continuous integration (CI) and deployment pipelines, or whenever a clean, consistent install is required [1][6]. It has specific, strict behaviors: - Requirement: The project must have an existing package-lock.json or npm-shrinkwrap.json file [1][7]. - Mismatch Behavior: If the dependencies in the lockfile do not exactly match those in package.json, npm ci will exit with an error rather than updating the lockfile [1][6]. - Immutability: It never modifies package.json or any lockfile [1][7]. - Clean Slate: It automatically deletes any existing node_modules folder before proceeding with the installation [1][6]. In summary, use npm install when you are actively developing and expect the lockfile to be updated, and use npm ci in automated environments where you require a strictly reproducible, read-only build [1][3]. Top Results: [1] https://docs.npmjs.com/cli/v11/commands/npm-ci/ [2] https://docs.npmjs.com/cli/v11/commands/npm-install/ [3] https://www.baeldung.com/ops/npm-install-vs-npm-ci [8] https://docs.npmjs.com/cli/v11/configuring-npm/package-lock-json/ [5] https://docs.npmjs.com/cli/v7/commands/npm-install/ Citations:
Run If Apply this change at both installation steps. 🤖 Prompt for AI Agents |
||
|
|
||
| - name: Lint | ||
| run: npm run lint --if-present || npx eslint . --ext .js,.ts,.tsx --if-present || echo "No lint configured" | ||
|
|
||
| - name: Type check | ||
| run: npm run typecheck --if-present || npx tsc --noEmit --if-present || echo "No typecheck configured" | ||
|
|
||
| - name: Test | ||
| run: npm test --if-present || npx jest --passWithNoTests --if-present || echo "No tests configured" | ||
|
|
||
| - name: Build | ||
| run: npm run build --if-present || echo "No build step" | ||
|
Comment on lines
+25
to
+35
There was a problem hiding this comment. 🎯 Functional Correctness | 🟠 Major | ⚡ Quick win 🧩 Analysis chain🏁 Script executed: #!/bin/bash
set -euo pipefail
jq -r '.scripts // {} | keys[]' package.json
rg -n -- 'npm run .*--if-present|npx .*--if-present|\|\| echo' .github/workflows/ci-boost.ymlRepository: Flamki/stellarmind Length of output: 864 🏁 Script executed: #!/bin/bash
set -euo pipefail
printf '%s\n' '--- workflow ---'
cat -n .github/workflows/ci-boost.yml
printf '%s\n' '--- package scripts ---'
node - <<'JS'
const fs = require('fs');
const pkg = JSON.parse(fs.readFileSync('package.json', 'utf8'));
console.log(JSON.stringify(pkg.scripts ?? {}, null, 2));
JS
printf '%s\n' '--- package manager metadata ---'
rg -n '"(packageManager|npm|eslint|typescript|jest|vitest|test|lint|build|typecheck)"' package.json package-lock.json 2>/dev/null || true
printf '%s\n' '--- workflow failure-tolerance settings ---'
rg -n -- 'continue-on-error|if:|npm run .*--if-present|npm test .*--if-present|npx .*--if-present|\|\| echo' .github/workflows/ci-boost.ymlRepository: Flamki/stellarmind Length of output: 4368 🏁 Script executed: #!/bin/bash
set -euo pipefail
python3 - <<'PY'
import json
import re
from pathlib import Path
workflow = Path(".github/workflows/ci-boost.yml").read_text()
package = json.loads(Path("package.json").read_text())
scripts = package.get("scripts", {})
checks = {
"lint": "lint" in scripts,
"typecheck": "typecheck" in scripts,
"test": "test" in scripts,
"build": "build" in scripts,
}
print("script presence:", checks)
for line_no, line in enumerate(workflow.splitlines(), 1):
if re.search(r"^\s*run:.*(?:npm run|npm test|npx ).*\|\|", line):
print(f"failure-tolerant quality command at line {line_no}: {line.strip()}")
print("quality scripts:", {name: scripts.get(name) for name in ("lint", "typecheck", "test", "build")})
PY
printf '%s\n' '--- npm option semantics ---'
npm --version
npm run --help | rg -n -- '--if-present|if-present' || true
npm exec --help | rg -n -- '--if-present|if-present' || trueRepository: Flamki/stellarmind Length of output: 1618 Make configured quality checks fail the job. The 🧰 Tools🪛 zizmor (1.29.0)[warning] 9-35: overly broad permissions (excessive-permissions): default permissions used due to no permissions: block (excessive-permissions) 🤖 Prompt for AI Agents |
||
|
|
||
| security: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 20 | ||
| - run: npm ci || npm install | ||
| - name: Audit | ||
| run: npm audit --audit-level=moderate || echo "Audit warnings found" | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,201 +1,63 @@ | ||
| # Contributing to stellarmind | ||
|
|
||
| ## Welcome! | ||
| We're thrilled you want to contribute! This guide will help you get started. | ||
|
|
||
| ## Code of Conduct | ||
| This project adheres to a [Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you agree to uphold its standards. | ||
|
There was a problem hiding this comment. 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win 🧩 Analysis chain🏁 Script executed: #!/bin/bash
set -euo pipefail
test -f CODE_OF_CONDUCT.mdRepository: Flamki/stellarmind Length of output: 156 🏁 Script executed: set -euo pipefail
printf '%s\n' 'Tracked Code of Conduct files:'
git ls-files | grep -iE '(^|/)CODE_OF_CONDUCT\.md$|(^|/)code.of.conduct' || true
printf '%s\n' 'Relevant CONTRIBUTING.md link:'
rg -n -C 2 'Code of Conduct|CODE_OF_CONDUCT' CONTRIBUTING.mdRepository: Flamki/stellarmind Length of output: 469 Fix the broken Code of Conduct link.
🤖 Prompt for AI Agents |
||
|
|
||
| ## How to Contribute | ||
|
|
||
|
Comment on lines
+9
to
10
There was a problem hiding this comment. 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win Add issue-reporting guidance or remove the README claim.
🤖 Prompt for AI Agents |
||
| ### 1. Fork and Clone | ||
| ```bash | ||
| git clone https://github.com/YOUR_USERNAME/stellarmind.git | ||
| cd stellarmind | ||
| ``` | ||
|
Comment on lines
+11
to
15
There was a problem hiding this comment. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win Make the clone step executable as written.
Proposed clarification ### 1. Fork and Clone
+Fork the repository on GitHub, then replace `<your-username>` with your fork owner.
```bash
-git clone https://github.com/YOUR_USERNAME/stellarmind.git
+git clone https://github.com/<your-username>/stellarmind.git
cd stellarmind🤖 Prompt for AI Agents |
||
|
|
||
| ### 2. Set Up Development Environment | ||
| ```bash | ||
| npm install | ||
| ``` | ||
|
|
||
| ### 3. Create a Feature Branch | ||
| ```bash | ||
| git checkout -b feat/my-awesome-feature | ||
| ``` | ||
|
|
||
| ### 4. Make Your Changes | ||
| - Write clean, readable code | ||
| - Add tests for new functionality | ||
| - Update documentation as needed | ||
|
|
||
| ### 5. Commit | ||
| ```bash | ||
| git commit -m "feat: add my awesome feature" | ||
| ``` | ||
|
|
||
| ### 6. Push and Create PR | ||
| ```bash | ||
| git push origin feat/my-awesome-feature | ||
| ``` | ||
| Then open a Pull Request on GitHub. | ||
|
|
||
| ## Commit Convention | ||
| We use conventional commits: | ||
| - `feat:` New feature | ||
| - `fix:` Bug fix | ||
| - `docs:` Documentation changes | ||
| - `ci:` CI/CD pipeline changes | ||
| - `refactor:` Code restructuring | ||
| - `test:` Test additions or fixes | ||
| - `chore:` Maintenance tasks | ||
|
|
||
| ## Code Style | ||
| - Follow existing code patterns | ||
| - Use meaningful variable names | ||
| - Keep functions small and focused | ||
| - Comment complex logic | ||
|
|
||
| ## Review Process | ||
| 1. All PRs require at least one review | ||
| 2. CI must pass before merging | ||
| 3. Address review feedback promptly | ||
| 4. Squash and merge when approved | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔒 Security & Privacy | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
Repository: Flamki/stellarmind
Length of output: 3064
Restrict token permissions and disable checkout credential persistence.
Add top-level
permissions: contents: read. Setpersist-credentials: falseon bothactions/checkout@v4steps. Repository commands can otherwise access the persistedGITHUB_TOKEN, whose default permissions may exceed checkout requirements.🤖 Prompt for AI Agents
Source: Linters/SAST tools