Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

1350 owner migration #1362

Merged
merged 12 commits into from
Aug 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ v34.7.2 (unreleased)
- Move the BasePipeline class to a new `aboutcode.pipeline` module.
https://github.com/nexB/scancode.io/issues/1351

- Update link references of ownership from nexB to aboutcode-org
https://github.com/aboutcode-org/scancode.io/issues/1350

v34.7.1 (2024-07-15)
--------------------

Expand Down
6 changes: 3 additions & 3 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SPDX-License-Identifier: Apache-2.0
#
# http://nexb.com and https://github.com/nexB/scancode.io
# http://nexb.com and https://github.com/aboutcode-org/scancode.io
# The ScanCode.io software is licensed under the Apache License version 2.0.
# Data generated with ScanCode.io is provided as-is without warranties.
# ScanCode is a trademark of nexB Inc.
Expand All @@ -18,11 +18,11 @@
# for any legal advice.
#
# ScanCode.io is a free software code scanning tool from nexB Inc. and others.
# Visit https://github.com/nexB/scancode.io for support and download.
# Visit https://github.com/aboutcode-org/scancode.io for support and download.

FROM python:3.12-slim

LABEL org.opencontainers.image.source="https://github.com/nexB/scancode.io"
LABEL org.opencontainers.image.source="https://github.com/aboutcode-org/scancode.io"
LABEL org.opencontainers.image.description="ScanCode.io"
LABEL org.opencontainers.image.licenses="Apache-2.0"

Expand Down
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SPDX-License-Identifier: Apache-2.0
#
# http://nexb.com and https://github.com/nexB/scancode.io
# http://nexb.com and https://github.com/aboutcode-org/scancode.io
# The ScanCode.io software is licensed under the Apache License version 2.0.
# Data generated with ScanCode.io is provided as-is without warranties.
# ScanCode is a trademark of nexB Inc.
Expand All @@ -18,7 +18,7 @@
# for any legal advice.
#
# ScanCode.io is a free software code scanning tool from nexB Inc. and others.
# Visit https://github.com/nexB/scancode.io for support and download.
# Visit https://github.com/aboutcode-org/scancode.io for support and download.

# Python version can be specified with `$ PYTHON_EXE=python3.x make conf`
PYTHON_EXE?=python3
Expand Down
4 changes: 2 additions & 2 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
SPDX-License-Identifier: Apache-2.0

http://nexb.com and https://github.com/nexB/scancode.io
http://nexb.com and https://github.com/aboutcode-org/scancode.io
The ScanCode.io software is licensed under the Apache License version 2.0.
Data generated with ScanCode.io is provided as-is without warranties.
ScanCode is a trademark of nexB Inc.
Expand All @@ -18,4 +18,4 @@ ScanCode.io should be considered or used as legal advice. Consult an Attorney
for any legal advice.

ScanCode.io is a free software code scanning tool from nexB Inc. and others.
Visit https://github.com/nexB/scancode.io for support and download.
Visit https://github.com/aboutcode-org/scancode.io for support and download.
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ The ScanCode.io documentation is available here: https://scancodeio.readthedocs.
If you have questions that are not covered by our
`Documentation <https://scancodeio.readthedocs.io/en/latest/faq.html>`_ or
`FAQs <https://scancodeio.readthedocs.io/en/latest/faq.html>`_,
please ask them in `Discussions <https://github.com/nexB/scancode.io/discussions>`_.
please ask them in `Discussions <https://github.com/aboutcode-org/scancode.io/discussions>`_.

If you want to contribute to ScanCode.io, start with our
`Contributing <https://scancodeio.readthedocs.io/en/latest/contributing.html>`_ page.

A new GitHub action is now available at
`scancode-action <https://github.com/nexB/scancode-action>`_
`scancode-action <https://github.com/aboutcode-org/scancode-action>`_
to run ScanCode.io pipelines from your GitHub Workflows.
Visit https://scancodeio.readthedocs.io/en/latest/automation.html to learn more
about automation.
Expand Down Expand Up @@ -56,8 +56,8 @@ ScanCode.io should be considered or used as legal advice. Consult an Attorney
for any legal advice.


