Skip to content
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

Modernize the build step in the build workflow #95

Merged
merged 2 commits into from
May 5, 2022

Conversation

mcdonnnj
Copy link
Member

🗣 Description

This pull request updates the build step of the build workflow to use a more modern process to build the bdist/sdist for a Python package. It also adds dist to the .gitignore file to more cleanly support local building.

💭 Motivation and context

Building Python packages with the setup.py install method has been deprecated for a while now so we should update our package building process to align with PyPa's current process.

🧪 Testing

Automated tests pass. I verified that the artifact contains both a bdist (wheel) and sdist.

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • Changes are limited to a single goal - eschew scope creep!
  • All relevant type-of-change labels have been added.
  • I have read the CONTRIBUTING document.
  • These code changes follow cisagov code standards.
  • All new and existing tests pass.

@mcdonnnj mcdonnnj added the improvement This issue or pull request will add or improve functionality, maintainability, or ease of use label Mar 14, 2022
@mcdonnnj mcdonnnj self-assigned this Mar 14, 2022
Copy link
Member

@dav3r dav3r left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Onward! ⚙️

Though I have one question.

.github/workflows/build.yml Show resolved Hide resolved
Add dist/ to the .gitignore file to better support local building.
Modernize the build process by using the build package instead of the
now deprecated setup.py install method. Remove installing the package
requirements as it is unnecessary for this build process. Upgrade the
setuptools package as part of the initial dependency installation.
@mcdonnnj mcdonnnj merged commit 7dc735b into develop May 5, 2022
@mcdonnnj mcdonnnj deleted the improvement/update_build_process branch May 5, 2022 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement This issue or pull request will add or improve functionality, maintainability, or ease of use
Projects
Development

Successfully merging this pull request may close these issues.

3 participants