Skip to content

Commit

Permalink
Refine docstring and add CHANGELOG entry #688
Browse files Browse the repository at this point in the history
Signed-off-by: Thomas Druez <tdruez@nexb.com>
  • Loading branch information
tdruez committed Apr 24, 2023
1 parent 1d32d08 commit a002cc7
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
8 changes: 8 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ Changelog
v33.0.0 (unreleased)
--------------------

- Add a new ``develop_to_deploy`` pipeline specialized in creating relations between
the development source code and binaries or deployed code.
This pipeline is expecting 2 archive files with "from-" and "to-" filename prefixes
as inputs:
1. "from-[FILENAME]" archive containing the development source code
2. "to-[FILENAME]" archive containing the deployment compiled code
https://github.com/nexB/scancode.io/issues/659

- Add new command line option to create-project and add-input management commands to
copy the content of a local source directory to the project codebase work directory.
https://github.com/nexB/scancode.io/pull/672
Expand Down
9 changes: 8 additions & 1 deletion scanpipe/pipelines/develop_to_deploy.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,14 @@


class DevelopToDeploy(Pipeline):
"""Relate develop and deploy code tree."""
"""
Relate develop and deploy code trees.
This pipeline is expecting 2 archive files with "from-" and "to-" filename
prefixes as inputs:
- "from-[FILENAME]" archive containing the development source code
- "to-[FILENAME]" archive containing the deployment compiled code
"""

@classmethod
def steps(cls):
Expand Down

0 comments on commit a002cc7

Please # to comment.