Twinpack Package Registry

This repository contains a list of GitHub repositories that are automatically published to the Twinpack Package Manager via a GitHub workflow.

Adding a package

If you would like to make a TwinCAT library available for installation via Twinpack, please submit a pull request that adds the URL of your repository to repositories.txt. You are welcome to add multiple libraries at once.

See the instructions below for detailed instructions on how to do this via the GitHub web interface.

Instructions

1. Create a new fork by clicking https://github.com/Zeugwerk/Twinpack-Registry/fork
   The new page page will open.
2. Click the Create fork button in the "Create a new fork" page.
3. Wait for the "Forking" process to finish.
   The home page of your fork of the Twinpack-Registry repository will open.
4. Click on the file repositories.txt under the list of files you see in that page.
5. Click the pencil icon ("Edit this file") at the right side of the toolbar
   The repositories.txt file will open in the online text editor.
6. Add your repository's URL to the list (it doesn't matter where in the list). This should be the URL of the repository home page. For example: https://github.com/stefanbesler/struckig
7. Click the Commit changes... button located near the top right corner of the page.
   The "Commit changes" dialog will open.
8. Click the Commit changes button in the "Commit changes" dialog.
   The "Twinpack-Registry/repositories.txt" page will open.
9. Click the "Twinpack-Registry" link at the top of the "library-registry/repositories.txt" page.
   The home page of your fork of the Twinpack-Registry repository will open.
10. Click the "Contribute" link near the right side of that banner.
    A menu will open.
11. Click the Open pull request button in the menu.
    The "Open a pull request" page will open.
12. In the "Open a pull request" window that opens, click the Create pull request button.

At the moment PR are processed by somebody of our team. We will check if your repositories releases qualify to be put on the list, we will check that

• Your repository has at least 1 release,
• your release(s) are published having a .library file in their assets,
• your repository contains a LICENSE (or LICENSE.txt) file, since this will be automatically linked with the package,
• the .library files contains the meta information Twinpack requires, the bare minimum is "Library Name", "Company Name" (Distributor name) and "Version".
• If we see an icon in your repository that makes sense to use, we'll ask you for permission to link it with the package

If any problems are found, we'll respond in the pull request. The problem may be either with your pull request or your repository.

If the problem is with the pull request:

Edit the file in the branch you submitted the pull request from in your fork of the Zeugwerk/Twinpack-Registry repository, then commit.

If the problem is with the repository:

1. Make the necessary fix in the repository.
2. Increment the version of your TwinCAT library
3. Create a release or tag and include your library in the assets of the release. Alternatively, you can redo the existing release/tag if you prefer.
4. Comment on your pull request here in the Twinpack/Twinpack-Registry repository

Changing the URL of a library already in Twinpack-Registry

Submit a pull request that changes the URL as desired in repositories.txt. This can be done by following the instructions above.

Removing a library from Twinpack-Registry

Submit a pull request that removes the URL from repositories.txt. This can be done by following the instructions above.

Report a problem with Twinpack-Registry

Please submit an issue report here