Skip to content
Open
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
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ To use this template, your repository will need to have a `tox.ini` file.
```yaml
jobs:
test:
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
posargs: '-n 4'
envs: |
Expand All @@ -41,7 +41,7 @@ Build, test and publish a Python source distribution and collection of platform-
```yaml
jobs:
publish:
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish.yml@v2
with:
test_groups: test
test_extras: recommended
Expand All @@ -61,7 +61,7 @@ This the workflow is similar to the `publish.yml` workflow, except, instead of b
```yaml
jobs:
publish:
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v2
with:
test_groups: test
test_extras: recommended
Expand Down
10 changes: 5 additions & 5 deletions docs/source/publish.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ platform-dependent wheels.

jobs:
publish:
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish.yml@v2
with:
test_groups: test, concurrency
test_extras: recommended
Expand Down Expand Up @@ -106,7 +106,7 @@ file into the publishing job.

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish.yml@v2
with:
env: |
VAR1: test
Expand Down Expand Up @@ -142,7 +142,7 @@ extra.

jobs:
build:
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish.yml@v2
with:
env: |
CIBW_BEFORE_BUILD_LINUX: apt install libfftw3-dev
Expand All @@ -166,7 +166,7 @@ with ``v``, and ``'refs/tags/'`` will upload on all pushed tags.

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish.yml@v2
with:
upload_to_pypi: refs/tags/

Expand Down Expand Up @@ -236,7 +236,7 @@ same repository, or when using a non-standard project layout.

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish.yml@v2
with:
working-directory: packages/my-package
test_command: pytest --pyargs my_package
Expand Down
8 changes: 4 additions & 4 deletions docs/source/publish_pure_python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ source distribution are build, tested and published instead.

jobs:
publish:
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v2
with:
test_groups: test, concurrency
test_extras: recommended
Expand Down Expand Up @@ -59,7 +59,7 @@ file into the publishing job.

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v2
with:
env: |
VAR1: test
Expand Down Expand Up @@ -95,7 +95,7 @@ with ``v``, and ``'refs/tags/'`` will upload on all pushed tags.

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v2
with:
upload_to_pypi: refs/tags/

Expand Down Expand Up @@ -153,7 +153,7 @@ same repository, or when using a non-standard project layout.

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v2
with:
working-directory: packages/my-package
test_command: pytest --pyargs my_package
Expand Down
52 changes: 26 additions & 26 deletions docs/source/tox.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs. To use this template, your repository will need to have a

jobs:
test:
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
posargs: '-n 4'
envs: |
Expand Down Expand Up @@ -39,7 +39,7 @@ while ``test2`` will pass ``--arg-global`` to pytest,

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
posargs: '--arg-global'
envs: |
Expand All @@ -54,7 +54,7 @@ Array of tox environments to test. Required input.

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
envs: |
- <os>: <toxenv>
Expand All @@ -71,7 +71,7 @@ Example:

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
envs: |
- linux: pep8
Expand All @@ -96,7 +96,7 @@ Global definition:

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
libraries: |
apt:
Expand Down Expand Up @@ -191,7 +191,7 @@ Global definition:

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
setenv: |
VAR1: test
Expand Down Expand Up @@ -241,15 +241,15 @@ retrieved as usual and cached at the end of the job, however, during the

jobs:
core_test:
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
cache-path: sample_data/
cache-key: sample-${{ github.run_id }}
envs: |
- linux: py39
detailed_tests:
needs: [core_test]
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
cache-path: sample_data/
cache-key: sample-${{ github.run_id }}
Expand Down Expand Up @@ -279,7 +279,7 @@ a separate job:
run: echo "hash=${{ hashFiles('**/compressed_data_urls.json') }}" >> $GITHUB_OUTPUT
tests:
needs: [setup]
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
cache-path: |
sample_data/
Expand Down Expand Up @@ -316,13 +316,13 @@ It can be defined globally:

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
artifact-path: path/output/bin/

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
artifact-path: |
path/output/bin/
Expand All @@ -333,7 +333,7 @@ It can be defined globally:

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
envs: |
- windows: py39
Expand All @@ -359,7 +359,7 @@ It can be defined globally:

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
artifact-path: output.txt
artifact-archive: false
Expand All @@ -368,7 +368,7 @@ or specific to an env:

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
envs: |
- linux: py39
Expand All @@ -387,7 +387,7 @@ It can be defined globally:

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
artifact-path: output/
artifact-include-hidden-files: true
Expand All @@ -396,7 +396,7 @@ or specific to an env:

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
envs: |
- linux: py39
Expand All @@ -419,7 +419,7 @@ It can be defined globally:

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
artifact-path: output/
artifact-if-no-files-found: error
Expand All @@ -428,7 +428,7 @@ or specific to an env:

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
envs: |
- linux: py39
Expand All @@ -448,7 +448,7 @@ It can be defined globally:

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
runs-on: |
linux: ubuntu-18.04
Expand All @@ -457,7 +457,7 @@ It can be defined globally:

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
runs-on: |
macos: macos-10.15
Expand All @@ -470,7 +470,7 @@ be valid YAML.)

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
envs: |
- windows: py39
Expand Down Expand Up @@ -501,7 +501,7 @@ implementation of Python 3.9 will be tested:

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
envs: |
- linux: py311
Expand Down Expand Up @@ -538,7 +538,7 @@ same repository, or when using a non-standard project layout.

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
working-directory: packages/my-package
envs: |
Expand All @@ -557,7 +557,7 @@ Default is ``false``.

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
fill: true
envs: |
Expand All @@ -578,7 +578,7 @@ comma-separated list of platforms. Default is ``linux`` only.

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
fill: true
fill_platforms: linux,macos,windows
Expand All @@ -597,7 +597,7 @@ This is a comma-separated list of factors. Default is none.

.. code:: yaml

uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
with:
fill: true
fill_factors: test,cov
Expand Down
2 changes: 1 addition & 1 deletion docs/source/trusted_publishing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Taking the example from :ref:`oa-ghaw-publish`, we add two new lines:

jobs:
build:
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish.yml@v2
with:
save_artifacts: true
upload_to_pypi: false
Expand Down