Skip to content

♻️ Remove codeclimate file and references #113

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

Merged
merged 4 commits into from
Jun 27, 2025
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
32 changes: 0 additions & 32 deletions .codeclimate.yml

This file was deleted.

82 changes: 41 additions & 41 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,47 +47,47 @@ jobs:
echo "::error:: News file missing (See CONTRIBUTING.md guide for details)."


generate-docs:
name: Build Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: ${{ env.python_version}}
- name: Determine dependencies
# Note
# The below code generates a pip requirements file from the pipenv development requirements (also obtaining the
# normal dependencies from setup.py).
# This code also forces the system to install latest tools as the ones present on the CI system may be too old
# for the process to go through properly.
# FIXME upgrade pipenv when https://github.com/pypa/pipenv/issues/4430 is actually fixed
run: |
python -m pip install --upgrade pip wheel setuptools
python -m pip install pipenv==${{ env.pipenv_version }}
echo "Locking dependencies"
python -m pipenv lock
python -m pipenv requirements > dev-requirements.txt
- uses: FranzDiebold/github-env-vars-action@v2
- name: Load Python Dependencies from cache
uses: actions/cache@v4
with:
path: ${{ env.python_cache_ubuntu_path }}
key: linux-pip-3-continuous-delivery-scripts
- name: Install dependencies
# Note
# As a virtual machine is already being used, pipenv
# is superfluous and eliminating pipenv in CI reduces overhead and reduce complexity, while retaining a single
# location for development dependencies.
run: |
python -m pip install -r dev-requirements.txt
python -m pip list
- name: Generate Documentation
run: |
cd-generate-docs --output_dir $(cd-get-config --key DOCUMENTATION_PRODUCTION_OUTPUT_PATH)
- name: Add copyright/licence notice.
run: |
cd-license-files
# generate-docs:
# name: Build Documentation
# runs-on: ubuntu-latest
# steps:
# - uses: actions/checkout@v4
# - uses: actions/setup-python@v5
# with:
# python-version: ${{ env.python_version}}
# - name: Determine dependencies
# # Note
# # The below code generates a pip requirements file from the pipenv development requirements (also obtaining the
# # normal dependencies from setup.py).
# # This code also forces the system to install latest tools as the ones present on the CI system may be too old
# # for the process to go through properly.
# # FIXME upgrade pipenv when https://github.com/pypa/pipenv/issues/4430 is actually fixed
# run: |
# python -m pip install --upgrade pip wheel setuptools
# python -m pip install pipenv==${{ env.pipenv_version }}
# echo "Locking dependencies"
# python -m pipenv lock
# python -m pipenv requirements > dev-requirements.txt
# - uses: FranzDiebold/github-env-vars-action@v2
# - name: Load Python Dependencies from cache
# uses: actions/cache@v4
# with:
# path: ${{ env.python_cache_ubuntu_path }}
# key: linux-pip-3-continuous-delivery-scripts
# - name: Install dependencies
# # Note
# # As a virtual machine is already being used, pipenv
# # is superfluous and eliminating pipenv in CI reduces overhead and reduce complexity, while retaining a single
# # location for development dependencies.
# run: |
# python -m pip install -r dev-requirements.txt
# python -m pip list
# - name: Generate Documentation
# run: |
# cd-generate-docs --output_dir $(cd-get-config --key DOCUMENTATION_PRODUCTION_OUTPUT_PATH)
# - name: Add copyright/licence notice.
# run: |
# cd-license-files

tpip:
name: Report licences in use (SPDX)
Expand Down
14 changes: 1 addition & 13 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,18 +133,6 @@ Type hints should be used in the code wherever possible. Since the
documentation shows the function signatures with the type hints
there is no need to include additional type information in the docstrings.


## Code Climate

Code Climate is integrated with our GitHub flow. Failing the configured rules will yield a pull request not mergeable.

