Template Repository for Open-Source MATLAB

Quickstart your public MATLAB repository. Batteries included 🔋

How to use

First, click Use this template to make your own repository from this template. Clone your new repository.

Then locally:

1. Run init function for cleanup
2. Upload your own MATLAB code
3. Change anything else to your liking
4. Commit changes appropriately along the way

Then, in Settings — Actions — General of your repository:

1. Allow all actions and reusable workflows
2. Allow GitHub Actions to create and approve pull requests

To enable repository webpage deployment:

• Settings — Pages — Build and deployment — Source = GitHub Actions

You can also import a pre-built ruleset to protect main branch from accidental unwanted hard-to-recover changes.
In Settings — Rules — Rulesets of your repository:

1. Click New ruleset — Import a ruleset
2. Upload .github/rules/main.json
3. Modify if needed and save

Then push the local changes and carry on with the development of your freshly established public MATLAB project!

Please go to repository's Wiki (when it's ready) for more detailed user manual.

Do not hesitate to ask me for assistance and technical support.
And everyone is welcome to open issues to request a feature, enhance the documentation, or report a bug.

Known template users

• GitHub search query
• Forks

StrataTrapper
par-waitbar

Features

• Automated Path initialization on startup
• Utility functions for analyzing legacy MATLAB scripts
• .gitignore for MATLAB/Simulink/Octave
• MATLAB code checks on pull requests and pushes to main branch
• Automated releases based on Conventional Commits
• Dependabot for GitHub Actions
• README deployment at <user>.github.io/<repo>
• BSD 3-Clause open-source license

References

• Creating a Repository From a Template
• Overview of MATLAB Build Tool
• User-defined startup script for MATLAB
• .gitignore generator
• Choosing an Open Source License
• Conventional Commits