Katenary/katenary
2
0
Fork 3
Code Issues 13 Pull Requests 2 Actions Packages Projects 4 Releases 18 Wiki Activity

Develop #138

Merged
metal3d merged 5 commits from develop into master 2025-07-13 13:37:31 +00:00
Conversation 0 Commits 5 Files Changed 7
+47 -6
metal3d commented 2025-07-13 13:37:23 +00:00
Owner
Copy Link
Copy Source

This pull request includes updates to documentation, dependencies, and the codebase for handling services and ports in the katenary project. The most significant changes involve adding new functionality for naming ports, improving test coverage, and updating documentation references to reflect code changes.

Codebase updates:

  • Port naming enhancement: Added logic to assign unique names to ports when the target port is unknown in func (s *Service) AddPort. This ensures that ports without explicit names are still uniquely identifiable. (generator/service.go, generator/service.goR63)
  • New test case: Introduced a test case TestWithSeveralUnknownPorts to validate the behavior of services with multiple unknown ports. The test ensures that ports are assigned distinct names. (generator/service_test.go, generator/service_test.goR50-R83)

Documentation updates:

  • Markdownlint configuration: Disabled rule MD041 in .markdownlint.yaml to allow for more flexible markdown formatting. (doc/docs/.markdownlint.yaml, doc/docs/.markdownlint.yamlR5)
  • Updated code references: Adjusted line numbers in documentation to reflect changes in the generator/service.go file. (doc/docs/packages/generator.md, [1] [2] [3] [4] [5]
  • Clarification in usage documentation: Improved wording and formatting for initContainer in the usage.md file to enhance readability. (doc/docs/usage.md, doc/docs/usage.mdL148-R148)

Dependency updates:

  • New dependencies: Added beautifulsoup4 and mkdocs-manpage[preprocess] to requirements.txt for enhanced documentation processing capabilities. (doc/requirements.txt, doc/requirements.txtR8-R9)
This pull request includes updates to documentation, dependencies, and the codebase for handling services and ports in the `katenary` project. The most significant changes involve adding new functionality for naming ports, improving test coverage, and updating documentation references to reflect code changes. ### Codebase updates: * **Port naming enhancement**: Added logic to assign unique names to ports when the target port is unknown in `func (s *Service) AddPort`. This ensures that ports without explicit names are still uniquely identifiable. (`generator/service.go`, [generator/service.goR63](diffhunk://#diff-502905f90a54fffa0037235bc3935029271d4a3754d0c2f080d791a126fc035cR63)) * **New test case**: Introduced a test case `TestWithSeveralUnknownPorts` to validate the behavior of services with multiple unknown ports. The test ensures that ports are assigned distinct names. (`generator/service_test.go`, [generator/service_test.goR50-R83](diffhunk://#diff-b42c40091381275946aa6051d464f612b178e39540f386b122069b67e9720d16R50-R83)) ### Documentation updates: * **Markdownlint configuration**: Disabled rule `MD041` in `.markdownlint.yaml` to allow for more flexible markdown formatting. (`doc/docs/.markdownlint.yaml`, [doc/docs/.markdownlint.yamlR5](diffhunk://#diff-6436ce6888c39b8135f72866da7b170adb610a9c6f30e25e4778d771eec0e2fdR5)) * **Updated code references**: Adjusted line numbers in documentation to reflect changes in the `generator/service.go` file. (`doc/docs/packages/generator.md`, [[1]](diffhunk://#diff-852a464c3b4f909993e3c9bc7e8516f84822079c7d2eccc95e02449301fd3b62L734-R734) [[2]](diffhunk://#diff-852a464c3b4f909993e3c9bc7e8516f84822079c7d2eccc95e02449301fd3b62L746-R746) [[3]](diffhunk://#diff-852a464c3b4f909993e3c9bc7e8516f84822079c7d2eccc95e02449301fd3b62L755-R755) [[4]](diffhunk://#diff-852a464c3b4f909993e3c9bc7e8516f84822079c7d2eccc95e02449301fd3b62L764-R764) [[5]](diffhunk://#diff-852a464c3b4f909993e3c9bc7e8516f84822079c7d2eccc95e02449301fd3b62L773-R773) * **Clarification in usage documentation**: Improved wording and formatting for `initContainer` in the `usage.md` file to enhance readability. (`doc/docs/usage.md`, [doc/docs/usage.mdL148-R148](diffhunk://#diff-44f59badc96dd4600a12d2475cc1b2138c8a47ba0d3dc1fca34b09371d308aa8L148-R148)) ### Dependency updates: * **New dependencies**: Added `beautifulsoup4` and `mkdocs-manpage[preprocess]` to `requirements.txt` for enhanced documentation processing capabilities. (`doc/requirements.txt`, [doc/requirements.txtR8-R9](diffhunk://#diff-246970f36ae7ff82cc458ecc03e34c76cd67f7b50a0e4899b12c31c283b26fcfR8-R9))
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
bug
Something isn't working
 dependencies
Pull requests that update a dependency file
 documentation
Improvements or additions to documentation
 duplicate
This issue or pull request already exists
 enhancement
New feature or request
 go
Pull requests that update go code
 good first issue
Good for newcomers
 help wanted
Extra attention is needed
 invalid
This doesn't seem right
 partially fixed
Some fixes are already made in current release / developpement
 question
Further information is requested
 wontfix
This will not be worked on
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
metal3d (Patrice Ferlet)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Katenary/katenary#138