Skip to content

Commit cc14e57

Browse files
authored
docs: add a workflow to deploy docs on demand and fix an issue (#1211)
Adds a dedicated GitHub Actions workflow to enable on-demand deployment of documentation to GitHub Pages, and fixes a documentation issue. Signed-off-by: behnazh-w <[email protected]>
1 parent cfdfc70 commit cc14e57

File tree

3 files changed

+38
-3
lines changed

3 files changed

+38
-3
lines changed
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Copyright (c) 2025 - 2025, Oracle and/or its affiliates. All rights reserved.
2+
# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
3+
4+
# Builds and deploys documentation to GitHub Pages on demand.
5+
# Although documentation is by default deployed as part of the release process,
6+
# this workflow allows immediate updates for documentation-only changes or urgent fixes.
7+
8+
name: Build and Deploy to GitHub Pages
9+
on: workflow_dispatch
10+
11+
permissions:
12+
contents: read
13+
env:
14+
ARTIFACT_NAME: artifact-ubuntu-latest-python-3.11
15+
16+
jobs:
17+
# Build the artifact.
18+
build:
19+
uses: ./.github/workflows/_build.yaml
20+
permissions:
21+
contents: read
22+
packages: read
23+
24+
# Publish docs to GitHub pages.
25+
github-pages:
26+
needs: [build]
27+
name: Deploy GitHub pages
28+
uses: ./.github/workflows/_deploy-github-pages.yaml
29+
permissions:
30+
contents: read
31+
pages: write
32+
id-token: write
33+
with:
34+
artifact-name: artifact-ubuntu-latest-python-3.11
35+
artifact-sha256: ${{ needs.build.outputs.artifacts-sha256 }}

docs/source/pages/tutorials/rebuild_third_party_artifacts.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
44
.. _tutorial-gen-build-spec:
55

6-
*********************************************************
6+
---------------------------------------------------------
77
Rebuilding Third-Party Artifacts from Source with Macaron
8-
*********************************************************
8+
---------------------------------------------------------
99

1010
In this tutorial, you'll learn how to use Macaron's new ``gen-build-spec`` command to automatically generate build specification (buildspec) files from analyzed software packages.
1111
These buildspecs help document and automate the build process for packages, enabling reproducibility and ease of integration with infrastructures such as `Reproducible Central <https://github.com/jvm-repo-rebuild/reproducible-central>`_. For a more detailed description of this feature, refer to our accepted ASE 2025 Industry Showcase paper: `Unlocking Reproducibility: Automating the Re-Build Process for Open-Source Software <https://arxiv.org/pdf/2509.08204>`_.

src/macaron/build_spec_generator/macaron_db_extractor.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ def compile_sqlite_select_statement(select_statement: Select) -> str:
133133
The equivalent SQLite SELECT statement as a string.
134134
"""
135135
compiled_sqlite = select_statement.compile(
136-
dialect=sqlite.dialect(), # type: ignore
136+
dialect=sqlite.dialect(),
137137
compile_kwargs={"literal_binds": True},
138138
)
139139
return f"\n----- Begin SQLite query \n{str(compiled_sqlite)}\n----- End SQLite query\n"

0 commit comments

Comments
 (0)