https://github.com/aboutcode-org/scancode-toolkit-reference-scans

scancode-toolkit-reference-scans
https://github.com/aboutcode-org/scancode-toolkit-reference-scans

automation diff documentation hacktoberfest licenses packages readthedocs scancode-toolkit scripts sphinx

Last synced: about 1 month ago
JSON representation

scancode-toolkit-reference-scans

• Host: GitHub
• URL: https://github.com/aboutcode-org/scancode-toolkit-reference-scans
• Owner: aboutcode-org
• Created: 2021-09-29T16:14:55.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-30T06:29:55.000Z (over 1 year ago)
• Last Synced: 2025-10-21T22:33:16.197Z (4 months ago)
• Topics: automation, diff, documentation, hacktoberfest, licenses, packages, readthedocs, scancode-toolkit, scripts, sphinx
• Language: HTML
• Homepage: https://scancode-toolkit-reference-scans.readthedocs.io/en/latest/
• Size: 1.76 MB
• Stars: 1
• Watchers: 6
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst

Awesome Lists containing this project

README

          
Scancode-toolkit Reference Scans

================================

This repository houses reference scans for `scancode-toolkit `_,

and also documentation with diffs of scan output between different versions of scancode-toolkit.

The documentation is hosted at https://scancode-toolkit-reference-scans.readthedocs.io/en/latest/.

Updating after new Scancode Release

-----------------------------------

After a new scancode-toolkit release, to generate reference scans and output version diffs

documentation, the steps are:

    1. Run scancode for the latest and previous versions for the same sample scan data.

    2. Document Output Version diffs.

This is automated by the `script `_ at::

    scancode-toolkit-reference-scans/etc/shell-scripts/run_scancode_version_compare.sh

Using this script the steps to generate scans and document output versions diffs are as follows.

Run Script

^^^^^^^^^^

Give script permission to execute::

    chmod u+x ./etc/shell-scripts/run_scancode_version_compare.sh

Run the script::

    VERSION_OLD="21.8.4" VERSION_NEW="30.1.0" ./etc/shell-scripts/run_scancode_version_compare.sh

Here ``VERSION_OLD`` and ``VERSION_NEW`` should be replaced by the last and latest version numbers

for scancode-toolkit for which the reference scans and output versions differences has to be

documented.

Describe Output Format Changes

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

For the .rst file present in ``scancode-toolkit-reference-scans/docs/source/outputs/latest/``

folder, (For example: ``clipeu-v30.1.0-v21.8.4-1a0bd63.rst``) the relevant sections

has to be updated. The section ``Changes in Output Data`` has to be updated with:

    - additions

    - deletions

    - modifications

For each of the following sections:

    - ``Headers``

    - ``Files:Licenses``

    - ``Files:Packages``

    - Other Codebase/Resource Level Attribute Changes

Commit and Push changes

-----------------------

Now the changes made have to be commited and pushed to GitHub. The ReadTheDocs page build is

triggured automatically and the new docs will be hosted.