Clarify how cross version testing works

[harupy]

What changes are proposed in this pull request?

As the PR title indicates, clarify how cross version testing works.

How is this patch tested?

NA

Release Notes

Is this a user-facing change?

• No. You can skip the rest of this section.
• Yes. Give a description of this change to be included in the release notes for MLflow users.

(Details in 1-2 sentences. You can just refer to another PR with a description if this PR is part of a larger change.)

What component(s), interfaces, languages, and integrations does this PR affect?

Components

• area/artifacts: Artifact stores and artifact logging
• area/build: Build and test infrastructure for MLflow
• area/docs: MLflow documentation pages
• area/examples: Example code
• area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
• area/models: MLmodel format, model serialization/deserialization, flavors
• area/projects: MLproject format, project running backends
• area/scoring: MLflow Model server, model deployment tools, Spark UDFs
• area/server-infra: MLflow Tracking server backend
• area/tracking: Tracking Service, tracking client APIs, autologging

Interface

• area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
• area/docker: Docker use across MLflow's components, such as MLflow Projects and MLflow Models
• area/sqlalchemy: Use of SQLAlchemy in the Tracking Service or Model Registry
• area/windows: Windows support

Language

• language/r: R APIs and clients
• language/java: Java APIs and clients
• language/new: Proposals for new client languages

Integrations

• integrations/azure: Azure and Azure ML integrations
• integrations/sagemaker: SageMaker integrations
• integrations/databricks: Databricks integrations

How should the PR be classified in the release notes? Choose one:

• rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
• rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
• rn/feature - A new user-facing feature worth mentioning in the release notes
• rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
• rn/documentation - A user-facing documentation change worth mentioning in the release notes

[liangz1]

This is super informative and enjoyable to read, thanks for the contribution!

[liangz1]

For completeness, shall we also include the *.js files and briefly introduce their functionality? I can only tell that they are frontend-related files, but not sure how will js files interact with yml files.

[harupy]

but not sure how will js files interact with yaml files.

actions/github-script runs them. The aim of these js files is just to improve the readability and editability. We can directly write JS code in the script field but it's much easier to edit JS code as a JS file than edit it on a yaml file because you can use syntax highlighting or code suggestions of your editor.

name: Notify DCO Failure

on:
  pull_request_target:
    types:
      - opened

jobs:
  notify:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/github-script@v4
        with:
          script: |
            const script = require(
              👇👇👇
              `${process.env.GITHUB_WORKSPACE}/.github/workflows/notify-dco-failure.js`
            );
            script({ context, github });

[harupy]

Including them in the table like below might clarify what they do:

## Automation

| File                        | Role                                                        |
| :-------------------------- | :---------------------------------------------------------- |
| `labeling.yml`              | Automatically apply labels on issues and PRs                |
| `notify-dco-failure.yml`    | Notify a DCO check failure                                  |
| `notify-dco-failure.js`     | The main script of the `notify-dco-failure.yml` workflow    |
| `release-note-category.yml` | Validate a release-note category label is applied on a PR   |
| `release-note-category.js`  | The main script of the `release-note-category.yml` workflow |

[liangz1]

Thanks!

[liangz1]

This is an awesome way to explain the file!

[harupy]

Thanks!

[liangz1]

This is the first occurrence of the term "dev tests". I think it would be nice to clarify what this refers to. I guess this is the same as cross-version tests because step 3 says "re-run the cross-version-tests workflow".

[harupy]

Suggested change

	## How to run dev tests on a pull request
	## How to run cross version tests for dev versions on a pull request

I agree renaming dev tests. How about cross version tests for dev versions?

[liangz1]

So this implies that cross-version tests for dev versions are not enabled on a pull request by default. That makes sense. In addition to the renaming, maybe we can also add Cross-version tests for dev versions are not enabled on a pull request by default. to L127.

[liangz1]

For me, it looks like the cross-version tests are automatically triggered without doing these steps. Why is that? Is the behavior different for different roles of this repo (e.g. member, contributor, other users)? If so, it would be nice to briefly mention it here.

[harupy]

For me, it looks like the cross-version tests are automatically triggered without doing these steps.

Yep, for non-dev versions. For example.

[liangz1]

LGTM!

[liangz1]

Thanks!

[BenWilson2]

This is really great. Well done @harupy !