Skip to content

415 build api documentation as release artifact instead of deploying it directly#417

Merged
popescu-v merged 2 commits intodevfrom
415-build-api-documentation-as-release-artifact-instead-of-deploying-it-directly
Jun 12, 2025
Merged

415 build api documentation as release artifact instead of deploying it directly#417
popescu-v merged 2 commits intodevfrom
415-build-api-documentation-as-release-artifact-instead-of-deploying-it-directly

Conversation

@popescu-v
Copy link
Copy Markdown
Collaborator

@popescu-v popescu-v commented Jun 12, 2025 •
edited
Loading

closes #415

TODO Before Asking for a Review

  • Rebase your branch to the latest version of dev (or main for release PRs)
  • Make sure all CI workflows are green
  • When adding a public feature/fix: Update the Unreleased section of CHANGELOG.md (no date)
  • Self-Review: Review "Files Changed" tab and fix any problems you find
  • API Docs (only if there are changes in docstrings, rst files or samples):
    • Check the docs build without warning: see the log of the API Docs workflow
    • Check that your changes render well in HTML: download the API Docs artifact and open index.html
    • If there are any problems it is faster to iterate by building locally the API Docs

@popescu-v popescu-v linked an issue Jun 12, 2025 that may be closed by this pull request
Build API Documentation as Release Artifact Instead of Deploying It Directly #415
Closed
@popescu-v popescu-v self-assigned this Jun 12, 2025
folmos-at-orange
folmos-at-orange approved these changes Jun 12, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@folmos-at-orange folmos-at-orange left a comment

Choose a reason for hiding this comment

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

I'd squash the first three commits as they are a coherent change set.

.github/workflows/api-docs.yml Outdated
uses: ncipollo/release-action@v1.15.0
with:
allowUpdates: true
artifacts: ./khiops-api-doc-${{ github.ref_name }}.zip
Copy link
Copy Markdown
Member

@folmos-at-orange folmos-at-orange Jun 12, 2025

Choose a reason for hiding this comment

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

I'd name it khiops-api-docs-VERSION.zip (s in docs) so it is named coherently everywhere.

Copy link
Copy Markdown
Collaborator Author

@popescu-v popescu-v Jun 12, 2025

Choose a reason for hiding this comment

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

Done.

@popescu-v
Copy link
Copy Markdown
Collaborator Author

popescu-v commented Jun 12, 2025

I'd squash the first three commits as they are a coherent change set.

I think we are talking about the last three commits, right?

popescu-v added 2 commits June 12, 2025 16:50
@popescu-v
Release the Python documentation as a ZIP archive on Git tags
8e41604 
Stop deploying it directly. khiops-doc would do this.
@popescu-v
Fetch the Khiops Python tutorials in the doc building script
fc0c3e6 
To this end, also:
- make the Khiops Python tutorial repository reference customizable, so
  that we can choose which v10 vs v11 tutorial versions to use when
  building the Python API docs;
- clone the Khiops Python tutorial repository via HTTPS in the doc build
  script, as there is no need for any authentication to clone this.
@popescu-v popescu-v force-pushed the 415-build-api-documentation-as-release-artifact-instead-of-deploying-it-directly branch from c7b7541 to fc0c3e6 Compare June 12, 2025 14:52
@popescu-v
Copy link
Copy Markdown
Collaborator Author

popescu-v commented Jun 12, 2025

I'd squash the first three commits as they are a coherent change set.

I think we are talking about the last three commits, right?

Done.

@popescu-v popescu-v merged commit 2718702 into dev Jun 12, 2025
6 of 14 checks passed
@popescu-v popescu-v deleted the 415-build-api-documentation-as-release-artifact-instead-of-deploying-it-directly branch June 12, 2025 15:22
@popescu-v popescu-v mentioned this pull request Jun 16, 2025
Merged
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@folmos-at-orange folmos-at-orange folmos-at-orange approved these changes

Assignees

@popescu-v popescu-v

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Build API Documentation as Release Artifact Instead of Deploying It Directly

2 participants

@popescu-v @folmos-at-orange