Skip to content

Conversation

@nslee333
Copy link
Member

@nslee333 nslee333 commented Jul 9, 2025

Summary

This PR updates the CI/CD pipeline and modernizes the Docusaurus documentation setup to maintain consistency with the dnp3 project.

CI/CD Updates

  • GitHub Actions: Updated all actions from v3 to v4 (checkout, upload-artifact, download-artifact)
  • Rust toolchain: Removed beta from the CI matrix
  • Artifact handling:
    • Fixed artifact naming to prevent conflicts by adding target-specific names (ffi-modules-{target})
    • Consolidated Java artifacts (JAR and POM) into a single java-bindings artifact
    • Added merge-multiple: true for artifact pattern matching
  • Build commands: Switched from yarn to npm in the guide build job

Documentation/Docusaurus Updates

  • Migrated to Docusaurus 3: Updated from Docusaurus 2 to 3
  • Mermaid support:
    • Removed custom mermaid plugin implementation
    • Switched to Docusaurus's built-in @docusaurus/theme-mermaid
    • Removed direct mermaid dependency from package.json
    • Deleted unused guide/plugins/mermaid/ directory
    • Deleted custom guide/src/theme/Mermaid.js component
  • Package manager: Standardized on npm (removed yarn.lock, kept package-lock.json)
  • Dependencies: Updated prism-react-renderer import syntax for compatibility
  • Documentation: Updated README.md with npm commands and Node.js setup instructions

Build Dependencies

Updated allowed.json with new build-only dependencies:

  • adler2
  • cfg_aliases
  • once_cell_polyfill
  • shlex
  • Added license entries for core-foundation and windows-link

Other Changes

  • Removed unused guide/static/index.html file
  • All changes tested and confirmed working with local build

This brings the rodbus CI/CD and documentation setup in line with the dnp3 project standards.

@gemini-code-assist
Copy link

Note

Gemini is unable to generate a summary for this pull request due to the file types involved not being currently supported.

@nslee333 nslee333 changed the title updating upload-artifact to v4 Broken CI builds Jul 9, 2025
@nslee333 nslee333 changed the title Broken CI builds Broken CI pipeline Jul 9, 2025
@nslee333 nslee333 changed the title Broken CI pipeline Fixing Broken CI pipeline, and Docusaurus upgrade Jul 10, 2025
@nslee333 nslee333 changed the title Fixing Broken CI pipeline, and Docusaurus upgrade Docusaurus upgrade and fixing broken CI pipeline Jul 10, 2025
@nslee333 nslee333 requested a review from jadamcrain July 10, 2025 20:52
@jadamcrain jadamcrain merged commit 4f4c56f into main Jul 20, 2025
24 checks passed
@jadamcrain jadamcrain deleted the fix/ci-actions branch July 20, 2025 15:46
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.

3 participants