.. |ci-tests| image:: https://github.com/nexB/scancode.io/actions/workflows/ci.yml/badge.svg?branch=main
:target: https://github.com/nexB/scancode.io/actions/workflows/ci.yml
.. |ci-tests| image:: https://github.com/aboutcode-org/scancode.io/actions/workflows/ci.yml/badge.svg?branch=main
:target: https://github.com/aboutcode-org/scancode.io/actions/workflows/ci.yml
:alt: CI Tests Status

.. |docs-rtd| image:: https://readthedocs.org/projects/scancodeio/badge/?version=latest
Expand Down
7 changes: 4 additions & 3 deletions aboutcode/pipeline/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SPDX-License-Identifier: Apache-2.0
#
# http://nexb.com and https://github.com/nexB/scancode.io
# http://nexb.com and https://github.com/aboutcode-org/scancode.io
# The ScanCode.io software is licensed under the Apache License version 2.0.
# Data generated with ScanCode.io is provided as-is without warranties.
# ScanCode is a trademark of nexB Inc.
Expand All @@ -18,7 +18,7 @@
# for any legal advice.
#
# ScanCode.io is a free software code scanning tool from nexB Inc. and others.
# Visit https://github.com/nexB/scancode.io for support and download.
# Visit https://github.com/aboutcode-org/scancode.io for support and download.

import logging
import traceback
Expand Down Expand Up @@ -204,7 +204,8 @@ def execute(self):
step_run_time = timer() - step_start_time
self.log(f"Step [{step_name}] completed in {humanize_time(step_run_time)}")

self.set_current_step("") # Reset the `current_step` field on completion
# Reset the `current_step` field on completion
self.set_current_step("")
pipeline_run_time = timer() - pipeline_start_time
self.log(f"Pipeline completed in {humanize_time(pipeline_run_time)}")

Expand Down
2 changes: 1 addition & 1 deletion docs/application-settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ VULNERABLECODE
^^^^^^^^^^^^^^

You have the option to either deploy your instance of
`VulnerableCode <https://github.com/nexB/vulnerablecode/>`_
`VulnerableCode <https://github.com/aboutcode-org/vulnerablecode/>`_
or connect to the `public instance <https://public.vulnerablecode.io/>`_.

