updates the Makefile to ensure consistent installations of black and click. #1668

Akshat2Jain · 2023-07-07T13:10:43Z

Description

This PR updates the Makefile to ensure consistent installations of black and click. Currently, the Makefile installs the latest versions, while the CI process installs specific versions mentioned in the versions.cfg file. This PR aligns the installations in the Makefile with the versions specified in the versions.cfg file.

Changes Made

Modified the Makefile to install black and click with the versions mentioned in versions.cfg.
OR
Upgraded the installations of black and click to the latest versions mentioned in versions.cfg.

Reason for the Changes

Ensures consistency between local development and the CI environment.
Aligns installations with the versions specified in versions.cfg.
OR
Benefits from the latest features and bug fixes available in the upgraded versions.

This is pr is realated to #1655

mister-roboto · 2023-07-07T13:10:49Z

@Akshat2Jain thanks for creating this Pull Request and helping to improve Plone!

TL;DR: Finish pushing changes, pass all other checks, then paste a comment:

@jenkins-plone-org please run jobs

To ensure that these changes do not break other parts of Plone, the Plone test suite matrix needs to pass, but it takes 30-60 min. Other CI checks are usually much faster and the Plone Jenkins resources are limited, so when done pushing changes and all other checks pass either start all Jenkins PR jobs yourself, or simply add the comment above in this PR to start all the jobs automatically.

Happy hacking!

netlify · 2023-07-07T13:10:51Z

✅ Deploy Preview for plone-restapi canceled.

Name	Link
🔨 Latest commit	`c1a0883`
🔍 Latest deploy log	https://app.netlify.com/sites/plone-restapi/deploys/64b131688cc6fa0008db25b6

Akshat2Jain · 2023-07-07T13:13:32Z

@wesleybl Plz review

wesleybl · 2023-07-07T14:24:19Z

news/1668.bugfix

@@ -0,0 +1 @@
+updates the Makefile to ensure consistent installations of black and click. @Akshat2Jain


Use the issue number in the file name.

Ops, we don't have an issue.

Use the internal extension.

Sorry but I'm not familiar with that term . what exactly you meant by 'internal extension.'

In the same way that we have the .bugfix, we also have the .internal. The options are here:

https://github.com/plone/plone.restapi/blob/master/pyproject.toml

We use .internal, when the change is interest only to the package developers.

@Akshat2Jain see also https://6.docs.plone.org/contributing/index.html#change-log-entry

there is no issue , so should I name the file as 1668.internal

wesleybl · 2023-07-07T14:25:50Z

Makefile

@@ -44,7 +44,7 @@ update: ## Update Make and Buildout
 bin/buildout: bin/pip
 	bin/pip install --upgrade pip
 	bin/pip install -r requirements-5.2.txt
-	bin/pip install black || true
+	bin/pip install --upgrade click==$(awk '/^click =/{print $NF}' versions.cfg) black==$(awk '/^black =/{print $NF}' versions.cfg) || true


Looks like black wasn't installed:

$ make black if [ -f "bin/black" ]; then bin/black src/ ; fi

Take a look at:

https://stackoverflow.com/questions/30445218/why-does-awk-not-work-correctly-in-a-makefile

Looks like black wasn't installed:

$ make black if [ -f "bin/black" ]; then bin/black src/ ; fi

but it shows black version 23.3.0, so it means black is installed
@wesleybl

It must have been installed before you update the code in the Makefile. You can run a make clean to remove the previous installation. Then if you run make again you will see that black is not installed. The error occurs:

bin/pip install --upgrade click== black== || true ERROR: Could not find a version that satisfies the requirement click== (from versions: 0.1, 0.2, 0.3, 0.4, 0.5, 0.5.1, 0.6, 0.7, 1.0, 1.1, 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 3.0, 3.1, 3.2, 3.3, 4.0, 4.1, 5.0, 5.1, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7.dev0, 6.7, 7.0, 7.1, 7.1.1, 7.1.2, 8.0.0a1, 8.0.0rc1, 8.0.0, 8.0.1, 8.0.2, 8.0.3, 8.0.4, 8.1.0, 8.1.1, 8.1.2, 8.1.3, 8.1.4) ERROR: No matching distribution found for click==

Akshat2Jain · 2023-07-12T09:20:22Z

Hey @wesleybl, I have made the changes, now it installed the correct version from the version.cfg

$ ./bin/black --version
black, 22.3.0 (compiled: yes)

Akshat2Jain · 2023-07-12T09:21:34Z

Hey @stevepiercy, I have changed the file name to 1668.internal

stevepiercy

A grammar fix, and then I approve the news item. I have not tested the Makefile.

stevepiercy · 2023-07-12T09:24:53Z

news/1668.internal

@@ -0,0 +1 @@
+updates the Makefile to ensure consistent installations of black and click. @Akshat2Jain


Suggested change

updates the Makefile to ensure consistent installations of black and click. @Akshat2Jain

Updated the Makefile to ensure consistent installations of black and click. @Akshat2Jain

stevepiercy · 2023-07-12T09:28:09Z

There's a failing test, and I have no idea why it fails: https://github.com/plone/plone.restapi/actions/runs/5529801801/jobs/10088359044?pr=1668#step:10:205

stevepiercy · 2023-07-12T09:52:35Z

And now the failing test passes. ¯\_(ツ)_/¯

wesleybl

LGTM

tisto · 2023-07-12T21:56:01Z

LGTM. Though, I am afraid we currently do not use versions.cfg as far as I can see. I'd suggest including it everywhere and cleaning it up. Or we just use base.cfg to fetch the black versions (seems like the easier way to go for now).

