Skip to content

Commit 430204b

Browse files
authored
Merge pull request #385 from pyOpenSci/doc/github-actions
docs: fix typos GitHub action -> GitHub Actions
2 parents 823db4e + b8750cb commit 430204b

File tree

6 files changed

+8
-8
lines changed

6 files changed

+8
-8
lines changed

TRANSLATING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ When you submit a PR for a translation, you should only include changes to one l
265265

266266
Translations PRs will be tagged with a label indicating the language to make them easier to identify and review. For example, contributions to the Spanish translation will be tagged with 'lang-es'.
267267

268-
TODO: This tagging could be automated with a GitHub action.
268+
TODO: This tagging could be automated with a GitHub Actions.
269269

270270
When you submit the PR, make sure to include a short description of the changes you made and any context that might be helpful for the reviewer (e.g., you translated new strings, you reviewed fuzzy entries, you fixed typos, etc.)
271271

package-structure-code/python-package-versions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ package versions:
105105
### Semantic release, vs version control based vs manual version bumping
106106

107107
Generally semantic release and version control system tools
108-
can be setup to run automatically on GitHub using GitHub actions.
108+
can be setup to run automatically on GitHub using GitHub Actions.
109109
This means that you can create a workflow where a GitHub release
110110
and associated new version tag is used to trigger an automated
111111
build that:

tests/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ of Python, then using an automation tool such as nox to run your tests is useful
5353
:link-type: doc
5454
:class-card: left-aligned
5555

56-
Continuous integration platforms such as GitHub actions can be
56+
Continuous integration platforms such as GitHub Actions can be
5757
useful for running your tests across both different Python versions
5858
and different operating systems. Learn about setting up tests to run in Continuous Integration here.
5959
:::

tests/tests-ci.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ It allows users to contribute code, documentation fixes and more without
1919
having to create development environments, run tests and build documentation
2020
locally.
2121

22-
## Example GitHub action that runs tests
22+
## Example GitHub Actions that runs tests
2323

24-
Below is an example GitHub action that runs tests using nox
24+
Below is an example GitHub Actions that runs tests using nox
2525
across both Windows, Mac and Linux and on Python versions
2626
3.9-3.11.
2727

tests/write-tests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Writing tests for your Python package is important because:
1818
- **Fearless Refactoring:** Refactoring means making improvements to your code structure without changing its behavior. Tests empower you to make these changes as if you break something, test failures will let you know.
1919
- **Documentation:** Tests serve as technical examples of how to use your package. This can be helpful for a new technical contributor that wants to contribute code to your package. They can look at your tests to understand how parts of your code functionality fits together.
2020
- **Long-Term ease of maintenance:** As your package evolves, tests ensure that your code continues to behave as expected, even as you make changes over time. Thus you are helping your future self when writing tests.
21-
- **Easier pull request reviews:** By running your tests in a CI framework such as GitHub actions, each time you or a contributor makes a change to your code-base, you can catch issues and things that may have changed in your code base. This ensures that your software behaves the way you expect it to.
21+
- **Easier pull request reviews:** By running your tests in a CI framework such as GitHub Actions, each time you or a contributor makes a change to your code-base, you can catch issues and things that may have changed in your code base. This ensures that your software behaves the way you expect it to.
2222

2323
### Tests for user edge cases
2424

tutorials/publish-pypi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ to TestPyPI. You need to:
5858
1. **Publish to TestPyPI using `hatch publish`**
5959

6060
In a future lesson, you will learn how to create an automated
61-
GitHub action workflow that publishes an updated
61+
GitHub Actions workflow that publishes an updated
6262
version of your package to PyPI every time you create a GitHub release.
6363

6464
:::{admonition} Learn more about building Python packages in our guide
@@ -360,7 +360,7 @@ For long run maintenance of your package, you have two options
360360
related to PyPI publication.
361361

362362
1. You can create a package-specific token which you will use to publish your package (manually) to PyPI. This is a great option if you don't wish to automate your PyPI publication workflow.
363-
2. You can also create an automated publication workflow on GitHub using GitHub actions. This is a great way to make the publication process easier and it also supports a growing maintainer team. In this case we suggest you don't worry about the token and instead setup a specific GitHub action that publishes your package when you make a release. You can then create a "trusted publisher" workflow on PyPI.
363+
2. You can also create an automated publication workflow on GitHub using GitHub Actions. This is a great way to make the publication process easier and it also supports a growing maintainer team. In this case we suggest you don't worry about the token and instead setup a specific GitHub Actions that publishes your package when you make a release. You can then create a "trusted publisher" workflow on PyPI.
364364

365365
You will learn how to create the automated trusted publisher workflow in a followup lesson.
366366

0 commit comments

Comments
 (0)