Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bug: Pipeline fails if their is no connection to the versions.json file #987

Closed
tomboehling opened this issue Oct 6, 2022 · 12 comments · Fixed by #993
Closed

Bug: Pipeline fails if their is no connection to the versions.json file #987

tomboehling opened this issue Oct 6, 2022 · 12 comments · Fixed by #993
Labels
impact: block-release Should block a release from happening. Only use if this is a critical problem we don't want to ship kind: bug Something isn't working

Comments

@tomboehling
Copy link

You have implemented a new check that fails if the connection to the file is not possible.

There could be many reasons for a connection error:

  • Restricted access to the url (not possible in pipeline)
  • first run of pipeline
  • file is created later in the pipeline

if urlparse(json_url).scheme in ["http", "https"]:
content = requests.get(json_url).text
else:
content = Path(env.srcdir, json_url).read_text()

@12rambau
Copy link
Collaborator

12rambau commented Oct 6, 2022

I actually added this test to give feedback to the user if the .json file was malformed. As the test is mainly for development purposes (e.g. my dropdown doesn't work what have I done ?) maybe we should discard the test if it's using a distant file ?

@tomboehling
Copy link
Author

I don't know what might be the best solution. If you could deactivate the test for remote files, this will work for me. But I understand your idea of testing the version file.

@12rambau 12rambau added kind: bug Something isn't working impact: block-release Should block a release from happening. Only use if this is a critical problem we don't want to ship labels Oct 7, 2022
@callumforrester
Copy link

I'm unsure if warning immediately is the right thing to do. Maybe it would also be best to add a local failover option, so the docs could always be built offline, or else a config option to disable the warning.

@coretl
Copy link

coretl commented Oct 12, 2022

My workflow is:

This fails to bootstrap at the moment, as the workflow that would push the json can't get far enough to push the json.

I suggest adding an environment variable to allow the checking to be skipped. We would then run the checking locally, but disable it in CI so that the bootstrapping can occur.

@12rambau
Copy link
Collaborator

I'm unsure if warning immediately is the right thing to do. Maybe it would also be best to add a local failover option, so the docs could always be built offline, or else a config option to disable the warning.

The Warnings I'm talking about are Sphinx Warnings, there are not preventing the build of the documentation.

@drammock
Copy link
Collaborator

The Warnings I'm talking about are Sphinx Warnings, there are not preventing the build of the documentation.

I think the problem though is that many CI configurations treat Sphinx warnings as errors, to make sure that things like broken cross-references don't get introduced. This means in a build -> deploy pipeline the deploy step won't happen unless the sphinx build is warning-free not just error-free.

@12rambau
Copy link
Collaborator

12rambau commented Oct 12, 2022

and then what about what we are doing here with expected warnings ?

@drammock
Copy link
Collaborator

and then what about what we are doing here with expected warnings ?

That is for our doc builds. we expect many warnings because we intentionally include the kitchen sink page which has things like broken cross-references on purpose.

For consumers of the theme, this will generally not be the case (no intentional malformed rST), so many projects use the -W flag to sphinx-build which causes sphinx to treat warnings as errors (for the reason I mentioned above).

I'm starting to wonder if I'm not understanding something though. Is it the case that the warning raised by your test in the theme's __init__.py will be caught by sphinx (and possibly elevated to an error if the user used the -W flag)?

@12rambau
Copy link
Collaborator

That is for our doc builds. we expect many warnings because we intentionally include the kitchen sink page which has things like broken cross-references on purpose.

Note that as you mentioned in #937, no shinx warning is raised from the kitchen think (I'm still surprised by this one)

I'm starting to wonder if I'm not understanding something though. Is it the case that the warning raised by your test in the theme's init.py will be caught by sphinx (and possibly elevated to an error if the user used the -W flag)?

At the moment no and that's the main subject of the issue. But I've started #993 to transform regular exceptions into Sphinx warning.

@coretl
Copy link

coretl commented Oct 13, 2022

I'm starting to wonder if I'm not understanding something though. Is it the case that the warning raised by your test in the theme's __init__.py will be caught by sphinx (and possibly elevated to an error if the user used the -W flag)?

Here's an example using the #993 branch with a malformed json file. The logging.warning appears to be caught by sphinx as a warning, and the -W flag promotes it to an error:
https://github.com/epics-containers/epics-containers-cli/actions/runs/3219562432/jobs/5265389325

Without the -W flag it shows as a warning but doesn't fail the build:
https://github.com/epics-containers/epics-containers-cli/actions/runs/3219724805/jobs/5265477373

(the json file in this example really is malformed, I misread the docs about which keys were optional)

coretl added a commit to DiamondLightSource/python3-pip-skeleton that referenced this issue Oct 14, 2022
Pin pydata-sphinx-theme to allow the build to complete
pydata/pydata-sphinx-theme#987
gilesknap pushed a commit to DiamondLightSource/python3-pip-skeleton that referenced this issue Oct 14, 2022
Pin pydata-sphinx-theme to allow the build to complete
pydata/pydata-sphinx-theme#987
@ClementPinard
Copy link

Hello,

to add on the pile, we too had our pipeline broken by upgrading to 0.11.0, because the version switcher was uploaded with the first tag all at once with gitlab pages.

Looks like #993 will solve our issue, thanks !

Any idea when this fix will be installable in a 0.11.1 or 0.12.0 ?

@12rambau
Copy link
Collaborator

12rambau commented Nov 8, 2022

that was the last blocking issue for the next release so very soon

callumforrester added a commit to DiamondLightSource/blueapi that referenced this issue Jan 4, 2023
* Fix make version switcher to use the right key

Pin pydata-sphinx-theme to allow the build to complete
pydata/pydata-sphinx-theme#987

* Add sphinx autobuild

* Use PyPA action for PyPI Publish

Use the official Python Packaging Authority (PyPA) Action to publish to PyPI

* Fix password parameter

* Bump black from 22.8.0 to 22.10.0

Bumps [black](https://github.com/psf/black) from 22.8.0 to 22.10.0.
- [Release notes](https://github.com/psf/black/releases)
- [Changelog](https://github.com/psf/black/blob/main/CHANGES.md)
- [Commits](psf/black@22.8.0...22.10.0)

---
updated-dependencies:
- dependency-name: black
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

* Sanitize ref name for docs version

Translate punctuation and unicode in branch names to _

* move requirements assests to lockfiles zip

* fix .dockerignore, build options

* add check for dirty repo when building wheel

* fix dockerignore to not dirty repo

* fix Github Release assets spec

* Improve tox-direct handling

- Environment variable no longer needs to be set
- All commands run with tox-direct by default
- All environment variables passed through

* Rely on the container less

- Moved wheel and sdist creation to the dist job
- Rely on the test matrix to run tests
- Simplified container build to make minimal for build and runtime
  and use wheel from 'dist': only publish to GHCR for tagged builds
- Create separate requirements-*.txt for each of the test matrix
- Fix actions-gh-pages version and don't run it for dependabot
- Move Dockerfile to .devcontainer and use as context to improve
  build times
- Other minor improvements and simplifications

* Mount ssh & inputrc in mounts list

* Moved config to pyproject.toml

* add version label to container registry push

* Use importlib.metadata to get package version

* Make twine check strict

* Don't check switcher if not published

- pydata-sphinx-theme 0.11 started checking switcher
- this meant you couldn't bootstrap a gh-pages build
- pydata-sphinx-theme 0.12 put in an option not to check
- but we want checking if the file exists
- so only check if we can get the json file
- and suggest user turns pages on if we can't

* Don't use flake8==6 until plugins catch up

john-hen/Flake8-pyproject#12

* Remove flake8 constraint

Also shrink dep list where intermediate
modules are covered by others

* Add agreed upon extensions to customizations

* Add common-utils to dev container features

* Link to condatiners.dev for devcontainer spec

* Remove unused matrix from linkcheck CI

* Add publish to anaconda step

* Remove conda build & publish from CI

* Add YAML type stubs

* Temporarily disable switcher check

* Remove unused import

* Delete dockerfile

* Fix references to skeleton

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Tom Cobb <[email protected]>
Co-authored-by: Garry O'Donnell <garry.o'[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Giles Knap <[email protected]>
Co-authored-by: Giles Knap <[email protected]>
evalott100 pushed a commit to evalott100/event-model that referenced this issue Feb 27, 2023
Pin pydata-sphinx-theme to allow the build to complete
pydata/pydata-sphinx-theme#987
keithralphs pushed a commit to DiamondLightSource/blueapi that referenced this issue Apr 28, 2023
* Fix make version switcher to use the right key

Pin pydata-sphinx-theme to allow the build to complete
pydata/pydata-sphinx-theme#987

* Add sphinx autobuild

* Use PyPA action for PyPI Publish

Use the official Python Packaging Authority (PyPA) Action to publish to PyPI

* Fix password parameter

* Bump black from 22.8.0 to 22.10.0

Bumps [black](https://github.com/psf/black) from 22.8.0 to 22.10.0.
- [Release notes](https://github.com/psf/black/releases)
- [Changelog](https://github.com/psf/black/blob/main/CHANGES.md)
- [Commits](psf/black@22.8.0...22.10.0)

---
updated-dependencies:
- dependency-name: black
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

* Sanitize ref name for docs version

Translate punctuation and unicode in branch names to _

* move requirements assests to lockfiles zip

* fix .dockerignore, build options

* add check for dirty repo when building wheel

* fix dockerignore to not dirty repo

* fix Github Release assets spec

* Improve tox-direct handling

- Environment variable no longer needs to be set
- All commands run with tox-direct by default
- All environment variables passed through

* Rely on the container less

- Moved wheel and sdist creation to the dist job
- Rely on the test matrix to run tests
- Simplified container build to make minimal for build and runtime
  and use wheel from 'dist': only publish to GHCR for tagged builds
- Create separate requirements-*.txt for each of the test matrix
- Fix actions-gh-pages version and don't run it for dependabot
- Move Dockerfile to .devcontainer and use as context to improve
  build times
- Other minor improvements and simplifications

* Mount ssh & inputrc in mounts list

* Moved config to pyproject.toml

* add version label to container registry push

* Use importlib.metadata to get package version

* Make twine check strict

* Don't check switcher if not published

- pydata-sphinx-theme 0.11 started checking switcher
- this meant you couldn't bootstrap a gh-pages build
- pydata-sphinx-theme 0.12 put in an option not to check
- but we want checking if the file exists
- so only check if we can get the json file
- and suggest user turns pages on if we can't

* Don't use flake8==6 until plugins catch up

john-hen/Flake8-pyproject#12

* Remove flake8 constraint

Also shrink dep list where intermediate
modules are covered by others

* Add agreed upon extensions to customizations

* Add common-utils to dev container features

* Link to condatiners.dev for devcontainer spec

* Remove unused matrix from linkcheck CI

* Add publish to anaconda step

* Remove conda build & publish from CI

* Add YAML type stubs

* Temporarily disable switcher check

* Remove unused import

* Delete dockerfile

* Fix references to skeleton

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Tom Cobb <[email protected]>
Co-authored-by: Garry O'Donnell <garry.o'[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Giles Knap <[email protected]>
Co-authored-by: Giles Knap <[email protected]>
GDYendell added a commit to epics-containers/pvi that referenced this issue Jul 14, 2023
* Squash all into new skeleton base commit

* switch org to DiamondLightSource

* Bump actions/checkout from 2 to 3

Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 3.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v2...v3)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>

* Bump black from 22.6.0 to 22.8.0

Bumps [black](https://github.com/psf/black) from 22.6.0 to 22.8.0.
- [Release notes](https://github.com/psf/black/releases)
- [Changelog](https://github.com/psf/black/blob/main/CHANGES.md)
- [Commits](psf/black@22.6.0...22.8.0)

---
updated-dependencies:
- dependency-name: black
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

* fix twine command

* obscure the docs cleanup email

* Made tox faster with tox-direct

* Switch to pydata-theme and split docs

There are now developer and user guides. The version switcher is native
to the theme so added a script to generate it.

* Run sdist install in container workflow

This saves another runner starting up just for this

* Update CI badges

* Update code.yml

Fixing a bug that occurs when releasing. (This is already fixed in the skeleton-cli project but failed to get copied to skeleton).

* Update .github/workflows/code.yml

Co-authored-by: Tom C (DLS) <[email protected]>

* Fix make version switcher to use the right key

Pin pydata-sphinx-theme to allow the build to complete
pydata/pydata-sphinx-theme#987

* Add sphinx autobuild

* Use PyPA action for PyPI Publish

Use the official Python Packaging Authority (PyPA) Action to publish to PyPI

* Fix password parameter

* Bump black from 22.8.0 to 22.10.0

Bumps [black](https://github.com/psf/black) from 22.8.0 to 22.10.0.
- [Release notes](https://github.com/psf/black/releases)
- [Changelog](https://github.com/psf/black/blob/main/CHANGES.md)
- [Commits](psf/black@22.8.0...22.10.0)

---
updated-dependencies:
- dependency-name: black
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

* Sanitize ref name for docs version

Translate punctuation and unicode in branch names to _

* move requirements assests to lockfiles zip

* fix .dockerignore, build options

* add check for dirty repo when building wheel

* fix dockerignore to not dirty repo

* fix Github Release assets spec

* Improve tox-direct handling

- Environment variable no longer needs to be set
- All commands run with tox-direct by default
- All environment variables passed through

* Rely on the container less

- Moved wheel and sdist creation to the dist job
- Rely on the test matrix to run tests
- Simplified container build to make minimal for build and runtime
  and use wheel from 'dist': only publish to GHCR for tagged builds
- Create separate requirements-*.txt for each of the test matrix
- Fix actions-gh-pages version and don't run it for dependabot
- Move Dockerfile to .devcontainer and use as context to improve
  build times
- Other minor improvements and simplifications

* Mount ssh & inputrc in mounts list

* Moved config to pyproject.toml

* add version label to container registry push

* Use importlib.metadata to get package version

* Make twine check strict

* Don't check switcher if not published

- pydata-sphinx-theme 0.11 started checking switcher
- this meant you couldn't bootstrap a gh-pages build
- pydata-sphinx-theme 0.12 put in an option not to check
- but we want checking if the file exists
- so only check if we can get the json file
- and suggest user turns pages on if we can't

* Don't use flake8==6 until plugins catch up

john-hen/Flake8-pyproject#12

* Remove flake8 constraint

Also shrink dep list where intermediate
modules are covered by others

* Add agreed upon extensions to customizations

* Add common-utils to dev container features

* Link to condatiners.dev for devcontainer spec

* Remove unused matrix from linkcheck CI

* Add publish to anaconda step

* Remove conda build & publish from CI

* Stop checking switcher in docs build

* Bump softprops/action-gh-release from 0.1.14 to 0.1.15

Bumps [softprops/action-gh-release](https://github.com/softprops/action-gh-release) from 0.1.14 to 0.1.15.
- [Release notes](https://github.com/softprops/action-gh-release/releases)
- [Changelog](https://github.com/softprops/action-gh-release/blob/master/CHANGELOG.md)
- [Commits](softprops/action-gh-release@1e07f43...de2c0eb)

---
updated-dependencies:
- dependency-name: softprops/action-gh-release
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

* Bump peaceiris/actions-gh-pages from 3.9.0 to 3.9.1

Bumps [peaceiris/actions-gh-pages](https://github.com/peaceiris/actions-gh-pages) from 3.9.0 to 3.9.1.
- [Release notes](https://github.com/peaceiris/actions-gh-pages/releases)
- [Changelog](https://github.com/peaceiris/actions-gh-pages/blob/main/CHANGELOG.md)
- [Commits](peaceiris/actions-gh-pages@de7ea6f...64b46b4)

---
updated-dependencies:
- dependency-name: peaceiris/actions-gh-pages
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

* simplify local container workflow

* add how to do pin requirements doc

* add local container testing docs

* Fix reference to non-existent setup.cfg file

* changed to use '[dev]' instead of [dev] in the docs

* Removed scheduled job in code.yaml and added keepalive-workflow

* Added the link to autogenerate precommit

* Made suggested changes

* Add explicit dependency on pytest

* Made changes

* Add python 3.7 support

* Include link in dev install tutorial to epics-containers devcontainer page

* Improve container build workflow

This will test the container before it is pushed to GHCR

* Changed coverage parameters

* Added vscode settings

* Slight changes to the sed command, and ensuring output is utf-8 on windows

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Tom Cobb <[email protected]>
Co-authored-by: Giles Knap <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Tom C (DLS) <[email protected]>
Co-authored-by: Garry O'Donnell <garry.o'[email protected]>
Co-authored-by: Giles Knap <[email protected]>
Co-authored-by: Callum Forrester <[email protected]>
Co-authored-by: tizayi <[email protected]>
Co-authored-by: AlexWells <[email protected]>
Co-authored-by: Eva Lott <[email protected]>
Co-authored-by: Joshua Appleby <[email protected]>
MichaelRoytman added a commit to openedx-unsupported/edx-analytics-data-api that referenced this issue Oct 27, 2023
False was the default value for navigation_with_keys. However, in version 0.14.2 of pydata-sphinx-theme, this default was removed and a warning was added that would be emitted whenever navigation_with_keys was not set. Because of the "SPHINXOPTS = -W" configuration in tox.ini, all warnings are promoted to an error. Therefore, it's necesary to set this value. I have set it to the default value explicitly.

Please see the following GitHub comments for context.
* pydata/pydata-sphinx-theme#1539
* pydata/pydata-sphinx-theme#987 (comment)
MichaelRoytman added a commit to openedx-unsupported/edx-analytics-dashboard that referenced this issue Oct 27, 2023
False was the default value for navigation_with_keys. However, in version 0.14.2 of pydata-sphinx-theme, this default was removed and a warning was added that would be emitted whenever navigation_with_keys was not set. Because of the "SPHINXOPTS = -W" configuration in tox.ini, all warnings are promoted to an error. Therefore, it's necesary to set this value. I have set it to the default value explicitly.

Please see the following GitHub comments for context.
* pydata/pydata-sphinx-theme#1539
* pydata/pydata-sphinx-theme#987 (comment)
MichaelRoytman added a commit to openedx-unsupported/edx-analytics-data-api that referenced this issue Oct 27, 2023
False was the default value for navigation_with_keys. However, in version 0.14.2 of pydata-sphinx-theme, this default was removed and a warning was added that would be emitted whenever navigation_with_keys was not set. Because of the "SPHINXOPTS = -W" configuration in tox.ini, all warnings are promoted to an error. Therefore, it's necesary to set this value. I have set it to the default value explicitly.

Please see the following GitHub comments for context.
* pydata/pydata-sphinx-theme#1539
* pydata/pydata-sphinx-theme#987 (comment)
MichaelRoytman added a commit to openedx-unsupported/edx-analytics-data-api that referenced this issue Oct 27, 2023
False was the default value for navigation_with_keys. However, in version 0.14.2 of pydata-sphinx-theme, this default was removed and a warning was added that would be emitted whenever navigation_with_keys was not set. Because of the "SPHINXOPTS = -W" configuration in tox.ini, all warnings are promoted to an error. Therefore, it's necesary to set this value. I have set it to the default value explicitly.

Please see the following GitHub comments for context.
* pydata/pydata-sphinx-theme#1539
* pydata/pydata-sphinx-theme#987 (comment)
MichaelRoytman added a commit to openedx-unsupported/edx-analytics-data-api that referenced this issue Oct 30, 2023
False was the default value for navigation_with_keys. However, in version 0.14.2 of pydata-sphinx-theme, this default was removed and a warning was added that would be emitted whenever navigation_with_keys was not set. Because of the "SPHINXOPTS = -W" configuration in tox.ini, all warnings are promoted to an error. Therefore, it's necesary to set this value. I have set it to the default value explicitly.

Please see the following GitHub comments for context.
* pydata/pydata-sphinx-theme#1539
* pydata/pydata-sphinx-theme#987 (comment)
MichaelRoytman added a commit to openedx-unsupported/edx-analytics-data-api that referenced this issue Oct 30, 2023
False was the default value for navigation_with_keys. However, in version 0.14.2 of pydata-sphinx-theme, this default was removed and a warning was added that would be emitted whenever navigation_with_keys was not set. Because of the "SPHINXOPTS = -W" configuration in tox.ini, all warnings are promoted to an error. Therefore, it's necesary to set this value. I have set it to the default value explicitly.

Please see the following GitHub comments for context.
* pydata/pydata-sphinx-theme#1539
* pydata/pydata-sphinx-theme#987 (comment)
GDYendell added a commit to epics-containers/pvi that referenced this issue Nov 29, 2023
* Squash all into new skeleton base commit

* switch org to DiamondLightSource

* Bump actions/checkout from 2 to 3

Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 3.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v2...v3)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>

* Bump black from 22.6.0 to 22.8.0

Bumps [black](https://github.com/psf/black) from 22.6.0 to 22.8.0.
- [Release notes](https://github.com/psf/black/releases)
- [Changelog](https://github.com/psf/black/blob/main/CHANGES.md)
- [Commits](psf/black@22.6.0...22.8.0)

---
updated-dependencies:
- dependency-name: black
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

* fix twine command

* obscure the docs cleanup email

* Made tox faster with tox-direct

* Switch to pydata-theme and split docs

There are now developer and user guides. The version switcher is native
to the theme so added a script to generate it.

* Run sdist install in container workflow

This saves another runner starting up just for this

* Update CI badges

* Update code.yml

Fixing a bug that occurs when releasing. (This is already fixed in the skeleton-cli project but failed to get copied to skeleton).

* Update .github/workflows/code.yml

Co-authored-by: Tom C (DLS) <[email protected]>

* Fix make version switcher to use the right key

Pin pydata-sphinx-theme to allow the build to complete
pydata/pydata-sphinx-theme#987

* Add sphinx autobuild

* Use PyPA action for PyPI Publish

Use the official Python Packaging Authority (PyPA) Action to publish to PyPI

* Fix password parameter

* Bump black from 22.8.0 to 22.10.0

Bumps [black](https://github.com/psf/black) from 22.8.0 to 22.10.0.
- [Release notes](https://github.com/psf/black/releases)
- [Changelog](https://github.com/psf/black/blob/main/CHANGES.md)
- [Commits](psf/black@22.8.0...22.10.0)

---
updated-dependencies:
- dependency-name: black
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

* Sanitize ref name for docs version

Translate punctuation and unicode in branch names to _

* move requirements assests to lockfiles zip

* fix .dockerignore, build options

* add check for dirty repo when building wheel

* fix dockerignore to not dirty repo

* fix Github Release assets spec

* Improve tox-direct handling

- Environment variable no longer needs to be set
- All commands run with tox-direct by default
- All environment variables passed through

* Rely on the container less

- Moved wheel and sdist creation to the dist job
- Rely on the test matrix to run tests
- Simplified container build to make minimal for build and runtime
  and use wheel from 'dist': only publish to GHCR for tagged builds
- Create separate requirements-*.txt for each of the test matrix
- Fix actions-gh-pages version and don't run it for dependabot
- Move Dockerfile to .devcontainer and use as context to improve
  build times
- Other minor improvements and simplifications

* Mount ssh & inputrc in mounts list

* Moved config to pyproject.toml

* add version label to container registry push

* Use importlib.metadata to get package version

* Make twine check strict

* Don't check switcher if not published

- pydata-sphinx-theme 0.11 started checking switcher
- this meant you couldn't bootstrap a gh-pages build
- pydata-sphinx-theme 0.12 put in an option not to check
- but we want checking if the file exists
- so only check if we can get the json file
- and suggest user turns pages on if we can't

* Don't use flake8==6 until plugins catch up

john-hen/Flake8-pyproject#12

* Remove flake8 constraint

Also shrink dep list where intermediate
modules are covered by others

* Add agreed upon extensions to customizations

* Add common-utils to dev container features

* Link to condatiners.dev for devcontainer spec

* Remove unused matrix from linkcheck CI

* Add publish to anaconda step

* Remove conda build & publish from CI

* Stop checking switcher in docs build

* Bump softprops/action-gh-release from 0.1.14 to 0.1.15

Bumps [softprops/action-gh-release](https://github.com/softprops/action-gh-release) from 0.1.14 to 0.1.15.
- [Release notes](https://github.com/softprops/action-gh-release/releases)
- [Changelog](https://github.com/softprops/action-gh-release/blob/master/CHANGELOG.md)
- [Commits](softprops/action-gh-release@1e07f43...de2c0eb)

---
updated-dependencies:
- dependency-name: softprops/action-gh-release
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

* Bump peaceiris/actions-gh-pages from 3.9.0 to 3.9.1

Bumps [peaceiris/actions-gh-pages](https://github.com/peaceiris/actions-gh-pages) from 3.9.0 to 3.9.1.
- [Release notes](https://github.com/peaceiris/actions-gh-pages/releases)
- [Changelog](https://github.com/peaceiris/actions-gh-pages/blob/main/CHANGELOG.md)
- [Commits](peaceiris/actions-gh-pages@de7ea6f...64b46b4)

---
updated-dependencies:
- dependency-name: peaceiris/actions-gh-pages
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

* simplify local container workflow

* add how to do pin requirements doc

* add local container testing docs

* Fix reference to non-existent setup.cfg file

* changed to use '[dev]' instead of [dev] in the docs

* Removed scheduled job in code.yaml and added keepalive-workflow

* Added the link to autogenerate precommit

* Made suggested changes

* Add explicit dependency on pytest

* Made changes

* Add python 3.7 support

* Include link in dev install tutorial to epics-containers devcontainer page

* Improve container build workflow

This will test the container before it is pushed to GHCR

* Changed coverage parameters

* Added vscode settings

* Slight changes to the sed command, and ensuring output is utf-8 on windows

* Remove trailing spaces and rationalise newlines

Some tools remove trailing whitespace by default on save, so may as well
correct the originals.
Ensures every file ends with an empty blank line. Again some tools do
this automatically.

* Use ruff as a linter as a replacement for flake8/isort

* Bump docker/build-push-action from 3 to 5

Bumps [docker/build-push-action](https://github.com/docker/build-push-action) from 3 to 5.
- [Release notes](https://github.com/docker/build-push-action/releases)
- [Commits](docker/build-push-action@v3...v5)

---
updated-dependencies:
- dependency-name: docker/build-push-action
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>

* Bump actions/checkout from 3 to 4

Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v3...v4)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>

* Bump docker/login-action from 2 to 3

Bumps [docker/login-action](https://github.com/docker/login-action) from 2 to 3.
- [Release notes](https://github.com/docker/login-action/releases)
- [Commits](docker/login-action@v2...v3)

---
updated-dependencies:
- dependency-name: docker/login-action
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>

* Bump docker/metadata-action from 4 to 5

Bumps [docker/metadata-action](https://github.com/docker/metadata-action) from 4 to 5.
- [Release notes](https://github.com/docker/metadata-action/releases)
- [Upgrade guide](https://github.com/docker/metadata-action/blob/master/UPGRADE.md)
- [Commits](docker/metadata-action@v4...v5)

---
updated-dependencies:
- dependency-name: docker/metadata-action
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>

* Bump docker/setup-buildx-action from 2 to 3

Bumps [docker/setup-buildx-action](https://github.com/docker/setup-buildx-action) from 2 to 3.
- [Release notes](https://github.com/docker/setup-buildx-action/releases)
- [Commits](docker/setup-buildx-action@v2...v3)

---
updated-dependencies:
- dependency-name: docker/setup-buildx-action
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>

* (#153) Fix docs build by providing default arg

* Fixes for latest skeleton

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Tom Cobb <[email protected]>
Co-authored-by: Giles Knap <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Tom C (DLS) <[email protected]>
Co-authored-by: Garry O'Donnell <garry.o'[email protected]>
Co-authored-by: Giles Knap <[email protected]>
Co-authored-by: Callum Forrester <[email protected]>
Co-authored-by: tizayi <[email protected]>
Co-authored-by: AlexWells <[email protected]>
Co-authored-by: Eva Lott <[email protected]>
Co-authored-by: Joshua Appleby <[email protected]>
Co-authored-by: Tom Willemsen <[email protected]>
Co-authored-by: Dominic Oram <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact: block-release Should block a release from happening. Only use if this is a critical problem we don't want to ship kind: bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants