Skip to content

ARMmbed/continuous-delivery-scripts

 
 

Automation Scripts for CI/CD

Package Documentation PyPI PyPI - Status PyPI - Python Version

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

Interface definition and usage documentation is available for the most recent production release here:

Project Structure

The follow described the major aspects of the project structure:

  • azure-pipelines/ - CI configuration files for Azure Pipelines.
  • 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

About

Forked from ARMmbed/mbed-tools-ci-scripts but made more generic for use in other languages than python

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 10