Skip to content

Commit

Permalink
Add docs for workflow action procedures
Browse files Browse the repository at this point in the history
  • Loading branch information
jogoodma committed May 23, 2024
1 parent b9a938d commit 82dd8d9
Showing 1 changed file with 26 additions and 3 deletions.
29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,29 @@ See `poetry run generate --help` for a full list of supported options.

## GitHub Action

The [Generate FlyBase BLAST Configuration](https://github.com/FlyBase/blast-db-configuration/actions/workflows/generate-blast-conf.yml) GitHub Action
can be used to generate the configuration. This workflow will generate a new configuration for the specified FlyBase
release and Dmel annotation and create a PR with the updated configuration file for review.
The GitHub action workflows described below do the following:

- Create or update a BLAST DB configuration file
- Create a PR with the resulting changes
- Pull the changes from FlyBase into the Alliance BLAST DB repo
- Create a PR for the Alliance to review and act on


### Procedure

#### Generate FlyBase Configuration

1. Visit the [Actions tab](https://github.com/FlyBase/blast-db-configuration/actions) for the repo.
2. Click on the [Generate FlyBase BLAST Configuration](https://github.com/FlyBase/blast-db-configuration/actions/workflows/generate-blast-conf.yml) workflow.
3. Click "Run workflow" and enter in the FlyBase release and Dmel annotation version number (e.g. FB2024_02 and r6.57).
4. After the workflow has run, there will be a pull request with the resulting configuration file. Review
the pull request changes and merge if all looks good.

#### Copy Configuration to the Alliance

1. Visit the [Actions tab](https://github.com/alliance-genome/agr_blast_service_configuration/actions) for the Alliance BLAST configurations.
2. Click on the [Update FlyBase Configuration](https://github.com/alliance-genome/agr_blast_service_configuration/actions/workflows/flybase.yml) workflow.
3. Click "Run workflow" and enter in the FlyBase release (e.g. FB2024_04). This is only used for the pull request text.
4. Review the pull request changes and follow the Alliance procedures.


0 comments on commit 82dd8d9

Please sign in to comment.