Clarify how cross version testing works#5029
Conversation
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
liangz1
left a comment
There was a problem hiding this comment.
This is super informative and enjoyable to read, thanks for the contribution!
| @@ -1,60 +1,17 @@ | |||
| # Cross version tests | |||
| # GitHub Actions workflows | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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 });There was a problem hiding this comment.
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 |
| [`dev/update_ml_package_versions.py`]: ../../dev/update_ml_package_versions.py | ||
| [`.github/workflows/cross-version-tests.yml`]: ./cross-version-tests.yml | ||
|
|
||
| ## Configuration keys in `ml-package-versions.yml` |
There was a problem hiding this comment.
This is an awesome way to explain the file!
| [badge-img]: https://github.com/mlflow/mlflow/workflows/Cross%20version%20tests/badge.svg?event=schedule | ||
| [badge-target]: https://github.com/mlflow/mlflow/actions?query=workflow%3ACross%2Bversion%2Btests+event%3Aschedule | ||
|
|
||
| ## How to run dev tests on a pull request |
There was a problem hiding this comment.
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".
There was a problem hiding this comment.
| ## 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?
There was a problem hiding this comment.
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.
| Steps: | ||
|
|
||
| 1. Click `Labels` in the right sidebar. | ||
| 2. Select the `enable-dev-tests` label and make sure it's applied. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
For me, it looks like the cross-version tests are automatically triggered without doing these steps.
Yep, for non-dev versions. For example.
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
| @@ -1,60 +1,17 @@ | |||
| # Cross version tests | |||
| # GitHub Actions workflows | |||
BenWilson2
left a comment
There was a problem hiding this comment.
This is really great. Well done @harupy !
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
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?
(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 loggingarea/build: Build and test infrastructure for MLflowarea/docs: MLflow documentation pagesarea/examples: Example codearea/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registryarea/models: MLmodel format, model serialization/deserialization, flavorsarea/projects: MLproject format, project running backendsarea/scoring: MLflow Model server, model deployment tools, Spark UDFsarea/server-infra: MLflow Tracking server backendarea/tracking: Tracking Service, tracking client APIs, autologgingInterface
area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev serverarea/docker: Docker use across MLflow's components, such as MLflow Projects and MLflow Modelsarea/sqlalchemy: Use of SQLAlchemy in the Tracking Service or Model Registryarea/windows: Windows supportLanguage
language/r: R APIs and clientslanguage/java: Java APIs and clientslanguage/new: Proposals for new client languagesIntegrations
integrations/azure: Azure and Azure ML integrationsintegrations/sagemaker: SageMaker integrationsintegrations/databricks: Databricks integrationsHow should the PR be classified in the release notes? Choose one:
rn/breaking-change- The PR will be mentioned in the "Breaking Changes" sectionrn/none- No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" sectionrn/feature- A new user-facing feature worth mentioning in the release notesrn/bug-fix- A user-facing bug fix worth mentioning in the release notesrn/documentation- A user-facing documentation change worth mentioning in the release notes