Auto-stamped generated.by carries the spec version (okf4net/0.2), not the producer version (§7)

Open
#257 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
56/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
csharp
Domain
backend

Research direction

Start at BundleConceptWriter.DefaultProducerActor in src/OKF4net/BundleConceptWriter.cs and check how the assembly informational version is exposed; OkfContextProvider also uses this default. Add a test for the actor version, then review goldens and MachineOutputTests for the old okf4net/0.2 value. Update the CHANGELOG; any semantic golden change needs arbitration under tests/fixtures/README.md.

Written by the indexing model from the issue text.

Description

.NET bug

Area

src/OKF4net — BundleConceptWriter.DefaultProducerActor (BundleConceptWriter.cs:248), also used by OkfContextProvider.

Problem

Auto-stamped writes record generated.by: okf4net/0.2. The default actor is "okf4net/" + OkfSpec.Version — the spec version. §7 defines the actor convention as <producer>/<version> for agents and tools, i.e. the producer's own version (okf4net/0.8.0), which is what tells a reader which build wrote the content.

Acceptance

  • The default actor is okf4net/<library version> (from the assembly's informational version, without the +<commit> suffix), with a test.
  • Check goldens and MachineOutputTests for any expectation of okf4net/0.2; a golden diff here is semantic (a written document) and needs arbitration per tests/fixtures/README.md.
  • CHANGELOG entry (the stamp written by the library changes).

Found independently while writing the #159 sample and the #174 tutorials.

Dominant language
C#
Stars
4
Forks
1
Avg merge
1d 4h
Merged PRs (30d)
32

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from jchable/okf4net

All issues in jchable/okf4net

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.