wesleybl · 2023-07-13T02:00:46Z

@tisto you are sure. versions.cfg is not used by buildout. So I'm +1 for revomering versions.cfg.

Looking closer, the buildout doesn't install black. Only the Makefile and the CI. So I think it would be better to create a constraints.txt, and use it in these places. So the install would just be something like:

pip install -c constraints.txt black

This simplifies the installation avoiding complications like:

plone.restapi/.github/workflows/black.yml

Line 25 in 9097cfc

    
           run: pip install click==$(awk '/^click =/{print $NF}' versions.cfg) black==$(awk '/^black =/{print $NF}' versions.cfg)

wesleybl

See: #1668 (comment)

Maybe it's better to create another PR.

wesleybl · 2023-07-14T12:33:51Z

Closed in favor of #1671.

updated makefile

2072214

minor change

1021b64

wesleybl requested changes Jul 7, 2023

View reviewed changes

Akshat2Jain and others added 3 commits July 11, 2023 18:42

Merge branch 'plone:master' into update-makefile

7392106

added new line

475d200

added internal

1358702

Akshat2Jain requested review from wesleybl and stevepiercy July 12, 2023 09:20

stevepiercy requested changes Jul 12, 2023

View reviewed changes

grammer fix

01eccbc

stevepiercy approved these changes Jul 12, 2023

View reviewed changes

wesleybl approved these changes Jul 12, 2023

View reviewed changes

wesleybl requested review from tisto and davisagli July 12, 2023 13:28

wesleybl requested changes Jul 13, 2023

View reviewed changes

Akshat2Jain added 2 commits July 13, 2023 15:21

Merge branch 'plone:master' into update-makefile

6e268c5

Merge branch 'plone:master' into update-makefile

c1a0883

Akshat2Jain mentioned this pull request Jul 14, 2023

Resolve version constraints for black package installation #1671

Merged

wesleybl closed this Jul 14, 2023

Akshat2Jain deleted the update-makefile branch July 14, 2023 16:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

updates the Makefile to ensure consistent installations of black and click. #1668

updates the Makefile to ensure consistent installations of black and click. #1668

Akshat2Jain commented Jul 7, 2023

mister-roboto commented Jul 7, 2023

netlify bot commented Jul 7, 2023 •

edited

Loading

Akshat2Jain commented Jul 7, 2023

wesleybl Jul 7, 2023 •

edited

Loading

Akshat2Jain Jul 7, 2023

wesleybl Jul 7, 2023

stevepiercy Jul 7, 2023

Akshat2Jain Jul 8, 2023

wesleybl Jul 7, 2023

wesleybl Jul 7, 2023

Akshat2Jain Jul 8, 2023 •

edited

Loading

wesleybl Jul 10, 2023 •

edited

Loading

Akshat2Jain commented Jul 12, 2023

Akshat2Jain commented Jul 12, 2023

stevepiercy left a comment

stevepiercy Jul 12, 2023

stevepiercy commented Jul 12, 2023

stevepiercy commented Jul 12, 2023

wesleybl left a comment

tisto commented Jul 12, 2023

wesleybl commented Jul 13, 2023

wesleybl left a comment

wesleybl commented Jul 14, 2023

		@@ -0,0 +1 @@
		updates the Makefile to ensure consistent installations of black and click. @Akshat2Jain

	updates the Makefile to ensure consistent installations of black and click. @Akshat2Jain
	Updated the Makefile to ensure consistent installations of black and click. @Akshat2Jain

updates the Makefile to ensure consistent installations of black and click. #1668

updates the Makefile to ensure consistent installations of black and click. #1668

Conversation

Akshat2Jain commented Jul 7, 2023

Description

Changes Made

Reason for the Changes

mister-roboto commented Jul 7, 2023

netlify bot commented Jul 7, 2023 • edited Loading

✅ Deploy Preview for plone-restapi canceled.

Akshat2Jain commented Jul 7, 2023

wesleybl Jul 7, 2023 • edited Loading

Choose a reason for hiding this comment

Akshat2Jain Jul 7, 2023

Choose a reason for hiding this comment

wesleybl Jul 7, 2023

Choose a reason for hiding this comment

stevepiercy Jul 7, 2023

Choose a reason for hiding this comment

Akshat2Jain Jul 8, 2023

Choose a reason for hiding this comment

wesleybl Jul 7, 2023

Choose a reason for hiding this comment

wesleybl Jul 7, 2023

Choose a reason for hiding this comment

Akshat2Jain Jul 8, 2023 • edited Loading

Choose a reason for hiding this comment

wesleybl Jul 10, 2023 • edited Loading

Choose a reason for hiding this comment

Akshat2Jain commented Jul 12, 2023

Akshat2Jain commented Jul 12, 2023

stevepiercy left a comment

Choose a reason for hiding this comment

stevepiercy Jul 12, 2023

Choose a reason for hiding this comment

stevepiercy commented Jul 12, 2023

stevepiercy commented Jul 12, 2023

wesleybl left a comment

Choose a reason for hiding this comment

tisto commented Jul 12, 2023

wesleybl commented Jul 13, 2023

wesleybl left a comment

Choose a reason for hiding this comment

wesleybl commented Jul 14, 2023

netlify bot commented Jul 7, 2023 •

edited

Loading

wesleybl Jul 7, 2023 •

edited

Loading

Akshat2Jain Jul 8, 2023 •

edited

Loading

wesleybl Jul 10, 2023 •

edited

Loading