Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,22 @@
# Website for Generating a MATLAB Workflow
# Generate Starter Workflow for MATLAB

The [GitHub Actions Workflow Generator for MATLAB](https://matlab-actions.github.io/workflow-generator/) website enables you to generate a starter GitHub® Actions workflow for your GitHub repository that contains MATLAB® code and Simulink® models.
Use [GitHub® Actions Workflow Generator for MATLAB](https://matlab-actions.github.io/workflow-generator/) to create a starter workflow for a repository that contains MATLAB® code and Simulink® models. You can use the generated workflow as a foundation for defining your own custom workflow.

## See Also
To generate a starter workflow for your repository, in the workflow generation interface:

1. Enter your repository URL or GitHub username and repository.
2. (Optional) Under **Advanced Options**, select one or more options to customize the workflow.
3. Click **Generate Workflow**.

<img src="https://github.com/user-attachments/assets/508d226f-b1b2-4128-aee0-6276094dfae0" width="50%" height="50%">

The workflow generator automatically displays the starter workflow in the workflow editor of your repository. Modify the generated workflow as needed, and commit your changes to save the workflow file in the `.github/workflows` directory of your repository.

- [Action for Running MATLAB Builds](https://github.com/matlab-actions/run-build/)
- [Action for Running MATLAB Commands](https://github.com/matlab-actions/run-command/)
- [Action for Setting Up MATLAB](https://github.com/matlab-actions/setup-matlab/)
For more information about the available GitHub actions for MATLAB that you can use to define your workflow, see [Use MATLAB with GitHub Actions](https://github.com/matlab-actions).

## See Also
- [Use MATLAB with GitHub Actions](https://github.com/matlab-actions)
- [Continuous Integration with MATLAB and Simulink](https://www.mathworks.com/solutions/continuous-integration.html)

## Contact Us

If you have any questions or suggestions, contact MathWorks&reg; at [continuous-integration@mathworks.com](mailto:continuous-integration@mathworks.com).