If you prefer to view the Code Climate report on your machine, prior to sending a pull request, you can use the [cli provided by Code Climate](https://docs.codeclimate.com/docs/command-line-interface).

Plugins for various tools are also available:
- [Atom](https://docs.codeclimate.com/docs/code-climate-atom-package)
- [PyCharm](https://plugins.jetbrains.com/plugin/13306-code-cleaner-with-code-climate-cli)
- [Vim](https://docs.codeclimate.com/docs/vim-plugin)

# Dependency upgrades

For dependency upgrades, dependabot is relied upon and news files are auto-generated in order to document such change. Nonetheless, due to a change in [GitHub actions](https://github.blog/changelog/2021-02-19-github-actions-workflows-triggered-by-dependabot-prs-will-run-with-read-only-permissions), secrets are not available in the build triggered by the pull request unless they are [re-run manually](https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions#manually-re-running-a-workflow). So please re-run every dependabot PR CI jobs.
Expand Down Expand Up @@ -192,4 +180,4 @@ To flag individual false positives add comment `# pragma: allowlist secret` to l

To add all suspected secrets in the repository (excluding ones with an allow secret comment), run `detect-secrets scan --all-files --exclude-files 'Pipfile\.lock$' --exclude-files '.*\.html$' --exclude-files '.*\.properties$' --exclude-files 'ci.yml' --exclude-files '\.git' --exclude-files '.*_version.py' > .secrets.baseline`

If on Windows: then change the encoding of the .secrets.baseline file to UTF-8 then convert all `\` to `/` in the .secrets.baseline file
If on Windows: then change the encoding of the .secrets.baseline file to UTF-8 then convert all `\` to `/` in the .secrets.baseline file
3 changes: 0 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,6 @@ SPDX-License-Identifier: Apache-2.0

[![Build Status](https://github.com/ARMmbed/continuous-delivery-scripts/actions/workflows/ci.yml/badge.svg)](https://github.com/ARMmbed/continuous-delivery-scripts/actions/workflows/ci.yml)

[![Test Coverage](https://codecov.io/gh/ARMmbed/continuous-delivery-scripts/branch/main/graph/badge.svg?token=EAW9owYyjW)](https://codecov.io/gh/ARMmbed/continuous-delivery-scripts)
[![Maintainability](https://api.codeclimate.com/v1/badges/41301e959f22986b7b2b/maintainability)](https://codeclimate.com/github/ARMmbed/continuous-delivery-scripts/maintainability)

## Overview

Project initially forked from [ARMmbed/mbed-tools-ci-scripts](https://github.com/ARMmbed/continuous-delivery-scripts) but modified so that it can be used for any projects and any languages.
Expand Down
1 change: 1 addition & 0 deletions news/20250627104347.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
♻️ Remove codeclimate file and references
2 changes: 2 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ jaraco-context="MIT"
importlib_metadata="Apache-2.0"
docutils="BSD-3-Clause"
backports-tarfile="MIT"
Markdown="BSD-3-Clause"
id="Apache-2.0"



Expand Down
2 changes: 0 additions & 2 deletions tests/packaging/fixtures/PKG-INFO
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ Description: # Mbed Tools CI Scripts
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/ARMmbed/mbed-tools-ci-scripts/blob/master/LICENSE)

[![Build Status](https://dev.azure.com/mbed-tools/mbed-tools-ci-scripts/_apis/build/status/Build%20and%20Release?branchName=master)](https://dev.azure.com/mbed-tools/mbed-tools-ci/_build/latest?definitionId=3&branchName=master)
[![Test Coverage](https://codecov.io/gh/ARMmbed/mbed-tools-ci-scripts/branch/master/graph/badge.svg)](https://codecov.io/gh/ARMmbed/mbed-tools-ci-scripts)
[![Maintainability](https://api.codeclimate.com/v1/badges/41301e959f22986b7b2b/maintainability)](https://codeclimate.com/github/ARMmbed/mbed-tools-ci-scripts/maintainability)

## Overview

Expand Down
Loading