Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/coverage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
cache: true

- name: Install dependencies with multirepo
uses: chipflow/pdm-multirepo@v1
uses: chipflow/pdm-multirepo@v3

- name: Build coverage file
run: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/main.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
cache: true

- name: Install dependencies with multirepo
uses: chipflow/pdm-multirepo@v1
uses: chipflow/pdm-multirepo@v3

- name: Run tests
run: pdm run test
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/preview-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
cache: true

- name: Install dependencies with multirepo
uses: chipflow/pdm-multirepo@v1
uses: chipflow/pdm-multirepo@v3

- name: Build docs
run: pdm docs
Expand Down
12 changes: 10 additions & 2 deletions .github/workflows/test-examples.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,15 @@ jobs:
if: github.event_name == 'pull_request'
run: |
git remote update
git checkout ${{ github.head_ref }} || echo "Falling back to main"
git checkout ${{ github.head_ref }} || echo "${{github.head_ref}} not found, checking base ${{github.base_ref}}"

- name: Check for branch ${{ github.base_ref }}
working-directory: ${{ env.test_repo_path }}
if: github.event_name == 'pull_request'
run: |
git remote update
git checkout ${{ github.base_ref }} || echo "${{github.base_ref}} not found Falling back to main"


- name: Set up PDM
uses: pdm-project/setup-pdm@v4
Expand All @@ -50,7 +58,7 @@ jobs:
cache-dependency-path: './**/pyproject.toml'

- name: Install dependencies with multirepo
uses: chipflow/pdm-multirepo@v1
uses: chipflow/pdm-multirepo@v3
with:
working-directory: ${{ env.test_repo_path }}

Expand Down
21 changes: 3 additions & 18 deletions docs/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ Clone chipflow-examples

.. note::
If you’re familiar with the `Git <https://git-scm.com/>`__ command line
then go clone [ChipFlow/chipflow-examples](https://github.com/ChipFlow/chipflow-examples)
then go clone `ChipFlow/chipflow-examples <https://github.com/ChipFlow/chipflow-examples>`,
switch to the `release branch <https://github.com/ChipFlow/chipflow-examples/tree/release>`,
and jump ahead to `Install the Dependencies`_


Expand All @@ -39,7 +40,7 @@ it you will be asked to sign in or create an account - we recommend you
take this moment to create a GitHub account if you don’t already have
one!

Navigate to `the chipflow-examples repository <https://github.com/ChipFlow/chipflow-examples>`__
Navigate to `the chipflow-examples repository release branch <https://github.com/ChipFlow/chipflow-examples/tree/release>`__
and click the green ‘Code’ button at the top. Select ‘Open with GitHub Desktop’ and
then follow the prompts (N.B. your web browser may have a pop-up to
authorise opening an external app)
Expand Down Expand Up @@ -165,19 +166,3 @@ you can instead call:
.. |Image showing the link to click| image:: _assets/open-github-desktop.png
.. |Image showing where to click in GitHub Desktop to open in VSCode| image:: _assets/github-desktop-open.png


Installation
------------

1. Clone the ChipFlow repository:

.. code-block:: bash

git clone https://github.com/ChipFlow/chipflow-lib.git
cd chipflow-lib

2. Install dependencies using PDM:

.. code-block:: bash

pdm install
Loading
Loading