pin template with documentation, sample "file" pin #203
Conversation
This should ease writing new pins a lot, for newcomers and for experienced authors as well.
|
|
||
| == BUGS | ||
|
|
||
| Requires the directories for that file already exists. |
There was a problem hiding this comment.
I would rewrite this as:
"Requires that directories for that file already exist"
|
Certainly. Not being a native English speaker, such glitches do happen. |
cbiedl
force-pushed
the
template-file-pin
branch
from
08226c6 to
91f9058
Compare
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| . @initramfstoolsdir@/hook-functions | ||
|
|
||
| die() { | ||
| code="$1" |
Check warning
Code scanning / shellcheck
code appears unused. Verify use (or export if used externally).
This is a very simple pin, and possibly rather for educational purposes: Store the jwk at a given place in the file system.
cbiedl
force-pushed
the
template-file-pin
branch
from
91f9058 to
b44e13e
Compare
|
Okay, found some minor issues so I've updated my branch (also, rebased it on top of HEAD). This resulted in some warnings/errors from CI I fail to understand. Feel free to take it as-is. |
Thanks for the PR. The differential shellcheck issue looks like a false positive, so no need to worry for that. |
|
Is there any way one can assist to getting this merged? |
|
Changes LGTM. @sergio-correia: can you please provide feedback when possible? |
There was a problem hiding this comment.
Change LGTM. @sergio-correia : can you please provide your feedback when possible?
At least for me, writings pins was hard since I had to figure out the concept behind them, and when studying the existing ones, finding out what's generic pin logic and what it specific for that pin wasn't that easy either.
That should not be repeated for anyone else, so I created
src/pins/template/and filled it my several files and a lot of explanations embedded.Also a new pin "file" as a demonstration of a minimal pin that uses a file to store the key. I'd consider this suitable for educational puposes only, but you think it's worth to include it in the official distribution, go ahead. Actually, this was im preparation of #185 which will get a fix soon.