Release management - Stage 1

[vstirbu]

Docker container build procedure

The docker container is built on each action run. The action.yml has the following content;

...
runs:
  using: docker
  image: Dockerfile

Development

New functionality is implemented using a feature branch that is created from main. Merging is done with a pull request that is reviewed and all test pass successfully.

gitGraph
  commit tag: "v1.0.0/v1"
  commit
  branch feature-name
  commit
  commit
  commit
  checkout main
  merge feature-name
  commit

Loading

Release procedure

1. The commit is tagged with the new version v{major}.{minor}.{patch}.
2. The tag event triggers the workflow that moves the v{major} tag to the commit.

gitGraph
  commit tag: "v1.0.0"
  commit
  branch feature-name
  commit
  commit
  commit
  checkout main
  merge feature-name tag: "v1.1.0/v1"
  commit

Loading

Using the action

...
- name: Check for model card file
  uses: CompliancePal/modelcard-action@<branch/tag>
  with:
    modelcard: modelcard.yaml
    rules: .modelcard/rules