[BETA] [Publisher] ✨ Dry-run (or test-mode… Or local folder for test ?) #278
Mara-Li
announced in
Announcements
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Presenting DRY RUN
What is this?
It's a way to locally test the plugin before sending the files to GitHub. It is referred to as a test mode.
How it works?
When the setting is enabled, all commands become local.
In the setting tab, under GitHub configuration, you can enable test mode. A text area will appear where you can set the local folder, simulating the repository. This folder doesn't need to exist and will always be in your vault. You can use some variables to dynamically allocate the folder name based on your repository settings:
{{owner}}
: Your GitHub username{{repo}}
: The repository name{{branch}}
: The main branchIt's especially useful if you have multiple repositories configured.
You can also use the auto-clean function, which will move all deleted/unshared folders and files to
.trash
and delete empty folders recursively. Note that if everything is empty, the dry-run folder will be entirely deleted.Warning
You can't "push" the dry-run folder while the setting is enabled.
Why?
This function is intended to be used as a test to check if everything is okay with your workflow (path settings, replacement, wikilinks, etc.). It wasn't created to allow a git repository into a local folder, but it can be used for that purpose (using, for example, the git plugin).
Important
As this function is currently unsupported, help won't be provided if you use the dry-run function in this manner.
Beta Was this translation helpful? Give feedback.
All reactions