ref: Move build configuration from `setup.py` to `pyproject.toml`; apply various repo/CI refactors #602

lgarber-akamai · 2024-04-23T16:34:12Z

📝 Description

This change makes the following build system improvements to the Linode CLI:

Moving away from setup.py in favor of setuptools in pyproject.toml
Moving away from the baked_version construct in favor of injecting the version into a new version.py file.
Removing requirements.txt and requirements-dev.txt in favor of pyproject.toml
Removing the logic to automatically bake and install bash completions to /etc/bash_completion.d
- This was discussed internally as a team
Removing the Jenkinsfile (no longer used)
Updating GHA workflows and Dockerfiles accordingly
Updating the OCI publish workflow to not rely on the version script (which was previously removed)

✔️ How to Test

The following test steps assume you have pulled down this PR locally.

Testing Workflows

For convenience I tested all workflows on the main branch of my fork; they can be viewed here:

Testing the Build & Install Process

Run the following command to build & install the CLI:

make install

Ensure the CLI has installed successfully and the installed version matches v0.0.0.dev:

linode-cli --version

# linode-cli 0.0.0.dev0
# Built from spec version 4.174.0

Install the CLI with an overridden version:

LINODE_CLI_VERSION=1.2.3 make install

Ensure the CLI has installed correctly and the installed version matches v0.0.0.dev:

linode-cli --version

# linode-cli 1.2.3
# Built from spec version 4.174.0

Testing the Dockerfile Changes

Create a read-only GitHub Personal Access Token and export it under the GITHUB_TOKEN environment variable.
Run the following command to build the CLI OCI image:

docker build -t local-linode-cli --build-arg linode_cli_version=1.2.3 --build-arg github_token=$GITHUB_TOKEN .

Attempt to execute a CLI command, for example:

docker run --rm -it -e LINODE_CLI_TOKEN=$LINODE_TOKEN local-linode-cli linodes ls

Ensure the command runs as expected.

Unit Testing

make testunit

Integration Testing

make testint

lgarber-akamai · 2024-04-23T16:41:22Z

linodecli/__init__.py

@@ -112,7 +109,7 @@ def main():  # pylint: disable=too-many-branches,too-many-statements
        if not parsed.command:
            # print version info and exit - but only if no command was given
            print(f"linode-cli {VERSION}")
-            print(f"Built off spec version {cli.spec_version}")
+            print(f"Built from spec version {cli.spec_version}")


This isn't really relevant to the rest of these changes but I think this wording is a tiny bit less awkward 🙂

lgarber-akamai · 2024-04-23T16:41:45Z

linodecli/__init__.py

-    VERSION = version("linode-cli")
-except:
-    VERSION = "building"
+VERSION = __version__


This should be much more reliable than grabbing the version from the package itself.

lgarber-akamai · 2024-04-23T17:24:18Z

.github/workflows/publish-oci.yml

@@ -34,13 +34,18 @@ jobs:
      # This is necessary as we want to ensure that version tags
      # are properly formatted before passing them into the
      # DockerFile.
-      - name: Get CLI version


I honestly have no clue how this worked in the last release given we removed the version script beforehand. Regardless, I moved it over to a more reliable solution 🙂

lgarber-akamai · 2024-04-23T17:27:19Z

pyproject.toml

@@ -2,6 +2,51 @@
 requires = ["setuptools", "wheel", "packaging"]
 build-backend = "setuptools.build_meta"

+[project]
+name = "linode-cli"
+authors = [{ name = "Akamai Technologies Inc.", email = "developers@linode.com" }]


Just a note, I swapped this from Linode to Akamai Technologies Inc.

Makefile

tests/unit/test_completion.py

zliang-akamai

Nice work! The code base is much cleaner now. 🎉

ykim-akamai

Nice refactor! LGTM

lgarber-akamai added 2 commits April 23, 2024 11:52

WIP

e041c88

fix dockerfile

e29df77

lgarber-akamai added the improvement for improvements in existing functionality in the changelog. label Apr 23, 2024

various fixes

8abe845

lgarber-akamai commented Apr 23, 2024

View reviewed changes

lgarber-akamai added 2 commits April 23, 2024 13:10

fix OCI release workflow

cef31bd

fix OCI script

c7c9c73

lgarber-akamai commented Apr 23, 2024

View reviewed changes

lgarber-akamai marked this pull request as ready for review April 23, 2024 17:47

lgarber-akamai requested a review from a team as a code owner April 23, 2024 17:47

lgarber-akamai requested review from ykim-akamai and yec-akamai and removed request for a team April 23, 2024 17:47

lgarber-akamai changed the title ~~ref: Move build configuration from setup.py to pyproject.toml; drop Jenkinsfile and requirements.txt~~ ref: Move build configuration from setup.py to pyproject.toml; apply various repo/CI refactors Apr 23, 2024

lgarber-akamai added repo-ci-improvement for improvements in the repository or CI workflow in the changelog. and removed improvement for improvements in existing functionality in the changelog. labels Apr 23, 2024

lgarber-akamai requested a review from zliang-akamai April 23, 2024 17:52

Use dev version for __version__ default

72c8660

zliang-akamai reviewed Apr 25, 2024

View reviewed changes

Makefile Outdated Show resolved Hide resolved

zliang-akamai reviewed Apr 25, 2024

View reviewed changes

tests/unit/test_completion.py Outdated Show resolved Hide resolved

zliang-akamai approved these changes Apr 25, 2024

View reviewed changes

Address feedback

4e04b85

ykim-akamai approved these changes Apr 26, 2024

View reviewed changes

lgarber-akamai merged commit f41b131 into linode:dev Apr 26, 2024
6 checks passed

chenrui333 mentioned this pull request May 1, 2024

linode-cli 5.49.0 Homebrew/homebrew-core#170570

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ref: Move build configuration from `setup.py` to `pyproject.toml`; apply various repo/CI refactors #602

ref: Move build configuration from `setup.py` to `pyproject.toml`; apply various repo/CI refactors #602

lgarber-akamai commented Apr 23, 2024 •

edited

Loading

lgarber-akamai Apr 23, 2024 •

edited

Loading

lgarber-akamai Apr 23, 2024

lgarber-akamai Apr 23, 2024 •

edited

Loading

lgarber-akamai Apr 23, 2024

zliang-akamai left a comment

ykim-akamai left a comment

ref: Move build configuration from setup.py to pyproject.toml; apply various repo/CI refactors #602

ref: Move build configuration from setup.py to pyproject.toml; apply various repo/CI refactors #602

Conversation

lgarber-akamai commented Apr 23, 2024 • edited Loading

📝 Description

✔️ How to Test

Testing Workflows

Testing the Build & Install Process

Testing the Dockerfile Changes

Unit Testing

Integration Testing

lgarber-akamai Apr 23, 2024 • edited Loading

Choose a reason for hiding this comment

lgarber-akamai Apr 23, 2024

Choose a reason for hiding this comment

lgarber-akamai Apr 23, 2024 • edited Loading

Choose a reason for hiding this comment

lgarber-akamai Apr 23, 2024

Choose a reason for hiding this comment

zliang-akamai left a comment

Choose a reason for hiding this comment

ykim-akamai left a comment

Choose a reason for hiding this comment

ref: Move build configuration from `setup.py` to `pyproject.toml`; apply various repo/CI refactors #602

ref: Move build configuration from `setup.py` to `pyproject.toml`; apply various repo/CI refactors #602

lgarber-akamai commented Apr 23, 2024 •

edited

Loading

lgarber-akamai Apr 23, 2024 •

edited

Loading

lgarber-akamai Apr 23, 2024 •

edited

Loading