Skip to content

Commit 5b64def

Browse files
lwassernamurphy
andcommitted
Fix: edits from @namurphy
Co-authored-by: Nick Murphy <[email protected]> Update ci-tests-data/ci.md Co-authored-by: Nick Murphy <[email protected]> Update ci-tests-data/ci.md Co-authored-by: Nick Murphy <[email protected]> Update ci-tests-data/ci.md Co-authored-by: Nick Murphy <[email protected]> Update ci-tests-data/ci.md Co-authored-by: Nick Murphy <[email protected]> Update ci-tests-data/ci.md Co-authored-by: Nick Murphy <[email protected]> Update ci-tests-data/code-cov.md Co-authored-by: Nick Murphy <[email protected]> Fix: edits from @namurphy to run tests page Co-authored-by: Nick Murphy <[email protected]> Update ci-tests-data/run-tests.md Co-authored-by: Nick Murphy <[email protected]>
1 parent 66a3d50 commit 5b64def

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

ci-tests-data/ci.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@ These workflows include:
88
- Building your documentation
99
- Deploying your documentation to GitHub pages
1010

11-
CI also allows you to automate running workflows across a suite of environments including:
11+
CI allows you to automate running workflows across a suite of environments including:
1212

1313
- environments containing different Python versions and
14-
- different operating systems (Mac, Linux, Unix).
14+
- different operating systems (Mac, Linux, Windows).
1515

1616
### What is Continuous Deployment (CD)?
1717

1818
Continuous deployment (CD) extends the CI process by automating the deployment of code changes to production or staging environments. In the case of your open source tool, CD can be used to:
1919

2020
- Automate publishing to PyPI
21-
- Automate publishing your documentation to github pages or Read the Docs.
21+
- Automate publishing your documentation to GitHub Pages or Read the Docs.
2222

2323
It is also used once your conda-forge recipe is set up to keep your package up to date on conda-forge.
2424

@@ -54,9 +54,9 @@ templates that you can easily use and adapt to your own needs.
5454
:::{admonition} Other platforms that you may run into
5555
:class: info
5656

57-
- [Appveyor:](https://www.appveyor.com/) used to be a goto for running tests on Windows operating systems until GitHub actions evolved to support Windows. AppVeyor has evolved to support other operating systems since Microsoft acquired GitHub.
58-
- [Travis CI:](https://www.travis-ci.com/) Used to be the most common CI platform used in our ecosystem until they dropped free support for open source.
59-
- [CircleCI:](https://circleci.com/) You will still see some people using CircleCI for specific tasks. CircleCi can be useful for automated builds of websites and documentation allowing you to preview the changes to that website in your browser.
57+
- [Appveyor:](https://www.appveyor.com/) used to be a `GOTO` for running tests on Windows operating systems until GitHub actions evolved to support Windows. AppVeyor has evolved to support other operating systems since Microsoft acquired GitHub.
58+
- [Travis CI:](https://www.travis-ci.com/) Had been the most common CI platform used in our ecosystem until they dropped free support for open source.
59+
- [CircleCI:](https://circleci.com/) You will still see some people using CircleCI for specific tasks. CircleCI can be useful for automated builds of websites and documentation allowing you to preview the changes to that website in your browser.
6060
:::
6161

6262
## Embrace automation

ci-tests-data/code-cov.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ A common service for analyzing code coverage is [codecov.io](https://codecov.io/
88
:height: 450px
99
:alt: Screenshot of the code cov service - showing test coverage for the stravalib package. in this image you can see a list of package modules and the associated number of lines and % lines covered by tests. at the top of the image you can see what branch is being evaluated and the path to the repository being shown.
1010
11-
the Code cov platform is a useful tool if you wish to visually track code coverage. Using it you can not only get the same summary information that you can get with **pytest-cov** extension. You can also get a visual representation of what lines are covered by your tests and what lines are not covered. Code cove is mostly useful for evaluating unit tests and/or how much of your package code is "covered. It however will not evaluate things like integration tests and end-to-end workflows. b
11+
the Code cov platform is a useful tool if you wish to visually track code coverage. Using it you can not only get the same summary information that you can get with **pytest-cov** extension. You can also get a visual representation of what lines are covered by your tests and what lines are not covered. Code cove is mostly useful for evaluating unit tests and/or how much of your package code is "covered. It however will not evaluate things like integration tests and end-to-end workflows.
1212
1313
```

ci-tests-data/run-tests.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -135,14 +135,14 @@ tests = ["pytest", "pytest-cov"]
135135

136136
If you have the above setup, then you can use `session.install(".[tests]")` to install your test dependencies.
137137
Notice that below one single nox session allows you to run
138-
your tests on 3 different Python environments (Python 3.9, 3.10 and 3.11).
138+
your tests on 3 different Python environments (Python 3.9, 3.10, 3.11, and 3.12).
139139

140140
```python
141141
import nox
142142

143143
# For this to run you will need to have python3.9, python3.10 and python3.11 installed on your computer. Otherwise nox will skip running tests for whatever versions are missing
144144

145-
@nox.session(python=["3.9", "3.10", "3.11"])
145+
@nox.session(python=["3.9", "3.10", "3.11", "3.12"])
146146
def test(session):
147147

148148
# install
@@ -185,10 +185,10 @@ import nox
185185

186186
# The syntax below allows you to use mamba / conda as your environment manager, if you use this approach you don’t have to worry about installing different versions of Python
187187

188-
@nox.session(venv_backend='mamba', python=["3.9", "3.10", "3.11"])
188+
@nox.session(venv_backend='mamba', python=["3.9", "3.10", "3.11", "3.12"])
189189
def test_mamba(session):
190190
"""Nox function that installs dev requirements and runs
191-
tests on Python 3.9 through 3.11
191+
tests on Python 3.9 through 3.12
192192
"""
193193

194194
# Install dev requirements

0 commit comments

Comments
 (0)