Skip to content

Relativize API links to docs.quantum.ibm.com #2502

Relativize API links to docs.quantum.ibm.com

Relativize API links to docs.quantum.ibm.com #2502

Workflow file for this run

# This code is a Qiskit project.
#
# (C) Copyright IBM 2023.
#
# This code is licensed under the Apache License, Version 2.0. You may
# obtain a copy of this license in the LICENSE file in the root directory
# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
#
# Any modifications or derivative works of this code must retain this
# copyright notice, and modified files need to carry a notice indicating
# that they have been altered from the originals.
# This Action builds the docs in pull requests so that we can view a live preview.
# It uses IBM Cloud to build the Dockerfile at the root of the repository.
#
# Due to security, this can only run on branches of qiskit/docs, i.e. not on forks.
# We skip the actions if running on a fork.
name: Preview
on:
pull_request:
types: [opened, reopened, synchronize, closed]
paths:
- "docs/**/*"
- "public/images/**/*"
jobs:
setup:
if: |
(github.event.action == 'opened' || github.event.action == 'reopened' || github.event.action == 'synchronize') &&
github.event.pull_request.head.repo.full_name == github.repository
uses: Qiskit/gh-actions/.github/workflows/code-engine-preview.yml@main
with:
code_engine_project: qiskit-docs-preview
docker_image_name: qiskit-docs-preview
docker_image_port: "3000"
secrets:
ibmcloud_account: ${{ secrets.IBMCLOUD_ACCOUNT }}
ibmcloud_api_key: ${{ secrets.IBMCLOUD_API_KEY }}
teardown:
if: |
github.event.action == 'closed' &&
github.event.pull_request.head.repo.full_name == github.repository
uses: Qiskit/gh-actions/.github/workflows/code-engine-cleanup.yml@main
with:
code_engine_project: qiskit-docs-preview
docker_image_name: qiskit-docs-preview
secrets:
ibmcloud_account: ${{ secrets.IBMCLOUD_ACCOUNT }}
ibmcloud_api_key: ${{ secrets.IBMCLOUD_API_KEY }}