You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
So aws secret key and access key are not likely to end up in examples output, but account id and possibly region may end up in output. Region is probably not an issue but the googling I've done so far suggests it's best to hide account id too.
Not sure how to deal with this yet, but here are some options:
After examples are run, run a script to scrub al the .Rd files, just read each file in, look for any secrets line by line, and replace the string if found, then writelines back. Not sure if this will be straightforward or not. This could be run every time docs are generated via Makefile route, which I always use, but we can't be certain some commits in the future won't use a different approach to generate docs.
Have a separate function (which has to be exported) to scrub secrets - already written this locally. Downside of this is we have an additional function in the example and then have to explain in each instance why its there. Just seems sloppy
Have logic inside all functions or just the set we know that may output account id that scrubs it whenever we detect that it's being run to generate docs - not sure this is possible yet, haven't tried. I don't love this approach because it adds extra code into many functions that's not related to the point/goal of the function, sloppy
Regardless of approach used above, ideally we have a pre-commit hook or something similar to check for any secrets and stop the commit if there are any found
The text was updated successfully, but these errors were encountered:
So aws secret key and access key are not likely to end up in examples output, but account id and possibly region may end up in output. Region is probably not an issue but the googling I've done so far suggests it's best to hide account id too.
Not sure how to deal with this yet, but here are some options:
Regardless of approach used above, ideally we have a pre-commit hook or something similar to check for any secrets and stop the commit if there are any found
The text was updated successfully, but these errors were encountered: