Skip to content

Commit 19e5eff

Browse files
Remove deprecated usethis ci from README and docs (#1445)
* Initial plan * Remove deprecated usethis ci mentions and GitHub Actions roadmap from README and docs Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com> Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/7b1436ee-5b4b-4577-b46d-5de6355d535b --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
1 parent 93c23d1 commit 19e5eff

4 files changed

Lines changed: 0 additions & 48 deletions

File tree

README.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,6 @@ Additionally, the command line reference documentation can be viewed with `useth
7575
- [`usethis lint`](https://usethis.readthedocs.io/en/stable/cli/reference#usethis-lint) — Add/Configure recommended linters (namely, [Ruff](https://docs.astral.sh/ruff/linter) and [deptry](https://github.com/fpgmaas/deptry)).
7676
- [`usethis spellcheck`](https://usethis.readthedocs.io/en/stable/cli/reference#usethis-spellcheck) — Add/Configure recommended spellcheckers (namely, [codespell](https://github.com/codespell-project/codespell)).
7777
- [`usethis test`](https://usethis.readthedocs.io/en/stable/cli/reference#usethis-test) — Add/Configure a recommended testing framework (namely, [pytest](https://github.com/pytest-dev/pytest) with [Coverage.py](https://github.com/nedbat/coveragepy)).
78-
- [`usethis ci`](https://usethis.readthedocs.io/en/stable/cli/reference#usethis-ci) — Add/Configure a specified CI service.
7978
- [`usethis tool`](https://usethis.readthedocs.io/en/stable/cli/reference#usethis-tool) — Add/Configure specific tools individually.
8079
- [`usethis tool codespell`](https://usethis.readthedocs.io/en/stable/cli/reference#code-quality-tools) - Use the [codespell spellchecker](https://github.com/codespell-project/codespell): detect common spelling mistakes.
8180
- [`usethis tool deptry`](https://usethis.readthedocs.io/en/stable/cli/reference#code-quality-tools) - Use the [deptry linter](https://github.com/fpgmaas/deptry): avoid missing or superfluous dependency declarations.
@@ -145,18 +144,6 @@ $ uvx usethis tool pytest
145144
☐ Run 'uv run pytest' to run the tests.
146145
```
147146

148-
There are also commands to configure aspects other than tools. For example, to configure [Bitbucket Pipelines](https://www.atlassian.com/software/bitbucket/features/pipelines), run:
149-
150-
```console
151-
$ uvx usethis ci bitbucket
152-
✔ Writing 'bitbucket-pipelines.yml'.
153-
✔ Adding cache 'uv' definition to 'bitbucket-pipelines.yml'.
154-
✔ Adding 'Run Ruff' to default pipeline in 'bitbucket-pipelines.yml'.
155-
✔ Adding 'Test on 3.13' to default pipeline in 'bitbucket-pipelines.yml'.
156-
✔ Adding 'Test on 3.14' to default pipeline in 'bitbucket-pipelines.yml'.
157-
☐ Run your pipeline via the Bitbucket website.
158-
```
159-
160147
See the [CLI Reference](https://usethis.readthedocs.io/en/stable/cli/reference) for a full list of available commands.
161148

162149
## 📚 Similar Projects
@@ -190,7 +177,6 @@ If you're not interested in templating automations, then [configurator](https://
190177

191178
Major features planned are:
192179

193-
- Support for automated GitHub Actions workflows ([#57](https://github.com/usethis-python/usethis-python/issues/57)), and
194180
- Support for a typechecker (likely ty, [#838](https://github.com/usethis-python/usethis-python/issues/838)).
195181

196182
Other features are tracked in the [GitHub Issues](https://github.com/usethis-python/usethis-python/issues) page.

docs/cli/overview.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
- [`usethis lint`](reference.md#usethis-lint) — Add/Configure recommended linters (namely, [Ruff](https://docs.astral.sh/ruff/linter) and [deptry](https://github.com/fpgmaas/deptry)).
1212
- [`usethis spellcheck`](reference.md#usethis-spellcheck) — Add/Configure recommended spellcheckers (namely, [codespell](https://github.com/codespell-project/codespell)).
1313
- [`usethis test`](reference.md#usethis-test) — Add/Configure a recommended testing framework (namely, [pytest](https://github.com/pytest-dev/pytest) with [Coverage.py](https://github.com/nedbat/coveragepy)).
14-
- [`usethis ci`](reference.md#usethis-ci) — Add/Configure a specified CI service.
1514
- [`usethis tool`](reference.md#usethis-tool) — Add/Configure specific tools individually.
1615
- [`usethis tool codespell`](reference.md#code-quality-tools) - Use the [codespell spellchecker](https://github.com/codespell-project/codespell): detect common spelling mistakes.
1716
- [`usethis tool deptry`](reference.md#code-quality-tools) - Use the [deptry linter](https://github.com/fpgmaas/deptry): avoid missing or superfluous dependency declarations.

docs/cli/reference.md

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -226,27 +226,6 @@ For `usethis tool ruff`, in addition to the above options, you can also specify:
226226
- `--linter` to add or remove specifically the linter component of Ruff (default; or `--no-linter` to opt-out)
227227
- `--formatter` to add or remove specifically the formatter component of Ruff (default; or `--no-formatter` to opt-out)
228228

229-
## `usethis ci`
230-
231-
Add Continuous Integration pipelines to the project.
232-
233-
Currently supported platforms:
234-
235-
- `usethis ci bitbcuket` - Use [Bitbucket Pipelines](https://bitbucket.org/product/features/pipelines): a CI/CD service for Bitbucket.
236-
237-
Supported options:
238-
239-
- `--remove` to remove the CI configuration instead of adding it
240-
- `--offline` to disable network access and rely on caches
241-
- `--quiet` to suppress output
242-
- `--frozen` to leave the virtual environment and lockfile unchanged (i.e. do not install dependencies, nor update lockfiles)
243-
- `--backend` to specify a package manager backend to use. The default is to auto-detect.
244-
245-
Possible values:
246-
- `auto` to auto-detect the backend (default)
247-
- `uv` to use the [uv](https://docs.astral.sh/uv) package manager
248-
- `none` to not use a package manager backend and display messages for some operations.
249-
250229
## `usethis badge`
251230

252231
Add badges to the README file.

docs/start/example-usage.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -35,16 +35,4 @@ $ uvx usethis tool pytest
3535
☐ Run 'uv run pytest' to run the tests.
3636
```
3737

38-
There are also commands to configure aspects other than tools. For example, to configure [Bitbucket Pipelines](https://www.atlassian.com/software/bitbucket/features/pipelines), run:
39-
40-
```console
41-
$ uvx usethis ci bitbucket
42-
✔ Writing 'bitbucket-pipelines.yml'.
43-
✔ Adding cache 'uv' definition to 'bitbucket-pipelines.yml'.
44-
✔ Adding 'Run Ruff' to default pipeline in 'bitbucket-pipelines.yml'.
45-
✔ Adding 'Test on 3.13' to default pipeline in 'bitbucket-pipelines.yml'.
46-
✔ Adding 'Test on 3.14' to default pipeline in 'bitbucket-pipelines.yml'.
47-
☐ Run your pipeline via the Bitbucket website.
48-
```
49-
5038
See the [CLI Reference](../cli/reference.md) for a full list of available commands.

0 commit comments

Comments
 (0)