Skip to content

chore: correct crate metadata and validate package links - #832

Open
onajidavid87-web wants to merge 2 commits into
Nanle-code:masterfrom
onajidavid87-web:Correct-crate-repository-metadata-and-package-links
Open

chore: correct crate metadata and validate package links#832
onajidavid87-web wants to merge 2 commits into
Nanle-code:masterfrom
onajidavid87-web:Correct-crate-repository-metadata-and-package-links

Conversation

@onajidavid87-web

Copy link
Copy Markdown

Description

Corrected placeholder crate repository metadata and package links across the StarForge project. Added validation to prevent invalid, missing, malformed, or unsupported package links from reaching publication.

Closes #649

Type of Change

  • Bug fix (non-breaking change)
  • New feature
  • Breaking change
  • Documentation update

Changes Made

  • Replaced placeholder YOUR_USERNAME repository links with the canonical StarForge repository.
  • Added repository, homepage, documentation, and keyword metadata to publishable crates.
  • Corrected the legacy WASM package dependency version.
  • Added an offline package metadata validator and integrated it into GitHub Actions.
  • Added contributor documentation describing metadata requirements and compatibility.

Testing

How has this been tested?

python3 `validate_package_metadata.py`
python3 `test_package_metadata.py`
cargo package --allow-dirty --no-verify --manifest-path `Cargo.toml`
cargo package --allow-dirty --no-verify --manifest-path `Cargo.toml`
cargo package --allow-dirty --no-verify --manifest-path `Cargo.toml`
cargo package --allow-dirty --no-verify --manifest-path `Cargo.toml`
cargo fmt --all --check
git diff --check
  • Unit tests added/updated
  • Integration tests added/updated
  • Manual testing performed

Test Coverage

  • Happy path: All four publishable Cargo manifests validate successfully.
  • Edge cases: Hyphenated package names and missing manifests are covered.
  • Error handling: Placeholder URLs, malformed TOML, invalid URL schemes, missing metadata, and unsupported Python versions are covered.

Code Quality Checklist

  • My code follows the style guidelines of this project (cargo fmt)
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings (cargo clippy -- -D warnings)
  • I have added tests that prove my fix is effective
  • New and existing unit tests pass locally with my changes
  • The CI checks pass

Breaking Changes

  • This PR introduces breaking changes

No migration is required.

Documentation

  • README.md updated
  • DEVELOPER_GUIDE.md updated
  • API_REFERENCE.md updated
  • Other package-link documentation updated

Screenshots

Not applicable.

Additional Context

The metadata-specific validator and package preparation checks pass. Full Rust build and test validation remains blocked by unrelated existing compilation errors in the repository.


**Note**: Make sure all tests pass locally before submitting:
```bash
cargo test
cargo fmt --all
cargo clippy -- -D warnings

Replaced placeholder repository URLs across Cargo manifests and documentation with the canonical StarForge repository. Added homepage and package-specific docs.rs metadata for all publishable crates, corrected the legacy WASM package dependency version, and introduced an offline metadata validator with tests for valid, boundary, malformed, placeholder, and unsupported-environment cases. Integrated validation into CI and documented the contributor workflow.

Closes Nanle-code#649
@drips-wave

drips-wave Bot commented Aug 26, 2026

Copy link
Copy Markdown

@onajidavid87-web Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@Manuelshub

Copy link
Copy Markdown
Collaborator

@onajidavid87-web Please make sure that all CI checks pass.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[2026 Hardening] Correct crate repository metadata and package links

2 participants