Skip to main content

Continuous Delivery scripts to increase automation

Project description

Automation Scripts for CI/CD

Package Documentation PyPI PyPI - Status PyPI - Python Version Downloads

License Compliance

Build Status

Test Coverage Maintainability

Overview

Project initially forked from ARMmbed/mbed-tools-ci-scripts but 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 reporting

Releases

For release notes and a history of changes of all production releases, please see the following:

For a the list of all available versions please, please see the:

Versioning

The version scheme used follows PEP440 and Semantic 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. For beta releases the version will look as follows:

  • <major>.<minor>.<patch>-beta.<pre-release-number>

Installation

It is recommended that a virtual environment such as Pipenv is used for all installations to avoid Python dependency conflicts.

To install the most recent production quality release use:

pip install continuous-delivery-scripts

To install a specific release:

pip install continuous-delivery-scripts==<version>

Usage & Documentation

Code documentation is available for the most recent production release here:

The package follows the Unix 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 the one defining this project:

  • cd-assert-news: Asserts that the PR/Branch contains a news file describing the changes introduced
  • cd-determine-version: Returns the version of the tool
  • cd-generate-news: Generates a changelog file based on the news files present in the repository
  • cd-get-config: Returns project configuration values
  • cd-tag-and-release: Releases the project (Language specific actions are run, See plugins)
  • cd-create-news-file: Generates a news file
  • cd-generate-docs: Generates project Code documentation which can then be rendered by GitHub pages (See docs 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 files

Project Structure

The 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 Help

  • For interface definition and usage documentation, please see GitHub Pages.
  • For a list of known issues and possible workarounds, please see Known Issues.
  • To raise a defect or enhancement please use GitHub Issues.

Contributing

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

continuous-delivery-scripts-3.2.0.tar.gz (100.1 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file continuous-delivery-scripts-3.2.0.tar.gz.

File metadata

File hashes

Hashes for continuous-delivery-scripts-3.2.0.tar.gz
Algorithm Hash digest
SHA256 7d809ec97e30e878449e04b2515cee1c4602c2db0ce551c35708d893ae2d1191
MD5 cbee66a2612de65dba3c3887c99fcc15
BLAKE2b-256 ca4a4a0cfde9716ca0906cf8796e6ab67aebafec49024ac8596d186b7d15439f

See more details on using hashes here.

File details

Details for the file continuous_delivery_scripts-3.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for continuous_delivery_scripts-3.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6ab2264437ff0359d9fc4e6d3394522497903e8644207c95ec469ef24c414a66
MD5 0edc5e52b7f3e239a0890a53db98fa36
BLAKE2b-256 e77c809e37deabeba94bdb026c47d01645cb488e991f6e1a6c9338d2fcde40aa

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page