Skip to content

Document output data format version history and fix versioning links - #5378

Open
Anshieee wants to merge 3 commits into
aboutcode-org:developfrom
Anshieee:docs-4868-output-format-version-history
Open

Anshieee wants to merge 3 commits into
aboutcode-org:developfrom
Anshieee:docs-4868-output-format-version-history

Conversation

@Anshieee

Copy link
Copy Markdown

Fixes #4868

What changed

  • docs/source/explanation/scancode-versioning.rst: adds an "Output data format version history" section listing each output format version from 1.0.0 to 4.1.0, the release that shipped it and what changed. The history is based on the CHANGELOG and verified against the __output_format_version__ value in each tagged release (this also answers the question in the issue comments about where 3.2.0 was introduced: v32.2.0, with the is_direct / is_private / is_virtual additions).
  • src/scancode_config.py: fixes two comments that link to .../misc/versioning.html, a page that does not exist. Both now point to the working versioning page at .../explanation/scancode-versioning.html.
  • AUTHORS.rst: adds my name, per the contribution guidelines.

Tasks

  • Reviewed contribution guidelines
  • PR is descriptively titled and links the original issue above
  • Tests pass (docs and comment changes only; CI will confirm)
  • Commits are in a uniquely-named feature branch with no merge conflicts
  • Updated documentation pages
  • Updated CHANGELOG.rst (not applicable: documentation-only change, no API, CLI or behavior changes)

All commits are signed off per the DCO.

Adds the missing version history section to the versioning docs page, listing each output data format version, the release that shipped it and what changed. Part of aboutcode-org#4868.

Signed-off-by: Ansh Chauhan <51117244+Anshieee@users.noreply.github.com>
Points both comments at the existing explanation/scancode-versioning.html page instead of the removed misc/versioning.html page. Part of aboutcode-org#4868.

Signed-off-by: Ansh Chauhan <51117244+Anshieee@users.noreply.github.com>
Signed-off-by: Ansh Chauhan <51117244+Anshieee@users.noreply.github.com>

This branch has not been deployed

No deployments
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.

Missing documentation for versioning

1 participant