Skip to content

Commit

Permalink
Update release and testing system
Browse files Browse the repository at this point in the history
Update the semi-automatic release system and document it; amend testing system to include @cmungall test suite;
  • Loading branch information
matentzn committed Aug 18, 2024
1 parent 47eb456 commit 1af7eeb
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 2 deletions.
20 changes: 19 additions & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,32 @@ jobs:
- name: work around permission issue
run: git config --global --add safe.directory "$GITHUB_WORKSPACE"

- name: Get current date
id: date
run: echo "::set-output name=date::$(date +'%Y-%m-%d')"

- name: Update release files
run: cd src/ontology/ && make ROBOT_ENV='ROBOT_JAVA_ARGS=-Xmx6G' GITHUB_ACTION=true IMP=false PAT=false MIR=false prepare_release

#@matentzn believes testing should be done once per week independently of releases
# So we do not block releases because some ontology is not passing tests
#- name: Run Test suite
# run: cd src/ontology/ && make ROBOT_ENV='ROBOT_JAVA_ARGS=-Xmx6G' GITHUB_ACTION=true IMP=false PAT=false MIR=false test

- name: Create Pull Request
uses: peter-evans/create-pull-request@v3
with:
commit-message: Update release files
title: 'Update release files'
body: |
Updates all release files.
Updates all release files. Please:
- [] Review the pull request and merge it
- [] After merging, please check the [associated release draft](https://github.com/OBOFoundry/COB/releases) and publish it.
assignees: sebastianduesing

- name: Run release
uses: gaoDean/action-gh-release@6b61bb5648ddc1241deb73ea6b72c3a1e1f9e445
with:
generate_release_notes: true
draft: true
tag_name: v${{ steps.date.outputs.date }}
2 changes: 1 addition & 1 deletion .github/workflows/qc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
ontology_qc:
# The type of runner that the job will run on
runs-on: ubuntu-latest
container: obolibrary/odkfull:v1.4
container: obolibrary/odkfull:v1.5.2

# Steps represent a sequence of tasks that will be executed as part of the job
steps:
Expand Down
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ changes to this document in a pull request.
* [Reporting problems with the ontology](#reporting-bugs)
* [Requesting new terms](#requesting-terms)
* [Adding new terms by yourself](#adding-terms)
* [Running a release](#run-release)
- [Best practices](#best-practices)
* [How to write a great issue?](#great-issues)
* [How to create a great pull/merge request?](#great-pulls)
Expand Down Expand Up @@ -81,6 +82,16 @@ If you have never editted this ontology before, first follow a [general tutorial
1. Push changes upstream
1. Create pull request

<a id="run-release"></a>

### How to run a release

1. Go to [GitHub actions tab](https://github.com/OBOFoundry/COB/actions/workflows/build.yml)
2. Click on _Run workflow_, make sure `master` is selected, click _Run workflow_ again.
3. When the pipeline is finished, a new PR with an associated GitHub draft release was created
4. Review the PR, merge it.
5. Go to the draft release and publish it.

## Best Practices

<a id="great-issues"></a>
Expand Down
2 changes: 2 additions & 0 deletions src/ontology/cob.Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,8 @@ ALL_ONTS = $(COB_COMPLIANT) $(COB_NONCOMPLIANT)
.PHONY: cob_test
cob_test: main_test itest

test: cob_test

# main test: should be run via CI on every PR
# this tests COB's internal consistency
.PHONY: main_test
Expand Down

0 comments on commit 1af7eeb

Please sign in to comment.