Skip to content

docs: update documentation for Node.js compatibility issues #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
keito4 merged 1 commit into from
Dec 15, 2025
Merged

docs: update documentation for Node.js compatibility issues #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions .devcontainer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,19 @@ On container startup, the following configurations are automatically applied:
- **Security**: 1Password CLI, credential management tools
- **Quality Tools**: ESLint, Prettier, Husky, commitlint

### Known Issues

#### Node.js Version Compatibility

**Current Status**: The container currently uses Node.js v20.x, but some dependencies require newer versions:

- `semantic-release` (v25.0.2) requires Node.js ^22.14.0 || >= 24.10.0
- This may cause warnings during `npm install` and potentially affect semantic release functionality

**Workaround**: The current setup continues to work with warnings. Consider upgrading to Node.js 22+ when moving to production releases.

**Resolution**: Future updates should upgrade the base Node.js version in `Dockerfile` (line 19) and ensure CI/CD workflows use compatible versions.

### Claude Code Integration

The container includes comprehensive AI-assisted development capabilities:
Expand Down
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ This repository includes comprehensive GitHub Actions workflows and development

#### GitHub Actions Workflows

- **CI Pipeline** (`.github/workflows/ci.yml`): Automated testing, linting, and quality checks
- **CI Pipeline** (`.github/workflows/ci.yml`): Automated testing, linting, and quality checks (uses Node.js 20)
- **Claude Code Integration** (`.github/workflows/claude.yml`): AI-assisted code review and issue management
- **Docker Image Build** (`.github/workflows/docker-image.yml`): Containerized build and deployment pipeline
- **Library Auto-Update** (`.github/workflows/update-libraries.yml`): Scheduled Codex/Claude tooling refresh that raises a PR when `npm run update:libs` produces changes
Expand Down Expand Up @@ -248,6 +248,10 @@ This repository uses semantic-release for automated version management and relea

Releases are automatically created when changes are pushed to the main branch.

#### Compatibility Notes

**Node.js Version Requirements**: The current semantic-release (v25.0.2) requires Node.js ^22.14.0 || >= 24.10.0, but the repository currently uses Node.js v20.x in development containers and CI. This produces warnings but continues to function. Consider upgrading Node.js versions for full compatibility.

### AI-Assisted Development Workflows

This repository supports AI-assisted development through Claude Code integration:
Expand Down
11 changes: 0 additions & 11 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.