Skip to content

Add readme to explain how to use the scrip to help with installs #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Delphine-L wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add readme to explain how to use the scrip to help with installs #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb2d822
Create README.md for the parsing script
Delphine-L Jun 29, 2024
68c48c5
Merge pull request #1 from Delphine-L/install-readme
Delphine-L Jun 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions scripts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# How to install tools missing from a toolkit in a new instance

Warning: This procedure assumes the installation of new tools follows the same process as usegalaxy.org : [Requesting a new tool or updating a tool](https://github.com/galaxyproject/usegalaxy-tools?tab=readme-ov-file#requesting-a-new-tool-or-updating-a-tool)

Download the toolkit file. E.g. : [VGP toolkit file](https://github.com/galaxyproject/usegalaxy-playbook/blob/main/env/main/files/galaxy/config/panel_views/vgp.yml)
Clone the repository containing the tools of the target instance

In an empty repository (so as not to erase existing files), run the command :
```bash
python parse_tools_to_produce_yml_files.py --tk $toolkit_file --yml-folder $install_repository
```

It will generate a set of files named section.yaml.

Look at the folder containing the installed tools in the target instance. If a section already exist, merge the two files with the same name.
Move the section.yaml files to the target instance repository and folllow the procedure for tool installation : [Requesting a new tool or updating a tool](https://github.com/galaxyproject/usegalaxy-tools?tab=readme-ov-file#requesting-a-new-tool-or-updating-a-tool)