Story #6938: As a developer, I have an easy way to check my commit and code locally before pushing - Pulp

Actions

Send by e-mail Copy link

Story #6938

closed

As a developer, I have an easy way to check my commit and code locally before pushing

Added by daviddavis almost 4 years ago. Updated over 2 years ago.

Status:

CLOSED - DUPLICATE

Priority:

Normal

Assignee:

Category:

Sprint/Milestone:

Start date:

Due date:

% Done:

Estimated time:

Platform Release:

Groomed:

Sprint Candidate:

Tags:

Sprint:

Quarter:

Description

Ticket moved to GitHub: "pulp/pulpcore/1903":https://github.com/pulp/pulpcore/issues/1903

I was talking to ggainey about some of the automation checks we have in pulp (commit validation, style/lint checks, changelog, etc) and how it might be frustrating for new devs. I've heard the same feedback from other contributors such as galaxy.

We need to provide an easy way for developers to run our CI checks locally. I've seen other projects (bandersnatch[0], black[1], celery[2], etc) use pre-commit:

https://pre-commit.com/

[0] https://github.com/pypa/bandersnatch/blob/master/.pre-commit-config.yaml

[1] https://github.com/psf/black/blob/master/.pre-commit-config.yaml

[2] https://github.com/celery/celery/blob/master/.pre-commit-config.yaml

Related issues

Actions

Copy link

Updated by daviddavis almost 4 years ago

Description updated (diff)

Actions

Copy link

Updated by ggainey almost 4 years ago

None of the individual bookeeping tasks are bad - they're all great individually - but en masse, they cause a lot of friction for the dev, which is a good way to get people to not-contribute to your project

Consider:

"black/flake"
"check for issue/noissue"
"check for coverage/nocoverage"
"check issue is in project"
"check for CHANGES existence"
"check that CHANGES file has an allowed suffix"

are all checks that happen serially in travis, and which therefore will fail individually. So if you're particularly dense (like I have been on frequent occasions), that can mean SIX separate pushes/builds, just to get to the point where travis will tell you if your code even builds/works.

Actions

Copy link

Updated by fao89 almost 4 years ago

Groomed changed from No to Yes
Sprint Candidate changed from No to Yes

We can start a new directory on plugin_template or use .travis one. It needs to be customizable by plugins, as only pulp_rpm needs [nocoverage]. Maybe calling a script "additional_checks.sh": https://stackoverflow.com/a/59499550 It would be helpful to have a makefile for facilitating setting and using the pre-commit

install:
	pip install --upgrade pip
	pip install -r requirements_dev.txt
	make setup-pre-commit

setup-pre-commit:
	pre-commit install
	pre-commit install-hooks

run-pre-commit:
	rm -rf .tox/
	pre-commit run --files $$(find -regex '.*\.\(py\|yaml\|yml\|md\)') -v

example from: https://github.com/rochacbruno/dynaconf/blob/master/Makefile#L135-L146

Actions

Copy link

Updated by daviddavis almost 4 years ago

Groomed changed from Yes to No
Sprint Candidate changed from Yes to No

Actions

Copy link

Updated by fao89 almost 4 years ago

https://medium.com/@jmarhee/using-pre-commit-and-post-update-git-hooks-10ca8171daf5

Actions

Copy link

Updated by daviddavis almost 4 years ago

Thanks for the article. I posted a small PoC:

https://github.com/daviddavis/pulpcore/commit/eba832370

Actions

Copy link

Updated by fao89 over 3 years ago

I never got the notification, I like your PoC, I think we should be working on it after 3.6

Actions

Copy link

Updated by daviddavis over 3 years ago

One of the problems that was raised today during open floor is that users could have different flake8 plugins installed with different versions. We need to figure out how to handle this issue.

Actions

Copy link