Skip to content

Commit

Permalink
MNT: Replace Travis/AppVeyor mentions with GHA
Browse files Browse the repository at this point in the history
  • Loading branch information
dopplershift committed Nov 12, 2024
1 parent 6bdefbc commit e82bc09
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 10 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,8 @@ Some things that will increase the chance that your pull request is accepted:
* Follow [PEP8][pep8] for style. (The `flake8` utility can help with this.)
* Write a [good commit message][commit].

Pull requests will automatically have tests run by Travis. This includes
running both the unit tests as well as the `flake8` code linter.
Pull requests will automatically have tests run by GitHub Actions. This includes
running both the unit tests as well as the `flake8` and `ruff` code linters.

[pep8]: https://pep8.org
[commit]: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Siphon

|Docs| |PyPI| |Conda|

|Travis| |AppVeyor| |CodeCov|
|CodeCov|

|Codacy|

Expand Down
21 changes: 14 additions & 7 deletions docs/developerguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ generated from docstrings, written using the
There are also examples in the ``examples/`` directory.

The documentation is hosted on `GitHub Pages <https://unidata.github.io/siphon>`_. The docs are
built automatically from ``main`` with every build on Travis-CI; every merged PR will
built automatically from ``main`` with every build on GitHub Actions; every merged PR will
have the built docs upload to GitHub Pages. As part of the build, the documentation is also
checked with ``doc8``. To see what the docs will look like, you also need to install the
``sphinx-rtd-theme`` package.
Expand All @@ -116,12 +116,19 @@ checked with ``doc8``. To see what the docs will look like, you also need to ins
Other Tools
-----------

Continuous integration is performed by `Travis CI <https://www.travis-ci.org/Unidata/siphon>`_.
This service runs the unit tests on all support versions, as well as runs against the minimum
package versions. ``flake8`` is also run against the code to check formatting. Travis is also
used to build the documentation and to run the examples to ensure they stay working.

Test coverage is monitored by `Codecov.io <https://codecov.io/github/Unidata/siphon>`_.
Continuous integration is performed by
`GitHub Actions <https://github.com/Unidata/siphon/actions>`_.
This integration runs the unit tests on Linux for all supported versions of Python, as well
as runs against the minimum package versions, using PyPI packages. This also runs against
a (non-exhaustive) matrix of python versions on macOS and Windows. In addition to these tests,
GitHub actions also builds the documentation and runs the examples across multiple platforms
and Python versions, as well as checks for any broken web links. ``flake8`` (along with a
variety of plugins found in ``ci/linting.txt``) and ``ruff`` are also run against the code to
check formatting using another job on GitHub Actions. As part of this linting job, the docs
are also checked using the ``doc8`` tool, and spelling is checked using ``codespell``.
Configurations for these are in a variety of files in ``.github/workflows``.

Test coverage is monitored by `codecov.io <https://codecov.io/github/Unidata/siphon>`_.

---------
Releasing
Expand Down

0 comments on commit e82bc09

Please sign in to comment.