pcdshub / pcdshub/pre-commit-hooks

TwinCAT XAE Shell Built-in Git Integration

Open
#7 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
12
Forks
13
Avg merge
7d 7h
Merged PRs (30d)
1

Description

Investigate the built-in git from the TwinCAT XAE shell and figure out how to configure it to run the pre-commit hooks properly

I started investigating this a little bit using the TwinCAT installed on the programming node. In the TwinCAT docs, the interface appears to have more configuration options than mine does in Tools > Options > Source Control, where I only have the option of changing my source control plug-in. I assume this means that the git plugin doesn't have any configuration options.

I peeked at the pre-commit hook script generated on Windows and the shebang looks like:
#!/usr/bin/env python.exe
I'm not sure if this leads to any clues, or if modifying this default script will be the path forward.

As an aside, there will need to be extra effort to get this working at all on the programming node due to the airgap

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the TwinCAT XAE Shell at Tools > Options > Source Control and inspect the generated Windows pre-commit hook, including its Python shebang. Determine whether the built-in Git integration can run the hook and what the air-gapped programming node requires; done means the configuration or limitation is documented and hook execution is verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, python
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.