openastronomy/azure-pipelines-templates

An opinionated set of Azure Pipelines templates for Python projects using pyproject.toml (PEP517) and tox

openastronomy

General repo

azure-pipelines-templates's Issues

Allow tox version to be specified

Allow a version to passed to the tox install command:

azure-pipelines-templates/run-tox-env.yml

Lines 188 to 191 in 7f70d92

	- ${{ if variables.docker_image }}:
	- script: docker exec -i -w /project ${{ variables.docker_name }} ${{ variables.setarch }} ${{ variables.docker_python_exec }} -m pip install --upgrade tox ${{ variables.toxdeps }}
	displayName: Install tox

azure-pipelines-templates/run-tox-env.yml

Lines 196 to 199 in 7f70d92

	- ${{ if not(variables.docker_image) }}:
	- script: python -m pip install --upgrade tox ${{ variables.toxdeps }}
	displayName: Install tox

An image label with the label Ubuntu16 does not exist

Saw this over at https://dev.azure.com/astropy-project/astropy/_build/results?buildId=2101&view=logs&j=41002f1b-2888-5a9a-5d7c-5be463c64c96 .

##[warning]An image label with the label Ubuntu16 does not exist.
,##[error]The remote provider was unable to process the request.

Mention about triggering builds on tags on Azure

We should mention that:

trigger:
  branches:
    include:
    - '*'
  tags:
    include:
    - '*'

is needed.

Reduce duplication between sdist and wheels_universal

At the moment there's a fair amount of duplication, so we could probably be smart and make it more concise.

Provide some way of building against multiple manylinux images

cibuildwheel has a default build image for manylinux wheels, currently it's manylinux2010. There are a number of env vars which allow you to specify which image to use (https://cibuildwheel.readthedocs.io/en/stable/options/#manylinux-image) but building multiple of them would involve two jobs with different values I think.

Allow installing from brew cask?

Currently one can do

jobs:
- template: run-tox-env.yml@OpenAstronomy
  parameters:
    libraries:
      brew:
        - gfortran

But in this example installing gfortran doesn't work, because it needs to install from cask (ie. brew cask install gfortran). It would be nice if there was an option to install packages using brew cask.

Allow PublishTestResults to be skipped

Currently PublishTestResults is always run in the tox template, but this doesn't make sense for e.g. pep8 or docs builds, so it might be good to have a way to control this.

Build aarch64 wheels

Wheels for aarch64 are very desirable because ARM can be more cost-effective for cloud computing (e.g. AWS Graviton EC2 instance types). PyPI, pip, manylinux, and cibuildwheel have all supported aarch64 for some time now.

By and large, free CI services are not yet providing aarch64 runners. However, cibuildwheel can automatically build wheels for non-native archs using qemu:

--archs ARCHS         Comma-separated list of CPU architectures to build
                      for. When set to 'auto', builds the architectures
                      natively supported on this machine. Set this option to
                      build an architecture via emulation, for example,
                      using binfmt_misc and QEMU. Default: auto. Choices:
                      auto, native, all, x86_64, i686, aarch64, ppc64le,
                      s390x, x86, AMD64

It should be as simple as setting CIBW_ARCHS="x86_64 aarch64".

Provide a way to opt-in to conda without requiring conda in tox env name

There are cases where we might want to opt in to having conda envs without having to modify the tox.ini file to understand the -conda part of the env name, so maybe we could have a way of specifying conda: true for a job as an alternative to having -conda in the env name.

Need scheduled cron job

See astropy/extension-helpers#20 . Scheduled cron job is important, especially for low-traffic packages.

Future of default branch naming

Do you have plans to rename the default branch here? I see that it is hardcoded in https://github.com/astropy/astropy/blob/0a29184ea1d5fdc2876e9dd3294c56e32287e0a5/azure-pipelines.yml#L11 . So if you change it, please open PR downstream. Thanks!

Add a parameter for setting posargs to give to tox

We need to be able to do:

jobs:

- template: template@repo
  parameters:
    envs:
    - linux: pep8
      posargs: -n=4
    - macosx: py37-test

Add optional support for reading a set of package pins from somewhere?

Do we want to add a way of using tox-pypi-filter like ci-helpers?

Provide the ability to override container for linux

