Skip to content

Allow metadata inside a pre-built deliverable - #257

Draft
tomschr wants to merge 1 commit into
mainfrom
toms/portal-rng-metadata
Draft

Allow metadata inside a pre-built deliverable#257
tomschr wants to merge 1 commit into
mainfrom
toms/portal-rng-metadata

Conversation

@tomschr

@tomschr tomschr commented May 6, 2026

Copy link
Copy Markdown
Contributor

Design decision

A pre-built deliverable allows holding this structure:

<metadata>
  <meta name="task">Entry 1</meta>
</metadata>

This allows adding whatever metadata we need. Downside is, we can't validate it.

Questions

  • Do we want to allow multiple <metadata> maybe with an additional name attribute?
    This would allow adding arrays of items which could make processing them a bit easier.

Design decision: A pre-built deliverable allows to hold this
structure:

  ```xml
  <metadata>
    <meta name="task">Entry 1</meta>
  </metadata>
  ```

This allows to add whatever metadata we need. Downside is,
we can't validate it.
@tomschr tomschr added the area:config Anything related to Portal schema, configs, models etc. label May 6, 2026
@github-actions

github-actions Bot commented May 6, 2026

Copy link
Copy Markdown

Coverage Report

For commit bcef3dc

Click to expand Coverage Report
  Name                                           Stmts   Miss Branch BrPart  Cover
  --------------------------------------------------------------------------------
+ src/docbuild/models/deliverable.py               180      1     22      0  99.5%
+ src/docbuild/cli/cmd_check/process.py             58      0     22      1  98.8%
+ src/docbuild/models/manifest.py                  111      1     12      1  98.4%
+ src/docbuild/utils/pidlock.py                     79      1     14      1  97.8%
+ src/docbuild/cli/cmd_config/list.py               26      0      8      1  97.1%
+ src/docbuild/cli/cmd_validate/process.py         178      5     52      4  96.1%
+ src/docbuild/cli/callback.py                      35      0     10      2  95.6%
+ src/docbuild/utils/concurrency.py                 69      3     18      1  95.4%
+ src/docbuild/cli/cmd_cli.py                      110      3     16      3  95.2%
- src/docbuild/config/xml/stitch.py                 47      5     12      0  88.1%
- src/docbuild/cli/cmd_metadata/metaprocess.py     215     26     66     13  82.6%
- src/docbuild/cli/cmd_config/validate.py           21      2     12      3  78.8%
- src/docbuild/cli/cmd_check/__init__.py            18      5      2      0  65.0%
- src/docbuild/cli/cmd_build/__init__.py            13      5      0      0  61.5%
- src/docbuild/cli/cmd_metadata/__init__.py         27     10      2      0  58.6%
  --------------------------------------------------------------------------------
+ TOTAL                                           3068     67    746     30  97.0%
  
  47 files skipped due to complete coverage.

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

Labels

area:config Anything related to Portal schema, configs, models etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant