Skip to content

Commit

Permalink
Fix markdown syntax and ugly line breaks
Browse files Browse the repository at this point in the history
  • Loading branch information
rays22 committed Jun 27, 2024
1 parent 639c840 commit 8dac246
Showing 1 changed file with 10 additions and 18 deletions.
28 changes: 10 additions & 18 deletions docs/odk-workflows/ReleaseWorkflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,29 +17,21 @@ Preparation:
3. Locally make sure you have the latest changes from master (`git pull`). You can also use [GitHub Desktop](https://desktop.github.com/) for interacting with the OBA repo.
4. Checkout a new branch (e.g. `git checkout -b release-202X-XX-XX`)
5. You may or may not want to refresh your imports as part of your release strategy (see [here](UpdateImports.md)).
6. Make sure you have the latest ODK installed by running `docker pull obolibrary/odkfull`
```sh
docker pull obolibrary/odkfull
```
6. Make sure you have the latest ODK installed by running: `docker pull obolibrary/odkfull`



To actually run the release, you:

1. Open a command line terminal window and navigate to the `src/ontology` directory (`cd bio-attribute-ontology/src/ontology`).
2. Start the release pipeline by issuing the command:
```sh
sh run.sh make prepare_release_fast
```
NOTE: It is recommended that you run the release pipeline uncoupled from refreshing imports. However, in case you do need to refresh all the imports at this time, you can achieve that by:
```sh
sh run.sh make prepare_release -B
```
2. Start the release pipeline by issuing the command: `sh run.sh make prepare_release_fast`
NOTE: It is recommended that you run the release pipeline uncoupled from refreshing imports. However, in case you do need to refresh all the imports at this time, you can achieve that by issuing the command: `sh run.sh make prepare_release -B`
3. If everything went well, you should see the following output on your machine:
```sh
...
Release files are now in ../.. - now you should commit, push and make a release on your git hosting site such as GitHub or GitLab
make[1]: Leaving directory '/work/src/ontology'
Please remember to update your ODK image from time to time: https://oboacademy.github.io/obook/howto/odk-update/.
```
`...`
`Release files are now in ../.. - now you should commit, push and make a release
`on your git hosting site such as GitHub or GitLab`
`make[1]: Leaving directory '/work/src/ontology'`
`Please remember to update your ODK image from time to time: https://oboacademy.github.io/obook/howto/odk-update/.`
This will create all the specified release targets (OBO, OWL, JSON, and the variants, ont-full and ont-base) and copy them into your release directory (the top level of your repo).

## Review the release
Expand Down

0 comments on commit 8dac246

Please sign in to comment.