Skip to main content
Version: 1.1.0

Go module updates

When to update​

The references in the master branches must be updated if a change is made in the scheduler interface. Updating the dependency of a shim in reference to the core might be needed even if the scheduler interface does not change. New functionality could be added that rely on changed field content of the messages, not the field layout of the message. In that case just the shim dependency needs to be updated.

Why a pseudo version​

In the master branch we must use a pseudo version for all the YuniKorn repository references we use. As the branch is in active development and not released we do not have a real version tag to reference. However, we still need to be able to point to the right commit for the dependencies.

Go allows using pseudo versions for these specific cases. An example of the pseudo versions we use in the Kubernetes shim:

module github.com/apache/yunikorn-k8shim

go 1.16

require (
	github.com/apache/yunikorn-core v0.0.0-20220325135453-73d55282f052
	github.com/apache/yunikorn-scheduler-interface v0.0.0-20220325134135-4a644b388bc4
	...
)

Release branches must not use pseudo versions. During the creation of a release, tags will be created. These tags will be used as the reference in the go.mod files for the release.

Enforcement of pseudo version​

In the pull request checks for the yunikorn-core and yunikorn-k8shim repositories enforce the format of the versions. A build failure will be triggered if the version reference for the yunikorn-core or yunikorn-scheduler-interface repositories in the master branch is not a pseudo version.

The check enforces that the start of the version reference is v.0.0.0-

Pseudo versions are not enforced in the release branches as per why a pseudo version explanation above.

Updating the core dependency​

Before updating the core dependency must make sure that the scheduler interface changes are finalised.

  1. Make the changes in the scheduler interface.
  2. Commit the changes into the master branch on GitHub and pull the latest master branch commit.
  3. Generate a new pseudo version for the scheduler-interface.

Updating the core dependency

  1. Update the go.mod file for the dependent repository: core repository
    • Open the go.mod file
    • Copy the generated pseudo version reference
    • Replace the scheduler-interface version reference with the one generated in step 3.
    • Save the go.mod file
  2. Run a make test to be sure that the change works. The build will pull down the new dependency and the change in the scheduler interface will be used.
  3. Commit the changes into the master branch on GitHub and pull the latest master branch commit

Updating a shim dependency​

Before updating a shim dependency you must make sure that the core dependency has been updated and committed. There are cases that the reference for the scheduler-interface has not changed. This is not an issue, either skip the update steps or execute them as per normal resulting in no changes as part of the commit.

  1. Generate a new pseudo version for the core
  2. Update the go.mod file for the dependent repository: k8shim repository
    • Open the go.mod file
    • Copy the generated pseudo version reference of the scheduler interface
    • Replace the scheduler-interface version reference with the one generated in step 3.
    • Copy the generated pseudo version reference of the core
    • Replace the core version reference with the one generated in step 7.
    • Save the go.mod file
  3. Run a make test to be sure that the change works. The build will pull down the new dependency and the changes in the core and scheduler interface will be used.
  4. Commit the changes into the master branch on GitHub
note

If multiple PRs are being worked on in the scheduler interface and or core at the same time a different PR might have already applied the update. This will all depend on the commit order. It is therefor that steps 5 and 8 are performed to make sure there is no regression.

Generating a pseudo version​

A pseudo references for use in a go.mod file is based on the commit hash and timestamp. It is simple to generate one using the following steps:

  1. Change to the repository for which the new pseudo version needs to be generated.
  2. Update the local checked out code for the master branch to get the latest commits
git pull; git status

The status should show up to date with the origin from where it was cloned. 3. Run the following command to get the pseudo version:

TZ=UTC git --no-pager show --quiet --abbrev=12 --date='format-local:%Y%m%d%H%M%S' --format='v0.0.0-%cd-%h'
  1. This command will print a line like this:
v0.0.0-20220318052402-b3dfd0d2adaa

That is the pseudo version that can be used in the go.mod files.

note

The pseudo version must be based on a commit that is in the vcs system, i.e. from Github. Local commits or commits that are not yet merged in a PR cannot be used.