Skip to content

Commit e526577

Browse files
committed
Initial commit.
0 parents  commit e526577

132 files changed

Lines changed: 861 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitattributes

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
* text=auto
2+
3+
*.fig binary
4+
*.mat binary
5+
*.mdl binary diff merge=mlAutoMerge
6+
*.mdlp binary
7+
*.mex* binary
8+
*.mlapp binary
9+
*.mldatx binary
10+
*.mlproj binary
11+
*.mlx binary
12+
*.p binary
13+
*.sfx binary
14+
*.sldd binary
15+
*.slreqx binary merge=mlAutoMerge
16+
*.slmx binary merge=mlAutoMerge
17+
*.sltx binary
18+
*.slxc binary
19+
*.slx binary merge=mlAutoMerge
20+
*.slxp binary
21+
22+
## Other common binary file types
23+
*.docx binary
24+
*.exe binary
25+
*.jpg binary
26+
*.pdf binary
27+
*.png binary
28+
*.xlsx binary
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- MATLAB: [e.g. R2023a Update 2]
29+
30+
**Additional context**
31+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/release.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
changelog:
2+
exclude:
3+
labels:
4+
- ignore-for-release
5+
categories:
6+
- title: Breaking Changes 🛠
7+
labels:
8+
- breaking-change
9+
- title: New Features 🎉
10+
labels:
11+
- enhancement
12+
- title: Bugfixes 🪲
13+
labels:
14+
- bug
15+
- title: Documentation 📖
16+
labels:
17+
- documentation
18+
- title: Other Changes
19+
labels:
20+
- "*"

.github/workflows/main.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: CI
2+
3+
# Controls when the workflow will run
4+
on:
5+
# Triggers the workflow on push or pull request events but only for the "main" branch
6+
push:
7+
branches: [ "main" ]
8+
paths-ignore:
9+
- 'README.md'
10+
- '.github/workflows/release.yml'
11+
12+
pull_request:
13+
branches: [ "main" ]
14+
15+
# Allows you to run this workflow manually from the Actions tab
16+
workflow_dispatch:
17+
18+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
19+
jobs:
20+
check-and-test:
21+
strategy:
22+
matrix:
23+
os: [ubuntu-latest, windows-latest]
24+
runs-on: ${{ matrix.os }}
25+
steps:
26+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
27+
- name: Check out repo
28+
uses: actions/checkout@v4
29+
30+
- name: Cache MATLAB build files
31+
uses: actions/cache@v4
32+
with:
33+
key: matlab-buildtool
34+
path: |
35+
.buildtool
36+
37+
- name: Set up MATLAB
38+
uses: matlab-actions/setup-matlab@v2
39+
40+
- name: Run MATLAB build
41+
uses: matlab-actions/run-build@v2
42+
43+
- name: Upload SARIF file
44+
if: success() || failure()
45+
uses: github/codeql-action/upload-sarif@v3
46+
with:
47+
# Path to SARIF file relative to the root of the repository
48+
sarif_file: code-issues/*.sarif
49+
# Optional category for the results
50+
# Used to differentiate multiple results for one commit
51+
category: matlab

.github/workflows/release.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Package toolbox and publish release
2+
3+
# Run workflow when a tag is created
4+
on:
5+
push:
6+
tags:
7+
- '*'
8+
9+
jobs:
10+
11+
packageToolbox:
12+
# The type of runner that the job will run on
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
17+
- name: Check out repo
18+
uses: actions/checkout@v4
19+
20+
- name: Cache MATLAB build files
21+
uses: actions/cache@v4
22+
with:
23+
key: matlab-buildtool
24+
path: |
25+
.buildtool
26+
27+
- name: Set up MATLAB
28+
uses: matlab-actions/setup-matlab@v2
29+
30+
- name: Run MATLAB build
31+
uses: matlab-actions/run-build@v2
32+
with:
33+
tasks: package('${{ github.ref_name }}')
34+
35+
# Create new release
36+
- name: Create a new release
37+
uses: softprops/action-gh-release@v2
38+
with:
39+
name: '${{ github.ref_name }}'
40+
files: '*.mltbx'
41+
fail_on_unmatched_files: true
42+
generate_release_notes: true

.gitignore

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
code-issues
2+
work
3+
4+
# Autosave files
5+
*.asv
6+
*.m~
7+
*.autosave
8+
*.slx.r*
9+
*.mdl.r*
10+
11+
# Derived content-obscured files
12+
*.p
13+
14+
# Compiled MEX files
15+
*.mex*
16+
17+
# Packaged app and toolbox files
18+
*.mlappinstall
19+
*.mltbx
20+
21+
# Deployable archives
22+
*.ctf
23+
24+
# Generated helpsearch folders
25+
helpsearch*/
26+
27+
# Code generation folders
28+
slprj/
29+
sccprj/
30+
codegen/
31+
32+
# Cache files
33+
*.slxc
34+
35+
# Cloud based storage dotfile
36+
.MATLABDriveTag
37+
38+
# buildtool cache folder
39+
.buildtool/
40+

CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributing
2+
3+
>_If you believe you have discovered a security vulnerability, please **do not** open an issue or make a pull request. Follow the instructions in the [SECURITY.MD](SECURITY.MD) file in this repository._
4+
5+
Thank you for your interest in contributing to a MathWorks repository! We encourage contributions large and small to this repository.
6+
7+
**Contributions do not have to be code!** If you see a way to explain things more clearly or a great example of how to use something, please contribute it (or a link to your content). We welcome issues even if you don't code the solution. We also welcome pull requests to resolve issues that we haven't gotten to yet!
8+
9+
## How to contribute
10+
11+
* **Open an issue:** Start by [creating an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue) in the repository that you're interested in. That will start a conversation with the maintainer. When you are creating a bug report, please include as many details as possible. Please remember that other people do not have your background or understanding of the issue; make sure you are clear and complete in your description.
12+
* **Work in your own public fork:** If you choose to make a contribution, you should [fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo). This creates an editable copy on GitHub where you can write, test, and refine your changes. We suggest that you keep your changes small and focused on the issue you submitted.
13+
* **Sign a Contributor License Agreement (CLA):** We require that all outside contributors sign a [CLA](https://en.wikipedia.org/wiki/Contributor_License_Agreement) before we can accept your contribution. When you create a pull request (see below), we'll reach out to you if you do not already have one on file. Essentially, the CLA gives us permission to publish your contribution as part of the repository.
14+
* **Make a pull request:** "[Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" is a confusing term, but it means exactly what it says: You're requesting that the maintainers of the repository pull your changes in. If you don't have a CLA on file, we'll reach out to you. Your contribution will be reviewed, and we may ask you to revise your pull request based on our feedback. Once everyone is satisfied, we'll merge your pull request into the repository.
15+
16+
## Guidelines
17+
18+
MathWorks maintains a set of best practices for creating MATLAB® toolboxes: [mathworks/toolboxdesign: Best practices for creating high-quality and user-friendly MATLAB toolboxes, including recommendations for file organization, testing, and releasing the toolbox](https://github.com/mathworks/toolboxdesign). In addition, you may want to consult the following resources.
19+
20+
* You should not have any warnings or errors in the [code analyzer report](http://www.mathworks.com/help/matlab/matlab_prog/matlab-code-analyzer-report.html)
21+
* [The MATLAB Blog](https://blogs.mathworks.com/matlab) has [great advice on improving your MATLAB code](https://blogs.mathworks.com/loren/category/best-practice/)
22+
* Examples should be written as [live scripts](https://www.mathworks.com/help/matlab/matlab_prog/what-is-a-live-script-or-function.html) and then [exported as HTML](https://www.mathworks.com/help/matlab/matlab_prog/share-live-scripts.html).
23+
* We adhere to the [CommonMark](https://commonmark.org/) specification where it does not conflict with GitHub rendering. If you edit your Markdown in Visual Studio Code or a similar editor, it uses [markdownlint](https://github.com/DavidAnson/markdownlint) to highlight issues in your Markdown.
24+
25+
**Again, thanks for contributing, and we look forward to your issues and pull requests!**

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# vcpkg Wrapper for MATLAB®
2+
This simple toolbox wraps [vcpkg - Open source C/C++ dependency manager from Microsoft®](https://vcpkg.io/en/index.html) to ease the integration into MATLAB projects that use vcpkg manifest files to define its dependencies.
3+
The wrapper toolbox figures out the host and target triplets as well as the compiler paths automatically. It only required vcpkg to be available on the system's path.
4+
5+
## Setup
6+
Download toolbox installer from releases in GitHub or File Exchange and install in MATLAB.
7+
8+
### MathWorks Products (https://www.mathworks.com)
9+
Requires MATLAB release R2019b or newer
10+
- [MATLAB®](https://www.mathworks.com/products/matlab.html)
11+
12+
### 3rd Party Products
13+
- [vcpkg](https://github.com/microsoft/vcpkg)
14+
15+
## Getting started
16+
The instructions for use are located in the [Getting Started documentation](toolbox/gettingStarted.mlx) and are part of the shipping toolbox.
17+
18+
## Community Support
19+
[MATLAB Central](https://www.mathworks.com/matlabcentral)

SECURITY.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Reporting Security Vulnerabilities
2+
3+
If you believe you have discovered a security vulnerability, please report it to
4+
[security@mathworks.com](mailto:security@mathworks.com). Please see
5+
[MathWorks Vulnerability Disclosure Policy for Security Researchers](https://www.mathworks.com/company/aboutus/policies_statements/vulnerability-disclosure-policy.html)
6+
for additional information.

0 commit comments

Comments
 (0)