Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 10, 2025

Implementation Plan

  • Create documentation in markdown format for dmini module
  • Create .dmr resource file for dmini module
  • Create .dmr resource file for test_dmini module
  • Update release workflow to copy headers (dmini.h and dmini_defs.h) to release package
  • Update release workflow to copy documentation to release package
  • Update release workflow to copy .dmr files to release package
  • Test the build process to verify all files are included correctly
  • Fix dmini.dmr to map entire include directory (required for dmf-get special handling)
  • Run code review
  • Run security scan

Summary

Successfully added .dmr (DMOD Resource File) support to the dmini project with:

  1. Documentation: Created docs/dmini.md with complete API documentation in markdown format (simplified for dmf-man tool)

  2. Resource Files:

    • dmini.dmr - Specifies installation paths for dmini module files, headers (entire include directory), docs, and license
    • test_dmini.dmr - Specifies installation paths for test_dmini module files
  3. Release Package Updates: Modified .github/workflows/release.yml to include:

    • Both header files (include/dmini.h and include/dmini_defs.h)
    • Documentation directory with markdown files
    • The .dmr resource files for both modules
    • Proper directory structure in the release package

The inc entry in dmini.dmr now correctly maps the entire ./include directory (not individual files), which is important as dmf-get treats the inc key specially.

Security Summary

No security vulnerabilities detected by CodeQL scan.

Original prompt

This section details on the original issue you should resolve

<issue_title>Dodać plik .dmr wraz z documentacją i nagłówkami do paczki release'owej</issue_title>
<issue_description>Ostatnio do dmod zostało dodane wsparcie dla plików *.dmr - czyli plików definiujących zasoby modułu. Dokładny opis znajduje się tutaj:

https://github.com/choco-technologies/dmod/blob/develop/docs/dmr-file-format.md

Celem tego zadania jest stworzenie pliku dmr i dodanie go do CI release'owego tak, aby znajdował się w paczce zip. Plik zasobów powinien zawierać informacje o licencji, nagłówkach i dokumentacji i wszystkie te rzeczy powinny zostać dodane również do paczki release'owej.

Co do dokumentacji to uwzględnij proszę, że w opisie DMR jest drobny błąd - dokumentacja nie powinna być w html, tylko w markdown (i to uproszczonym), gdyż docelowo będzie można wyświetlić ją w konsoli za pomocą narzędzia dmf-man (odpowiednik man linuxowego).

Pamiętaj, aby w nagłówkach również umieścić wygenerowany header dmini_defs.h</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: JohnAmadis <17320783+JohnAmadis@users.noreply.github.com>
Copy link
Contributor

@JohnAmadis JohnAmadis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot popraw proszę tę jedną rzecz

dmini.dmr Outdated

# === Header Files ===
# Public API header
inc=./include/dmini.h => ${destination}/${module}/include/dmini.h
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

inc powinien być całym katalogiem - i w nim już powinien być też od razu ten dmini_defs.h

Jest to ważne, ponieważ inc będzie specjalnie traktowany przez dmf-get

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in b3197b3. Changed dmini.dmr to map the entire ./include directory instead of individual files, so dmf-get can handle the inc key specially.

Copilot AI changed the title [WIP] Add .dmr file with documentation and headers to release package Add .dmr resource file with headers and documentation to release package Dec 10, 2025
Copilot AI requested a review from JohnAmadis December 10, 2025 18:40
Co-authored-by: JohnAmadis <17320783+JohnAmadis@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Dec 10, 2025

@copilot popraw proszę tę jedną rzecz

Fixed in b3197b3. The inc entry now maps the entire include directory.

@JohnAmadis JohnAmadis marked this pull request as ready for review December 10, 2025 18:53
@JohnAmadis JohnAmadis merged commit fd7d91a into main Dec 10, 2025
1 check passed
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.

Dodać plik .dmr wraz z documentacją i nagłówkami do paczki release'owej

2 participants