Skip to content

Commit 82dd8d9

Browse files
committed
Add docs for workflow action procedures
1 parent b9a938d commit 82dd8d9

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,29 @@ See `poetry run generate --help` for a full list of supported options.
3737

3838
## GitHub Action
3939

40-
The [Generate FlyBase BLAST Configuration](https://github.com/FlyBase/blast-db-configuration/actions/workflows/generate-blast-conf.yml) GitHub Action
41-
can be used to generate the configuration. This workflow will generate a new configuration for the specified FlyBase
42-
release and Dmel annotation and create a PR with the updated configuration file for review.
40+
The GitHub action workflows described below do the following:
41+
42+
- Create or update a BLAST DB configuration file
43+
- Create a PR with the resulting changes
44+
- Pull the changes from FlyBase into the Alliance BLAST DB repo
45+
- Create a PR for the Alliance to review and act on
46+
47+
48+
### Procedure
49+
50+
#### Generate FlyBase Configuration
51+
52+
1. Visit the [Actions tab](https://github.com/FlyBase/blast-db-configuration/actions) for the repo.
53+
2. Click on the [Generate FlyBase BLAST Configuration](https://github.com/FlyBase/blast-db-configuration/actions/workflows/generate-blast-conf.yml) workflow.
54+
3. Click "Run workflow" and enter in the FlyBase release and Dmel annotation version number (e.g. FB2024_02 and r6.57).
55+
4. After the workflow has run, there will be a pull request with the resulting configuration file. Review
56+
the pull request changes and merge if all looks good.
57+
58+
#### Copy Configuration to the Alliance
59+
60+
1. Visit the [Actions tab](https://github.com/alliance-genome/agr_blast_service_configuration/actions) for the Alliance BLAST configurations.
61+
2. Click on the [Update FlyBase Configuration](https://github.com/alliance-genome/agr_blast_service_configuration/actions/workflows/flybase.yml) workflow.
62+
3. Click "Run workflow" and enter in the FlyBase release (e.g. FB2024_04). This is only used for the pull request text.
63+
4. Review the pull request changes and follow the Alliance procedures.
64+
65+

0 commit comments

Comments
 (0)