From 952be1373bd753b52dd2d6e4d9e9b4af807c9527 Mon Sep 17 00:00:00 2001 From: David Buzinski <103441853+davidbuzinski@users.noreply.github.com> Date: Wed, 17 Apr 2024 10:12:02 -0400 Subject: [PATCH] Remove Travis examples and documentation (#37) * remove travis examples * Update README.md * Update azure-pipelines.yml * incorporate doc feedback --- .travis.yml | 2 -- README.md | 30 ++++++------------------------ azure-pipelines.yml | 2 +- 3 files changed, 7 insertions(+), 27 deletions(-) delete mode 100644 .travis.yml diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index b52b45db..00000000 --- a/.travis.yml +++ /dev/null @@ -1,2 +0,0 @@ -language: matlab -script: matlab -batch "addpath('code'); results = runtests('IncludeSubfolders', true); assertSuccess(results);" \ No newline at end of file diff --git a/README.md b/README.md index d203ed77..3ecb5fb6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -| **Azure® DevOps** | **CircleCI®** | **GitHub® Actions** | **Travis CI™** | -|:---------------------------|:-----------------:|:----------------------------:|:--------------------------:| -| [![Build Status](https://dev.azure.com/iat-ci/ci-configuration-examples/_apis/build/status/mathworks.ci-configuration-examples)](https://dev.azure.com/iat-ci/ci-configuration-examples/_build)
![Azure DevOps Coverage](https://img.shields.io/azure-devops/coverage/iat-ci/ci-configuration-examples/36) | [![CircleCI](https://circleci.com/gh/mathworks/ci-configuration-examples.svg?style=svg)](https://circleci.com/gh/mathworks/ci-configuration-examples)

| [![MATLAB](https://github.com/mathworks/ci-configuration-examples/actions/workflows/ci.yml/badge.svg)](https://github.com/mathworks/ci-configuration-examples/actions/workflows/ci.yml)

| [![Build Status](https://app.travis-ci.com/mathworks/ci-configuration-examples.svg)](https://app.travis-ci.com/mathworks/ci-configuration-examples)

| +| **Azure® DevOps** | **CircleCI®** | **GitHub® Actions** | +|:---------------------------|:-----------------:|:----------------------------:| +| [![Build Status](https://dev.azure.com/iat-ci/ci-configuration-examples/_apis/build/status/mathworks.ci-configuration-examples)](https://dev.azure.com/iat-ci/ci-configuration-examples/_build)
![Azure DevOps Coverage](https://img.shields.io/azure-devops/coverage/iat-ci/ci-configuration-examples/36) | [![CircleCI](https://circleci.com/gh/mathworks/ci-configuration-examples.svg?style=svg)](https://circleci.com/gh/mathworks/ci-configuration-examples)

| [![MATLAB](https://github.com/mathworks/ci-configuration-examples/actions/workflows/ci.yml/badge.svg)](https://github.com/mathworks/ci-configuration-examples/actions/workflows/ci.yml)

| # Continuous Integration (CI) configuration examples for MATLAB® @@ -73,14 +73,6 @@ Badges look really great, but they're not always easy to set up. Take a look at
-| **Travis CI** | | -|:--------------------------|:-| -| Badge | [![Build Status](https://app.travis-ci.com/mathworks/ci-configuration-examples.svg)](https://app.travis-ci.com/mathworks/ci-configuration-examples) | -| Badge Code | \[\!\[Build Status](https[]()://app.travis-ci.com/***GITHUB_USERNAME***/***GITHUB_REPO_NAME***.svg)](https[]()://app.travis-ci.com/***GITHUB_USERNAME***/***GITHUB_REPO_NAME***) | -| Badge Help | [Travis CI documentation for setting up badges](https://docs.travis-ci.com/user/status-images/ "Travis CI documentation for setting up badges") | - -
- | **GitLab CI/CD** | | |:--------------------------|:-| | Badge Code | \[\!\[Pipeline Status](https[]()://gitlab.com/***GITLAB_PROJECT_PATH***/badges/***DEFAULT_BRANCH_NAME***/pipeline.svg)](https[]()://gitlab.com/***GITLAB_PROJECT_PATH***) | @@ -115,14 +107,13 @@ Badges look really great, but they're not always easy to set up. Take a look at * CircleCI * GitHub Actions * Jenkins™ -* Travis CI * GitLab CI/CD
## About the code -The primary goal of this repository is to provide a set of configuration files as templates that illustrate how to run MATLAB on various CI platforms (e.g., Azure DevOps, CircleCI, GitHub Actions, Jenkins, Travis CI). +The primary goal of this repository is to provide a set of configuration files as templates that illustrate how to run MATLAB on various CI platforms (e.g., Azure DevOps, CircleCI, GitHub Actions, Jenkins). Each of these pipeline definitions does four things: @@ -154,7 +145,6 @@ The repository includes these files: | [`.circleci/config.yml`](###CircleCI) | The [`config.yml`](.circleci/config.yml) file defines the pipeline that runs on [CircleCI](https://circleci.com/orbs/registry/orb/mathworks/matlab) | | [`.github/workflows/ci.yml`](###GitHub-Actions) | The [`ci.yml`](.github/workflows/ci.yml) file defines the pipeline that runs on [GitHub Actions](https://github.com/matlab-actions/overview) | | [`Jenkinsfile`](###Jenkins) | The [`Jenkinsfile`](Jenkinsfile) file defines the pipeline that runs on [Jenkins](https://plugins.jenkins.io/matlab/) | -| [`.travis.yml`](###Travis-CI) | The [`.travis.yml`](.travis.yml) file defines the pipeline that runs on [Travis CI](https://docs.travis-ci.com/user/languages/matlab/) | | [`.gitlab-ci.yml`](###GitLab-CI/CD) | The [`.gitlab-ci.yml`](.gitlab-ci.yml) file defines the pipeline that runs on [GitLab CI/CD](https://docs.gitlab.com/ee/ci/) |
@@ -184,7 +174,7 @@ steps: pathToSources: 'code/' # As an alternative to RunMATLABTests, you can use RunMATLABCommand to execute a MATLAB script, function, or statement. - # - task: RunMATLABCommand@0 + # - task: RunMATLABCommand@1 # inputs: # command: addpath('code'); results = runtests('IncludeSubfolders', true); assertSuccess(results); ``` @@ -285,13 +275,6 @@ pipeline {
-### Travis CI -```yml -language: matlab -script: matlab -batch "addpath('code'); results = runtests('IncludeSubfolders', true); assertSuccess(results);" -``` -
- ### GitLab CI/CD ```yml stages: @@ -306,8 +289,7 @@ matlab-test: ## Caveats -* MATLAB builds on Travis CI are available only for public projects. -* MATLAB builds on Azure DevOps, CircleCI, and GitHub Actions that use CI service-hosted agents are also available only for public projects. However, these integrations can also be used in private projects that leverage self-hosted runners/agents. +* On cloud-hosted agents provided by Azure DevOps, CircleCI, and GitHub Actions, you need a [MATLAB batch licensing token](https://github.com/mathworks-ref-arch/matlab-dockerfile/blob/main/alternates/non-interactive/MATLAB-BATCH.md#matlab-batch-licensing-token) if your project is private or if your pipeline includes transformation products, such as MATLAB Coder™ and MATLAB Compiler™. You can request a token by contacting MathWorks® at [batch-tokens@mathworks.com](mailto:batch-tokens@mathworks.com).
diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 0e02750e..67753c43 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -20,6 +20,6 @@ steps: pathToSources: 'code/' # As an alternative to RunMATLABTests, you can use RunMATLABCommand to execute a MATLAB script, function, or statement. - # - task: RunMATLABCommand@0 + # - task: RunMATLABCommand@1 # inputs: # command: addpath('code'); results = runtests('IncludeSubfolders', true); assertSuccess(results);