Skip to content

Latest commit

 

History

History
110 lines (74 loc) · 3.89 KB

CONTRIBUTING.md

File metadata and controls

110 lines (74 loc) · 3.89 KB
Raw

Contributing to the OCM SDK

Updating the OCM API Model

If new api types or endpoints need to be added, the ocm-api-model will need to be updated.

Fork and clone the ocm-api-model repository to get started.

The OCM API Model README contains all the information needed to create or update models.

Submit an MR with any changes after validation. The MR should be reviewed before merge.

Validating model updates

The easiest way to validate changes to the ocm-api-model is to generate the sdk based on the updated model. Ensure ocm-sdk-go is cloned locally alongside your cloned ocm-api-model directory where changes are made.

In ocm-sdk-go, run the following to generate the sdk using the local ocm-api-model. Replace /path/to/ocm-api-model with the path to your cloned ocm-api-model repository where changes have been made. Replace HEAD with the commit SHA in ocm-api-model to build against if necessary.

make clean
make model_version=HEAD model_url=/path/to/ocm-api-model generate

Review the output for errors. If none, the changes are at least syntactically proper.

Style notes

Comments can be added to types with the // notation. Comments should be added to each type's attribute where possible.

Hard tabs are required rather than spaces.

Releasing a new OCM API Model version

To use any updates to the ocm-api-model, the version must be incremented for consumption in ocm-sdk-go generation. The version is defined by the latest git tag. The version is also defined in the ocm-api-model/CHANGES.md file.

Once all changes to the OCM API Model have been committed to the main branch, submit a separate change with an update to ocm-api-model/CHANGES.md. This update should indicate the version and describe the changes included with the version update. The following is an example update to version 0.0.9:

== 0.0.9 Oct 7 2019

- Add `type` attribute to the `ResourceQuota` type.
- Add `config_managed` attribute to the `RoleBinding` type.

Submit an MR with the CHANGES.md modification and review/merge.

Finally, create and submit a new tag with the new version following the below example:

git checkout main
git pull
git tag -a -m 'Release 0.0.9' v0.0.9
git push origin v0.0.9

Note that a repository administrator may need to push the tag to the repository due to access restrictions.

Updating the OCM SDK

The OCM SDK can be generated simply by running the following after all changes have been made:

make generate

In most cases, the ocm-api-model version will be incremented prior to generation. To increment the ocm-api-model version, update the model_version constant in Makefile.

Whenever an update is made, ensure that the corresponding example in examples is also updated where necessary. Any new endpoints should have a new example created.

Releasing a new OCM SDK Version

Releasing a new version requires submitting an MR for review/merge with an update to the Version constant in version.go. Additionally, update the CHANGES.md file to include the new version and describe all changes included.

Below is an example CHANGES.md update:

== 0.1.39 Oct 7 2019

- Update to model 0.0.9:
  - Add `type` attribute to the `ResourceQuota` type.
  - Add `config_managed` attribute to the `RoleBinding` type.

Submit an MR for review/merge with the CHANGES.md and version.go update.

Finally, create and submit a new tag with the new version following the below example:

git checkout main
git pull
git tag -a -m 'Release 0.1.39' v0.1.39
git push origin v0.1.39

Note that a repository administrator may need to push the tag to the repository due to access restrictions.