For aas-timeseries we use a custom container for better reproducibility of image tests (and for astropy too). Should be easy to do.

Don't set posargs for docs builds

Currently the junit etc. arguments get passed to tox for any environment, but we don't want this for non-test builds. I'm not sure what the correct way is to deal with this, but just something to think about, otherwise we can't have {posargs} for non-pytest envs.

Add some quick exit thing for [ci skip]?

We could add something here which insta-passes the build if [ci skip] etc are in the commit message? We could even add the ability to have an individual skip for each build?

Allow xvfb to be specified per job

Currently we are a bit inconsistent in which things can be set at job level and which ones globally. I think we should add xvfb to the job level.

Add support for 32-bit linux

For several astropy packages I'd like to keep testing 32-bit linux. It might be a bit trickier to do this and we might need a special branch in the template, but I think it'd be worth it! We could always explicitly not support e.g. conda on there.

Allow overriding of the default vmImage

See #29

Add support for [ci skip]

If Azure's not doing it, we should!

Coverage reports appear to not upload on windows

i.e. https://dev.azure.com/sunpy/sunpy/_build/results?buildId=3608&view=logs&j=7073c21a-1e55-56ea-46de-8524ee585145&t=f2527250-f666-5be7-f464-0fc35397368d&l=48

Specifying libraries for a specific env seems broken.

See https://dev.azure.com/OpenAstronomy/azure-pipelines-templates/_build/results?buildId=282&view=results and associated branch

Add release steps for Javascript component of widget packages

It would be good to add the option to publish the JS part of Jupyter widget packages - this would be useful for WWT and other similar packages.

Add Xvfb option for publish template

This is needed to run tests there in some cases - but I'll need to look into how to use task templates to avoid too much duplication.

Explain why submodules: false might be needed

For astropy core I had to set submodules: false but I don't understand why Azure wasn't able to check out the submodule. We should probably explain in the docs why this is needed.

conda on macos with Python 3.10 seems broken (and it's now the default)

I have modified our tests to avoid this issue but we should investigate.

Build here: https://dev.azure.com/OpenAstronomy/azure-pipelines-templates/_build/results?buildId=516&view=logs&j=8c100718-7b30-5727-c5dc-a891c555a9cc&t=b3c64b5b-c20a-5492-7af8-1101bd91adb4&l=79

For PyPI endpoint, need to keep 'allow all pipelines to use' checked

I unchecked the option 'allow all pipelines to use' but then couldn't easily allow the pipeline I added to use the PyPI endpoint, so it's simple to just keep this checked. Should mention this in the docs.

Add support for wheels_universal

We should add the option to specify universal wheels as a target

Document how to set codecov token

Specifically CODECOV_TOKEN as a secret variable

Is conda really necessary?

Why use conda?

Wrong conditional statement in documentation

The following statement from the documentation does not work.

    ${{ if startsWith(variables['Build.SourceBranch'], 'refs/tags/v') }}:

Need to be replaced with this.

    ${{ if startsWith(variables.Build.SourceBranch, 'refs/tags/v') }}:

Allow posargs to be specified globally

Currently we are a bit inconsistent in which things can be set at job level and which ones globally. I think we should add posargs to the global level.

Document how to make PyPI upload optional

Update documentation for tox template

We need to update the README!

Document how to solve SSL issues on 32-bit

Need to add the following to tox.ini:

passenv =
    SSL_CERT_FILE

BUG: tox 4 and python3.7 version issue on windows

See log here:

https://dev.azure.com/astropy-project/pytest-filter-subpackage/_build/results?buildId=6322&view=logs&j=9bbf82d2-fa3a-5bea-3ec4-b956cbc3af4b&t=fa1134d3-5c1e-5fbb-ecc5-74015be7b54e

Building wheels with auditwheel and external libraries?

I was trying to build wheels for sunkit-image which requires an external dependency on fftw3 (sunpy/sunkit-image#41) and was unable to pass through the libraries for it (which I can pass into for the tests).

I would also require auditwheel (https://github.com/pypa/auditwheel) to repair the wheel after creation. I see that cibuildwheels in the last version has added support for calling repair but I would need to still be able to install libraries at the publish stage.

Is this possible right now or something that would need to be added?