Skip to content

Commit

Permalink
doc: Update invocation of the pants command (#2046)
Browse files Browse the repository at this point in the history
`./pants` is deprecated and we should use `pants` by installing it via brew or manually downloaded `scie`-based executable.

馃摎 Documentation preview 馃摎: https://sorna--2046.org.readthedocs.build/en/2046/
馃摎 Documentation preview 馃摎: https://sorna-ko--2046.org.readthedocs.build/ko/2046/
  • Loading branch information
Yaminyam committed Apr 24, 2024
1 parent 3d9a3d8 commit 91e0df5
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
10 changes: 5 additions & 5 deletions docs/dev/daily-workflows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ Similarly, you can export all virtualenvs at once:

.. code-block:: console
$ python -c 'import tomllib,pathlib;print("\n".join(tomllib.loads(pathlib.Path("pants.toml").read_text())["python"]["resolves"].keys()))' | sed 's/^/--resolve=/' | xargs ./pants export
$ python -c 'import tomllib,pathlib;print("\n".join(tomllib.loads(pathlib.Path("pants.toml").read_text())["python"]["resolves"].keys()))' | sed 's/^/--resolve=/' | xargs pants export
Then configure your IDEs/editors to use
``dist/export/python/virtualenvs/python-default/PYTHON_VERSION/bin/python`` as the
Expand Down Expand Up @@ -718,19 +718,19 @@ Making a new release
* Push the commit and tag. The GitHub Actions workflow will build the packages
and publish them to PyPI.

* When making a new major release, snapshot of prior release's final DB migration history
should be dumped. This will later help to fill out missing gaps of DB revisions when
* When making a new major release, snapshot of prior release's final DB migration history
should be dumped. This will later help to fill out missing gaps of DB revisions when
upgrading outdated cluster. The output then should be committed to **next** major release.

.. code-block:: console
$ ./backend.ai mgr schema dump-history > src/ai/backend/manager/models/alembic/revision_history/<version>.json
Suppose you are trying to create both fresh baked 24.09.0 and good old 24.03.10 releases.
In such cases you should first make a release of version 24.03.10, move back to latest branch, and then
execute code snippet above with `<version>` set as `24.03.10`, and release 24.09.0 including the dump.

To make workflow above effective, be aware that backporting DB revisions to older major releases will no longer
To make workflow above effective, be aware that backporting DB revisions to older major releases will no longer
be permitted after major release version is switched.

Backporting to legacy per-pkg repositories
Expand Down
2 changes: 1 addition & 1 deletion pants.toml
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ enable_resolves = true
# - Regenerate lockfiles
# - pyproject.toml: [tool.mypy].python_executable
# * Let other developers do:
# - Run `./pants export` again
# - Run `pants export` again
# - Update their local IDE/editor's interpreter path configurations
interpreter_constraints = ["CPython==3.12.2"]
tailor_pex_binary_targets = false
Expand Down
2 changes: 1 addition & 1 deletion plugins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ Run `./scripts/install-plugin.sh {github-owner}/{repo-name}`.
The plugin code will be cloned into `./plugins/{repo-name}` and it will be installed
as an editable package inside the Pants exported unified virtualenv.

Note that whenever you run `./pants export` again, you need to run
Note that whenever you run `pants export` again, you need to run
`./scripts/reinstall-plugins.sh` again to redo editable installation.

0 comments on commit 91e0df5

Please sign in to comment.