Skip to content

Add pyproject.toml for the ssg package#12604

Merged
marcusburghardt merged 1 commit into
ComplianceAsCode:masterfrom
vojtapolasek:add_ssg_poetry
Nov 29, 2024
Merged

Add pyproject.toml for the ssg package#12604
marcusburghardt merged 1 commit into
ComplianceAsCode:masterfrom
vojtapolasek:add_ssg_poetry

Conversation

@vojtapolasek
Copy link
Copy Markdown
Collaborator

@vojtapolasek vojtapolasek commented Nov 13, 2024

Description:

  • add pyproject.toml to the repo
  • use setuptools_scm plugin to infer dynamic version from our repo
    • since we are handling tags in an uncommon way, I needed to create a special command for this case. See the comment in the file for explanation.
  • currently the package contains only contents of the ssg folder

Rationale:

  • this enables easier consuming of the ssg library by external contributors. They could use something like
pip install git+https://github.com/ComplianceasCode/content@v0.1.75

How to test

  1. create a new virtual environment with Python >= 3.8
  2. run pip3 install git+https://github.com/vojtapolasek/content@add_ssg_poetry
  3. run python
  4. import ssg.build_yaml
  5. alternatively clone the content repo and try building some product with this ssg package

@openshift-ci openshift-ci Bot added the do-not-merge/work-in-progress Used by openshift-ci bot. label Nov 13, 2024
@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented Nov 13, 2024

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Nov 13, 2024

Start a new ephemeral environment with changes proposed in this pull request:

Fedora Environment
Open in Gitpod

Oracle Linux 8 Environment
Open in Gitpod

@Mab879 Mab879 self-assigned this Nov 13, 2024
@vojtapolasek vojtapolasek force-pushed the add_ssg_poetry branch 3 times, most recently from 4223288 to be4af62 Compare November 26, 2024 10:33
@vojtapolasek vojtapolasek changed the title WIP: add pyproject.toml for the ssg package Add pyproject.toml for the ssg package Nov 26, 2024
@vojtapolasek vojtapolasek marked this pull request as ready for review November 26, 2024 12:27
@openshift-ci openshift-ci Bot removed the do-not-merge/work-in-progress Used by openshift-ci bot. label Nov 26, 2024
@qlty-cloud-legacy
Copy link
Copy Markdown

Code Climate has analyzed commit d5f2628 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 60.9% (0.0% change).

View more on Code Climate.

Comment thread pyproject.toml
Copy link
Copy Markdown
Member

@marcusburghardt marcusburghardt left a comment

Choose a reason for hiding this comment

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

I have tested it in a virtualenv, installing from your fork and it worked fine. I could call and use some functions in very simple tests. I only had some comments to better understand the versions, but so far it is good.

@marcusburghardt marcusburghardt added this to the 0.1.76 milestone Nov 29, 2024
Copy link
Copy Markdown
Member

@marcusburghardt marcusburghardt left a comment

Choose a reason for hiding this comment

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

LGTM. Nice to have this option now.

@marcusburghardt marcusburghardt merged commit 16eaa39 into ComplianceAsCode:master Nov 29, 2024
@marcusburghardt marcusburghardt added Infrastructure Our content build system Highlight This PR/Issue should make it to the featured changelog. labels Nov 29, 2024
@Mab879 Mab879 removed their assignment Nov 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Highlight This PR/Issue should make it to the featured changelog. Infrastructure Our content build system

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants