You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 9ada2b3
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: book/plugins/how-to-guides/distribute-on-library.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ The *About* section of a GitHub repository.
27
27
Only resources referenced with absolute URLs will load.
28
28
1. Conda environment files must be provided for installation, and they must meet a few formatting requirements.
29
29
This is the highest bar to clear to have your plugin be compatible with the QIIME 2 Library.
30
-
* Your repository must include environment YAML files for each QIIME 2 release you support using the naming scheme `<plugin-name>-qiime2-<distro>-<epoch>.yml`.
30
+
* Your repository must include environment YAML files for each QIIME 2 release you support using the naming scheme `<plugin-name>-rachis-<distro>-<epoch>.yml`.
31
31
These files must be located in your repository's `/environment-files` folder.
32
32
More detailed instructions on how to do this are provided in [](facilitating-installation).
33
33
One feature that we're working on adding to the Library is a system that can automatically submit PRs against your plugin repository to add new environment files when new QIIME 2 releases come out, to help you keep your plugin up-to-date with QIIME 2 - more on this soon!
Copy file name to clipboardExpand all lines: book/plugins/how-to-guides/facilitate-installation.md
+28-54Lines changed: 28 additions & 54 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ environment-files/
13
13
```
14
14
15
15
Within this directory, create environment file(s) for current and/or past installable versions of your plugin.
16
-
You can name them with a pattern like `<package-name>-qiime2-<target-distribution>-<target-epoch>.yml` (for example, `q2-dwq2-qiime2-amplicon-2024.5.yml`).
16
+
You can name them with a pattern like `<package-name>-rachis-<target-distribution>-<target-epoch>.yml` (for example, `q2-dwq2-rachis-qiime2-2026.4.yml`).
17
17
18
18
The contents of your environment file should look something like this:
-`<target-epoch>`: the QIIME 2 epoch that your plugin should be installed under (e.g., `2024.5` or `2024.10`)
34
-
-`<target-distribution>`: the QIIME 2 distribution that your plugin should be installed under (e.g., `amplicon` or `moshpit`)
34
+
-`<target-distribution>`: the QIIME 2 distribution that your plugin should be installed under (e.g., `qiime2` or `moshpit`)
35
35
-`<package-name>`: your plugin's package name (e.g., `q2-dwq2`)
36
36
-`<owner>`: the github organization your plugin is hosted under, or your personal github account name
37
37
-`<repository-name>`: the name of your plugin repository on GitHub (this often will be the same as your plugin's package name, e.g., `q2-dwq2`)
@@ -40,17 +40,17 @@ With the following terms defined:
40
40
``````{Note}
41
41
In the examples provided in this guide, we utilize the `released` channel for our QIIME 2 packages (i.e. `packages.qiime2.org/qiime2/<target-epoch>/<target-distribution>/released`).
42
42
If you are interested in creating and/or sharing instructions for installing a version of your plugin that relies on one of our development environments (meaning the current development cycle environment prior to an official release version), you'll want to target the `passed` channel of that particular distribution.
43
-
Here's an example of what this channel might look like (as of Sept. 2024, prior to the 2024.10 release):
43
+
Here's an example of what this channel might look like (as of June 2026, prior to the 2026.7 release):
Again, you'll fill in the values enclosed in the `<` and `>` brackets.
@@ -63,77 +63,51 @@ By maintaining release branches on your repository, you can create a new environ
63
63
As an example, your branch structure could look like the following:
64
64
65
65
```
66
-
release-2024.5 # the 2024.5 release of your plugin
67
-
release-2024.10 # the 2024.10 release of your plugin
66
+
release-2026.4 # the 2026.4 release of your plugin
68
67
main # your main branch, usually what would be installed for a "development" installation
69
68
```
70
69
71
-
You could then have environment files and install instructions for these different branches that look like the following (in this example, `amplicon` is the target distribution):
70
+
You could then have environment files and install instructions for these different branches that look like the following (in this example, `qiime2` is the target distribution):
In this example, the plugin being developed (`q2-dwq2`) requires `q2-feature-table` and `q2-composition`, but we're assuming that it's not compatible with the entire amplicon distribution.
184
-
Because this plugin still requires a basic QIIME 2 environment, the `qiime2-tiny` distribution will be installed from the first channel listed.
185
-
The `q2-feature-table` and `q2-composition` dependencies are not part of the `qiime2-tiny` distribution however, but are a part of the amplicon distribution.
186
-
Therefore the second channel listed is the `amplicon` channel.
187
-
We then list the dependencies as `qiime2-tiny` (the `tiny` distribution) and then the two additional plugins.
157
+
In this example, the plugin being developed (`q2-dwq2`) requires `q2-feature-table` and `q2-composition`, but we're assuming that it's not compatible with the entire qiime2 distribution.
158
+
Because this plugin still requires a basic QIIME 2 environment, the `rachis-tiny` distribution will be installed from the first channel listed.
159
+
The `q2-feature-table` and `q2-composition` dependencies are not part of the `rachis-tiny` distribution however, but are a part of the qiime2 distribution.
160
+
Therefore the second channel listed is the `qiime2` channel.
161
+
We then list the dependencies as `rachis-tiny` (the `tiny` distribution) and then the two additional plugins.
188
162
Those are all followed by the installation of the `q2-dwq2` plugin, as in the previous example.
189
163
190
164
Generally, your customized environment files will be structured as follows:
Copy file name to clipboardExpand all lines: book/plugins/how-to-guides/release-on-gh.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,8 @@ As you add new features into your plugin, you may wish to create *release* versi
5
5
We’ve created a GitHub workflow automation that runs each time you publish a new release on your plugin’s repository that will mint and test a new release environment file, so you don't have to!
6
6
If you used our plugin template (see [](plugin-from-template)) on or after 20 June 2025, this automation is already included!
7
7
You can determine whether or not you have this automation by looking under the `.github/workflows/` directory in your plugin's repository - the file that creates this automation will be titled `release-env.yml`.
8
+
Note that you will need to have a correctly formatted release environment file in order for this automation to work properly.
9
+
More information on how to create and format a release environment file can be found in [](facilitating-installation).
8
10
9
11
A GitHub workflow is included upon creation of your plugin (using our plugin template) that will automatically run when a new GitHub release is published on your plugin's repository.
10
12
This workflow will mint a new *release* environment file that includes the latest QIIME 2 release of the given distribution you specified upon plugin creation, as well as the newly minted release version of your plugin.
0 commit comments