Package: continuous-delivery-scripts
Automation Scripts for CI/CDOverviewProject initially forked fromARMmbed/mbed-tools-ci-scriptsbut modified so that it can be used for any projects and any languages.Continuous Delivery scripts for any projects:Automated release flows (i.e. changelog generation, git tags, versioning)third party IP auditing and reportingReleasesFor release notes and a history of changes of allproductionreleases, please see the following:ChangelogFor a the list of all available versions please, please see the:PyPI Release HistoryVersioningThe version scheme used followsPEP440andSemantic Versioning. For production quality releases the version will look as follows:<major>.<minor>.<patch>Beta releases are used to give early access to new functionality, for testing and to get feedback on experimental
features. As such these releases may not be stable and should not be used for production. Additionally any interfaces
introduced in a beta release may be removed or changed without notice. Forbetareleases the version will look as
follows:<major>.<minor>.<patch>-beta.<pre-release-number>InstallationIt is recommended that a virtual environment such asPipenvis
used for all installations to avoid Python dependency conflicts.To install the most recent production quality release use:pip install continuous-delivery-scriptsTo install a specific release:pip install continuous-delivery-scripts==<version>Usage & DocumentationCode documentation is available for the most recent
production release here:GitHub PagesThe package follows theUnix tools philosophy:The tools philosophy was to have small programs to accomplish a particular task instead of trying to develop large monolithic programs to do a large number of tasks. To accomplish more complex tasks, tools would simply be connected together, using pipes.Therefore, it installs the following tools which can be used anywhere within a project/repository comprising a pyproject.toml file such as theone defining this project:cd-assert-news: Asserts that the PR/Branch contains a news file describing the changes introducedcd-determine-version: Returns the version of the toolcd-generate-news: Generates a changelog file based on the news files present in the repositorycd-get-config: Returns project configuration valuescd-tag-and-release: Releases the project (Language specific actions are run, Seeplugins)cd-create-news-file: Generates a news filecd-generate-docs: Generates project Code documentation which can then be rendered by GitHub pages (Seedocs folder)cd-generate-spdx: Generates SPDX documents for the project (3rd party IP reporting/ OpenChain)cd-license-files: Updates the Licence header and copyright to all the source code filesProject StructureThe follow described the major aspects of the project structure:.github- CI and GitHub configuration files.docs/- Interface definition and usage documentation.examples/- Usage examples.continuous-delivery-scripts/- Python source files.news/- Collection of news files for unreleased changes.tests/- Unit and integration tests.Getting HelpFor interface definition and usage documentation, please seeGitHub Pages.For a list of known issues and possible workarounds, please seeKnown Issues.To raise a defect or enhancement please useGitHub Issues.ContributingWe are committed to fostering a welcoming community, please see ourCode of Conductfor more information.For ways to contribute to the project, please see theContributions GuidelinesFor a technical introduction into developing this package, please see theDevelopment Guide