Skip to content

Commit 631cb9d

Browse files
Update gitlab example (#72)
* Update links to use READMEs, CONFIGDOC, or OVERVIEW pages * Add comments to .gitlab-ci.yml Added comments for MATLAB Build Component usage. * Clean up link * Address feedback in README * Address feedback for .gitlab-ci.yml comments Updated comments to clarify the purpose of the pipeline configuration. * Fix typo * Fix typo
1 parent c3d5007 commit 631cb9d

File tree

2 files changed

+11
-8
lines changed

2 files changed

+11
-8
lines changed

.gitlab-ci.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
1+
# This pipeline configuration uses the `build` component to run a build using the MATLAB build tool. The component runs the
2+
# default tasks in a build file named `buildfile.m` located in the repository, using the latest release of MATLAB.
3+
# For more information about the `build` component, see https://gitlab.com/mathworks/components/matlab/-/blob/main/README.md.
14
include:
25
- component: $CI_SERVER_FQDN/mathworks/components/matlab/build@~latest

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -132,14 +132,14 @@ The repository includes these files:
132132

133133
| **File Path** | **Description** |
134134
|:---------------------------|:----------------|
135-
| [`code/dayofyear.m`](code/dayofyear.m) | The [`dayofyear`](code/dayofyear.m) function returns the day-of-year number for a given date string "mm/dd/yyyy" |
136-
| [`tests/TestExamples.m`](tests/TestExamples.m) | The [`TestExamples`](tests/TestExamples.m) class provides a few equality and negative tests for the [`dayofyear`](code/dayofyear.m) function |
137-
| [`tests/ParameterizedTestExample.m`](tests/ParameterizedTestExample.m) | The [`ParameterizedTestExample`](tests/ParameterizedTestExample.m) class provides 12 tests for the [`dayofyear`](code/dayofyear.m) function using the parameterized test format |
138-
| [`azure-pipelines.yml`](azure-pipelines.yml) | The [`azure-pipelines.yml`](azure-pipelines.yml) file defines the pipeline that runs on [Azure DevOps](https://marketplace.visualstudio.com/items?itemName=MathWorks.matlab-azure-devops-extension). |
139-
| [`.circleci/config.yml`](.circleci/config.yml) | The [`config.yml`](.circleci/config.yml) file defines the pipeline that runs on [CircleCI](https://circleci.com/orbs/registry/orb/mathworks/matlab) |
140-
| [`.github/workflows/ci.yml`](.github/workflows/ci.yml) | The [`ci.yml`](.github/workflows/ci.yml) file defines the pipeline that runs on [GitHub Actions](https://github.com/matlab-actions/overview) |
141-
| [`Jenkinsfile`](Jenkinsfile) | The [`Jenkinsfile`](Jenkinsfile) file defines the pipeline that runs on [Jenkins](https://plugins.jenkins.io/matlab/) |
142-
| [`.gitlab-ci.yml`](.gitlab-ci.yml) | The [`.gitlab-ci.yml`](.gitlab-ci.yml) file defines the pipeline that runs on [GitLab CI/CD](https://docs.gitlab.com/ee/ci/) |
135+
| [`code/dayofyear.m`](code/dayofyear.m) | The [`dayofyear`](code/dayofyear.m) function returns the day-of-year number for a given date string "mm/dd/yyyy". |
136+
| [`tests/TestExamples.m`](tests/TestExamples.m) | The [`TestExamples`](tests/TestExamples.m) class provides a few equality and negative tests for the [`dayofyear`](code/dayofyear.m) function. |
137+
| [`tests/ParameterizedTestExample.m`](tests/ParameterizedTestExample.m) | The [`ParameterizedTestExample`](tests/ParameterizedTestExample.m) class provides 12 tests for the [`dayofyear`](code/dayofyear.m) function using the parameterized test format. |
138+
| [`azure-pipelines.yml`](azure-pipelines.yml) | The [`azure-pipelines.yml`](azure-pipelines.yml) file defines the pipeline that runs using the [MATLAB extension for Azure DevOps](https://github.com/mathworks/matlab-azure-devops-extension/blob/master/overview.md). |
139+
| [`.circleci/config.yml`](.circleci/config.yml) | The [`config.yml`](.circleci/config.yml) file defines the pipeline that runs using the [MATLAB orb for CircleCI]([https://circleci.com/orbs/registry/orb/mathworks/matlab](https://github.com/mathworks/matlab-circleci-orb/blob/master/README.md). |
140+
| [`.github/workflows/ci.yml`](.github/workflows/ci.yml) | The [`ci.yml`](.github/workflows/ci.yml) file defines the pipeline that runs using the [MATLAB actions for GitHub Actions](https://github.com/matlab-actions/overview). |
141+
| [`Jenkinsfile`](Jenkinsfile) | The [`Jenkinsfile`](Jenkinsfile) file defines the pipeline that runs using the [MATLAB plugin for Jenkins](https://github.com/jenkinsci/matlab-plugin/blob/master/CONFIGDOC.md). |
142+
| [`.gitlab-ci.yml`](.gitlab-ci.yml) | The [`.gitlab-ci.yml`](.gitlab-ci.yml) file defines the pipeline that runs using the [MATLAB `build` component for GitLab CI/CD](https://gitlab.com/mathworks/components/matlab/-/blob/main/README.md). |
143143

144144
<br>
145145

0 commit comments

Comments
 (0)