Skip to content

Commit 2587dd8

Browse files
committed
more managing
1 parent c17e735 commit 2587dd8

File tree

1 file changed

+33
-4
lines changed

1 file changed

+33
-4
lines changed

docs/packages/development/managing.md

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,45 @@ You will then be greeted with a welcome message and some information about short
3131

3232
### Repositories
3333

34-
TODO
34+
Local copies of the [github repositories][pylhc_github] are kept in `/afs/cern.ch/eng/sl/lintrack/omc_repos/`.
35+
There is a shortcut available on the `lintrack` welcome screen to update all repositories.
36+
37+
These repositories are used in the `python_edge` environment and might be modified online to test new features
38+
or fix issues.
39+
40+
!!! warning "Keeping them clean"
41+
Changes to the repositories should be short lived and patched into the packages properly within a day or two and the repository reset to its original state.
42+
In the past, changes made during shifts were often forgotten and after a while no one knew why the changes were made which version was the correct one to use.
3543

3644
### Python Installations
3745

38-
TODO
46+
The python installations are located in `/afs/cern.ch/eng/sl/lintrack/omc_acc_py/`.
47+
In this folder you can also find the `acc-py` installers as well as the `omc_requirements_*.txt` files to easily setup new environments.
48+
49+
- `/afs/cern.ch/eng/sl/lintrack/omc_acc_py/base/` contains the base `acc-py` installations from which the environments are derived.
50+
- In `/afs/cern.ch/eng/sl/lintrack/omc_acc_py/venv/` contains the environments. These are automatically picked up by the [BetaBeat GUI](/guis/betabeat/gui.html).
51+
52+
The main environments are:
53+
54+
- `omc_py3xx_releases`: The main production environment which is used for the CCC. All packages are installed via their official `pypi` release.
55+
- `omc_py3xx_repos`: The development environment which is used for the testing of new packages. All packages are installed from the local `git` repositories.
56+
57+
These two environments are also symlinked to `/afs/cern.ch/eng/sl/lintrack/omc_python3` and `/afs/cern.ch/eng/sl/lintrack/omc_python_edge` respectively.
58+
59+
!!! info "TODO"
60+
- If you want the newest version of a repository to be used in `python_edge` you need to pull the changes into the local repository manually (see also the `lintrack` welcome screen).
61+
- Whenever there is a new release for one of the packages, it needs to be manually installed into the `omc_py3xx_releases` environment.
62+
Shortcuts are available (see the `lintrack` welcome screen), but for single updates one can use `python -m pip install -U <package>`.
63+
- On new `acc-py` releases, a new base environment needs to be created and the `omc_py3xx_releases` and `omc_py3xx_repos` environments derived.
64+
You can use the `omc_requirements_*.txt` files for this process.
65+
To avoid issues, the former and new bases/environments can be kept in parallel for a while.
66+
Don't forget to also update the symlinks.
3967

4068
## Github
4169

4270
The settings for the organization `pylhc` should be automatically available to you, if you have been given the right permissions (either `admin` or `code owner`).
4371

44-
Our repositories use the [`.github`][pylhc_github] configuration repository to manage
72+
Our repositories use the [`.github`][pylhc_github_github] configuration repository to manage
4573

4674
- Issue Templates
4775
- Workflows
@@ -115,7 +143,8 @@ To add a new repository to Zenodo, you need to make sure that the `.zenodo.json`
115143
[pypi]: https://pypi.org
116144
[zenodo]: https://zenodo.org
117145
[zenodo_github]: https://zenodo.org/account/settings/github/
118-
[pylhc_github]: https://github.com/pylhc/.github
146+
[pylhc_github]: https://github.com/pylhc
147+
[pylhc_github_github]: https://github.com/pylhc/.github
119148
[pylhc_publish]: https://github.com/pylhc/.github/blob/master/.github/workflows/publish.yml
120149
[pypi_apitoken]: https://pypi.org/help/#apitoken
121150
[pylhc_labels_workflow]: https://github.com/pylhc/.github/blob/master/.github/workflows/assign_labels_to_all_repos.yml

0 commit comments

Comments
 (0)