To configure your local environment, set the ``VULNERABLECODE_URL`` in your ``.env``
Expand Down
2 changes: 1 addition & 1 deletion docs/automation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ automation methods such as a cron job or a git hook::
# Configure the following variables to your needs
PROJECT_NAME = f"scan-{datetime.now().isoformat()}"
INPUT_URLS = [
"https://github.com/nexB/scancode.io/archive/refs/tags/v32.4.0.zip",
"https://github.com/aboutcode-org/scancode.io/archive/refs/tags/v32.4.0.zip",
]
PIPELINES = [
"inspect_packages",
Expand Down
4 changes: 2 additions & 2 deletions docs/command-line-interface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ copy ``~/docker/alpine-base.tar`` to the foo project :guilabel:`input/` director
You can also provide URLs of files to be downloaded to the foo project
:guilabel:`input/` directory::

$ scanpipe add-input --project foo --input-url https://github.com/nexB/scancode.io-tutorial/releases/download/sample-images/30-alpine-nickolashkraus-staticbox-latest.tar
$ scanpipe add-input --project foo --input-url https://github.com/aboutcode-org/scancode.io-tutorial/releases/download/sample-images/30-alpine-nickolashkraus-staticbox-latest.tar

.. note:: Docker images can be provided as input using their Docker reference
with the ``docker://docker-reference`` syntax. For example::
Expand All @@ -194,7 +194,7 @@ You can also provide URLs of files to be downloaded to the foo project
.. note:: Git repositories are supported as input using their Git clone URL in the
``https://<host>[:<port>]/<path-to-git-repo>.git`` syntax. For example::

$ [...] --input-url https://github.com/nexB/scancode.io.git
$ [...] --input-url https://github.com/aboutcode-org/scancode.io.git


`$ scanpipe add-pipeline --project PROJECT PIPELINE_NAME [PIPELINE_NAME ...]`
Expand Down
18 changes: 9 additions & 9 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ Do Your Homework
----------------

Before adding a contribution or create a new issue, take a look at the project’s
`README <https://github.com/nexB/scancode.io#readme>`_, read through our
`README <https://github.com/aboutcode-org/scancode.io#readme>`_, read through our
`documentation <https://scancodeio.readthedocs.io/en/latest/>`_,
and browse existing `issues <https://github.com/nexB/scancode.io/issues>`_,
and browse existing `issues <https://github.com/aboutcode-org/scancode.io/issues>`_,
to develop some understanding of the project and confirm whether a given
issue/feature has previously been discussed.

Expand All @@ -34,7 +34,7 @@ First Timers

You are here to help, but you're a new contributor! No worries, we always
welcome newcomer contributors. We maintain some
`good first issues <https://github.com/nexB/scancode.io/labels/good%20first%20issue>`_
`good first issues <https://github.com/aboutcode-org/scancode.io/labels/good%20first%20issue>`_
and encourage new contributors to work on those issues for a smooth start.

.. warning::
Expand All @@ -55,15 +55,15 @@ and encourage new contributors to work on those issues for a smooth start.
Report Issues
^^^^^^^^^^^^^

- Report a new `bug <https://github.com/nexB/scancode.io/issues>`_; just remember to be
- Report a new `bug <https://github.com/aboutcode-org/scancode.io/issues>`_; just remember to be
as specific as possible.
- Create a `new issue <https://github.com/nexB/scancode.io/issues>`_ to request a
- Create a `new issue <https://github.com/aboutcode-org/scancode.io/issues>`_ to request a
feature, submit a feedback, or ask a question.
- Look into existing `bugs <https://github.com/nexB/scancode.io/labels/bug>`_,
- Look into existing `bugs <https://github.com/aboutcode-org/scancode.io/labels/bug>`_,
try to reproduce the issue on your side, and discuss solutions in the comments.

.. note::
Make sure to check existing `issues <https://github.com/nexB/scancode.io/issues>`_,
Make sure to check existing `issues <https://github.com/aboutcode-org/scancode.io/issues>`_,
and :ref:`faq` to confirm whether a given issue or a question has previously been
discussed.

Expand All @@ -72,7 +72,7 @@ Code Contributions

Code is contributed to the codebase using **pull requests**.
A pull request should always be attached to an existing issue.
When there is no existing issues, start by `creating one <https://github.com/nexB/scancode.io/issues>`_
When there is no existing issues, start by `creating one <https://github.com/aboutcode-org/scancode.io/issues>`_
to discuss potential solutions and implementation details before writing any code.

We use several conventions to ensure code quality regarding format, testing, and
Expand All @@ -98,7 +98,7 @@ attribution.
3. **Commit messages and Developer Certificate of Origin**

Follow the instructions at `Writing good Commit Messages <https://aboutcode.readthedocs.io/en/latest/contributing/writing_good_commit_messages.html>`_
and `check some examples <https://github.com/nexB/scancode.io/commits/main>`_.
and `check some examples <https://github.com/aboutcode-org/scancode.io/commits/main>`_.

**You must include a "Signed-off-by" to your commit messages**::

Expand Down
4 changes: 2 additions & 2 deletions docs/custom-pipelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ the entry point to the pipeline under the ``[options.entry_points]`` section.
# description must be on ONE line https://github.com/pypa/setuptools/issues/1390
description = Generates a licenses report file from a template in ScanCode.io
long_description = file:README.rst
url = https://github.com/nexB/scancode.io
url = https://github.com/aboutcode-org/scancode.io
classifiers =
Development Status :: 4 - Beta
Intended Audience :: Developers
Expand Down Expand Up @@ -249,7 +249,7 @@ the entry point to the pipeline under the ``[options.entry_points]`` section.
.. tip::
Take a look at `Google License Classifier pipeline for ScanCode.io
<https://github.com/nexB/scancode.io-pipeline-glc_scan>`_
<https://github.com/aboutcode-org/scancode.io-pipeline-glc_scan>`_
for a complete example on packaging a custom tool as a pipeline.

Pipeline Publishing to PyPI
Expand Down
14 changes: 7 additions & 7 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -137,23 +137,23 @@ What tool does ScanCode.io use to analyze docker images?

The following tools and libraries are used during the docker images analysis pipeline:

- `container-inspector <https://github.com/nexB/container-inspector>`_ and
`debian-inspector <https://github.com/nexB/debian-inspector>`_ for handling containers
- `container-inspector <https://github.com/aboutcode-org/container-inspector>`_ and
`debian-inspector <https://github.com/aboutcode-org/debian-inspector>`_ for handling containers
and distros.
- `fetchcode-container <https://pypi.org/project/fetchcode-container/>`_ to download
containers and images.
- `scancode-toolkit <https://github.com/nexB/scancode-toolkit>`_ for application
- `scancode-toolkit <https://github.com/aboutcode-org/scancode-toolkit>`_ for application
package scans and system package scans.
- `extractcode <https://github.com/nexB/extractcode>`_ for universal and reliable
- `extractcode <https://github.com/aboutcode-org/extractcode>`_ for universal and reliable
archive extraction.
- Specific handling of windows containers is done in
`scancode-toolkit <https://github.com/nexB/scancode-toolkit>`_ to process the windows registry.
`scancode-toolkit <https://github.com/aboutcode-org/scancode-toolkit>`_ to process the windows registry.
- Secondary libraries and plugins from
`scancode-plugins <https://github.com/nexB/scancode-plugins>`_.
`scancode-plugins <https://github.com/aboutcode-org/scancode-plugins>`_.

The pipeline documentation is available at :ref:`pipeline_analyze_docker_image` and
its source code at
`docker.py <https://github.com/nexB/scancode.io/blob/main/scanpipe/pipelines/docker.py>`_.
`docker.py <https://github.com/aboutcode-org/scancode.io/blob/main/scanpipe/pipelines/docker.py>`_.
It is hopefully designed to be simple and readable code.

Am I able to run ScanCode.io on Windows?
Expand Down
18 changes: 9 additions & 9 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ required for the creation of the Docker image.

git config --global core.autocrlf false

**Clone the git** `ScanCode.io repo <https://github.com/nexB/scancode.io>`_,
**Clone the git** `ScanCode.io repo <https://github.com/aboutcode-org/scancode.io>`_,
create an **environment file**, and **build the Docker image**::

git clone https://github.com/nexB/scancode.io.git && cd scancode.io
git clone https://github.com/aboutcode-org/scancode.io.git && cd scancode.io
make envfile
docker compose build

Expand Down Expand Up @@ -108,7 +108,7 @@ An overview of the web application usage is available at :ref:`user_interface`.
Upgrade the App
^^^^^^^^^^^^^^^

**Update your local** `ScanCode.io repo <https://github.com/nexB/scancode.io>`_,
**Update your local** `ScanCode.io repo <https://github.com/aboutcode-org/scancode.io>`_,
and **build the Docker image**::

cd scancode.io
Expand All @@ -123,7 +123,7 @@ and **build the Docker image**::

docker compose run -u 0:0 web chown -R app:app /var/scancodeio/

See also https://github.com/nexB/scancode.io/issues/399
See also https://github.com/aboutcode-org/scancode.io/issues/399

.. note::
You need to rebuild the image whenever ScanCode.io's source code has been
Expand Down Expand Up @@ -283,9 +283,9 @@ For the :ref:`pipeline_collect_strings_gettext` pipeline, `gettext <https://www.
Clone and Configure
^^^^^^^^^^^^^^^^^^^

* Clone the `ScanCode.io GitHub repository <https://github.com/nexB/scancode.io>`_::
* Clone the `ScanCode.io GitHub repository <https://github.com/aboutcode-org/scancode.io>`_::

git clone https://github.com/nexB/scancode.io.git && cd scancode.io
git clone https://github.com/aboutcode-org/scancode.io.git && cd scancode.io

* Inside the :guilabel:`scancode.io/` directory, install the required dependencies::

Expand Down Expand Up @@ -398,7 +398,7 @@ Helm Chart [Beta]
The Helm Chart support for ScanCode.io is a community contribution effort.
It is only tested on a few configurations and still under development.
We welcome improvement suggestions and issue reports at
`ScanCode.io GitHub repo <https://github.com/nexB/scancode.io/issues>`_.
`ScanCode.io GitHub repo <https://github.com/aboutcode-org/scancode.io/issues>`_.

Requirements
^^^^^^^^^^^^
Expand Down Expand Up @@ -478,13 +478,13 @@ Gitpod
.. warning::
The Gitpod support for ScanCode.io is a community contribution effort.
We welcome improvement suggestions and issue reports at
`ScanCode.io GitHub repo <https://github.com/nexB/scancode.io/issues>`_.
`ScanCode.io GitHub repo <https://github.com/aboutcode-org/scancode.io/issues>`_.

Installation
^^^^^^^^^^^^

* Create a new Workspace and open it in VSCode Browser or your preferred IDE.
Provide the ScanCode.io GitHub repo URL: https://github.com/nexB/scancode.io
Provide the ScanCode.io GitHub repo URL: https://github.com/aboutcode-org/scancode.io

* Open the "TERMINAL" window and create the ``.env`` file with::

Expand Down
6 changes: 3 additions & 3 deletions docs/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Dependencies and Internal Tools

ScanCode.io is essentially a `Django <https://www.djangoproject.com/>`_-based
application wrapper around the
`ScanCode Toolkit <https://github.com/nexB/scancode-toolkit>`_ scanning engine.
`ScanCode Toolkit <https://github.com/aboutcode-org/scancode-toolkit>`_ scanning engine.

The **Django framework** is leveraged for many aspects of ScanCode.io:

Expand All @@ -91,13 +91,13 @@ The **Django framework** is leveraged for many aspects of ScanCode.io:

.. note::
Multiple applications from the Django eco-system are also included,
see the `setup.cfg <https://github.com/nexB/scancode.io/blob/main/setup.cfg>`_ file
see the `setup.cfg <https://github.com/aboutcode-org/scancode.io/blob/main/setup.cfg>`_ file
for an exhaustive list of dependencies.

The second essential part of ScanCode.io is the **ScanCode Toolkit**, which is used
for archives extraction and as the scanning engine.

The nexB `container-inspector <https://github.com/nexB/container-inspector>`_ library
The nexB `container-inspector <https://github.com/aboutcode-org/container-inspector>`_ library
is also a key component of ScanCode.io as this tool is used to analyse Docker
images, containers, root filesystems, and virtual machine images.

Expand Down
2 changes: 1 addition & 1 deletion docs/output-files.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ as shown below
{
"tool_name": "scanpipe",
"tool_version": "21.6.10",
"notice": "Generated with ScanCode and provided on an \"AS IS\" BASIS, WITHOUT WARRANTIES\nOR CONDITIONS OF ANY KIND, either express or implied. No content created from\nScanCode should be considered or used as legal advice. Consult an Attorney\nfor any legal advice.\nScanCode is a free software code scanning tool from nexB Inc. and others.\nVisit https://github.com/nexB/scancode-toolkit/ for support and download.",
"notice": "Generated with ScanCode and provided on an \"AS IS\" BASIS, WITHOUT WARRANTIES\nOR CONDITIONS OF ANY KIND, either express or implied. No content created from\nScanCode should be considered or used as legal advice. Consult an Attorney\nfor any legal advice.\nScanCode is a free software code scanning tool from nexB Inc. and others.\nVisit https://github.com/aboutcode-org/scancode-toolkit/ for support and download.",
"uuid": "f06e257e-3126-4220-87c7-13583ced38a0",
"created_date": "2021-06-12T19:51:26.218Z",
"input_files": [
Expand Down
2 changes: 1 addition & 1 deletion docs/rest-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ Using cURL to provide download URLs:
content_type="Content-Type: application/json"
data='{
"input_urls": [
"https://github.com/nexB/debian-inspector/archive/refs/tags/v21.5.25.zip",
"https://github.com/aboutcode-org/debian-inspector/archive/refs/tags/v21.5.25.zip",
"https://github.com/package-url/packageurl-python/archive/refs/tags/0.9.4.tar.gz"
]
}'
Expand Down
4 changes: 2 additions & 2 deletions docs/scanpipe-concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ The following are some of the ``CodebaseResource`` attributes:
**copyright holders**, and **related packages**.

.. note::
Please note that `ScanCode-toolkit <https://github.com/nexB/scancode-toolkit>`_
Please note that `ScanCode-toolkit <https://github.com/aboutcode-org/scancode-toolkit>`_
use the same attributes and attribute names for files.

.. _discovered_packages:
Expand All @@ -147,5 +147,5 @@ The following are some of the ``DiscoveredPackage`` attributes:
- Copyright, license_expression, and declared_license

.. note::
Please note that `ScanCode-toolkit <https://github.com/nexB/scancode-toolkit>`_
Please note that `ScanCode-toolkit <https://github.com/aboutcode-org/scancode-toolkit>`_
use the same attributes and attribute names for packages.
Loading