mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-28 12:29:56 +00:00
Code Issues Releases Wiki Activity
5125b91b3f
TiddlyWiki5/editions/tw5.com/tiddlers/saving/Saving to a Git service.tid

27 lines
1.7 KiB
Plaintext
Raw Normal View History

Visual changes to Saving Tiddler (#4640) * Styles and templates for visual changes to Saving methods listing * Color coding saver methods according to delivery * Changes to tags and few tiddlers - The tag InternetExplorer has been changed to [[Internet Explorer]] - A tag for Edge is added - Reclassified TiddlyServer as DIY instead of App The existing criteriion for classification is unclear. Here is my reasoning for the change. An app is something user can simply install and run. Like TiddlyDesktop or Tiddloid. A DIY is something user has to install additional runtimes for. Thus Nodejs is a DIY. In the same vein, TiddlyServer is a DIY * Adding Twexe * Reversing accidental changes to StoryList * Restyling Download button and Card Size * Removing "Read more" links Entire card is now clickable To give visual clues regarding the clickability of card, title will change color to blue on card hover * Removing margins from elements under link and adding padding instead. Why this change? Margins are not "clickable". Having margins under <a> tag means there are minute dead areas where the mouse pointer will change shape, is not clickable and degrade user experience. Paddings are "clickable"
2020-06-14 10:48:13 +00:00
caption: Git Service Saver
color: #29B6F6
Add GitLab saver, apply common lingo to Git savers (#3931) * Transform GitHub saver to work with GitLab as well You can choose which provider you want to use, the data is given in the same place. I tried to avoid code duplication, so service providers' unique properties are in separate files, the settings of the selected provider are loaded. In two fields I am not sure that it fits into the current structure: * module-type: gitservice Which module is a `gitservice` type, it will be listed in the drop-down menu. * default-api-url: https://gitlab.com/api/v4 The default URL to access the provider's API. This is just a sketch, not a final version, suggestions for modification are welcome! * Rename saver from GitHub to GitService, update docs * Split GitHub and GitLab to separate savers, apply common lingo Sadly, it doesn't seem to make much sense to search for common parts in the code, because there might be a Git service that is very different from the GitHub API (such as BitBucket). Therefore, I feel that Git savers are not able to share other than the translations. I deleted the defaults values from the translations and set it to the text entry because they should not depend on the translations. * Add more information about the password field It is not clear how to create a personal access token, thus added a link to the help pages. In addition, GitLab only accepts personal access token, GitHub also accepts the password, so I made this clear. * Extract commit message to lingo * Fix indentation * Use improved base64 encoder Fix conflict with a06acc4eb8ade26cbb17b9f5911876bac1da7715
2019-07-31 20:38:52 +00:00
created: 20190408173002622
delivery: Service
description: Save changes directly to a Git repository (on GitHub, GitLab)
Visual changes to Saving Tiddler (#4640) * Styles and templates for visual changes to Saving methods listing * Color coding saver methods according to delivery * Changes to tags and few tiddlers - The tag InternetExplorer has been changed to [[Internet Explorer]] - A tag for Edge is added - Reclassified TiddlyServer as DIY instead of App The existing criteriion for classification is unclear. Here is my reasoning for the change. An app is something user can simply install and run. Like TiddlyDesktop or Tiddloid. A DIY is something user has to install additional runtimes for. Thus Nodejs is a DIY. In the same vein, TiddlyServer is a DIY * Adding Twexe * Reversing accidental changes to StoryList * Restyling Download button and Card Size * Removing "Read more" links Entire card is now clickable To give visual clues regarding the clickability of card, title will change color to blue on card hover * Removing margins from elements under link and adding padding instead. Why this change? Margins are not "clickable". Having margins under <a> tag means there are minute dead areas where the mouse pointer will change shape, is not clickable and degrade user experience. Paddings are "clickable"
2020-06-14 10:48:13 +00:00
method: save
modified: 20200507203007684
tags: Android Chrome Firefox [[Internet Explorer]] Linux Mac Opera Safari Saving Windows iOS Edge
title: Saving to a Git service
type: text/vnd.tiddlywiki
Add GitLab saver, apply common lingo to Git savers (#3931) * Transform GitHub saver to work with GitLab as well You can choose which provider you want to use, the data is given in the same place. I tried to avoid code duplication, so service providers' unique properties are in separate files, the settings of the selected provider are loaded. In two fields I am not sure that it fits into the current structure: * module-type: gitservice Which module is a `gitservice` type, it will be listed in the drop-down menu. * default-api-url: https://gitlab.com/api/v4 The default URL to access the provider's API. This is just a sketch, not a final version, suggestions for modification are welcome! * Rename saver from GitHub to GitService, update docs * Split GitHub and GitLab to separate savers, apply common lingo Sadly, it doesn't seem to make much sense to search for common parts in the code, because there might be a Git service that is very different from the GitHub API (such as BitBucket). Therefore, I feel that Git savers are not able to share other than the translations. I deleted the defaults values from the translations and set it to the text entry because they should not depend on the translations. * Add more information about the password field It is not clear how to create a personal access token, thus added a link to the help pages. In addition, GitLab only accepts personal access token, GitHub also accepts the password, so I made this clear. * Extract commit message to lingo * Fix indentation * Use improved base64 encoder Fix conflict with a06acc4eb8ade26cbb17b9f5911876bac1da7715
2019-07-31 20:38:52 +00:00
TiddlyWiki can save changes directly to a GitHub repository in the single file configuration.
Saving to a Git service is configured in the [[$:/ControlPanel]] in the ''Git Service Saver'' tab under the ''Saving'' tab. The following settings are supported:
* ''Type'' - (mandatory) the type of the service (e.g. GitHub, GitLab)
* ''Username'' - (mandatory) the username for the Git service account used for saving changes
* ''Password'' - (mandatory) the password, OAUTH token or personal access token for the specified account. Note that GitHub permits [[several different mechanisms|https://developer.github.com/v3/#authentication]] for authentication
* ''Repository'' - (mandatory) the name of the Git repository. Both the owner name and the repository name must be specified. For example `Jermolene/TiddlyWiki5`
Correct for new GitHub default branch (#5055) * Correct for new GitHub default branch This PR corrects the default branch of GitHub from master to main. This is ne GitHub repository configuration from Oct 1st, 2020 * Update Saving to a Git service.tid GitLab still uses `master` as default branch. * Add Kookma plugins as resources Some of Kookma resources including TW-Scripts, Commander, Trashbin, Todolist has been added. * Revert "Add Kookma plugins as resources" This reverts commit 199fce3a08f8e21c776c7e37734b0d36753bb3e8.
2020-11-17 14:45:32 +00:00
* ''Branch'' - (optional) the name of the branch to be used within the Git repository. Defaults to `main` (~GitHub) or `master` (~GitLab)"
Add GitLab saver, apply common lingo to Git savers (#3931) * Transform GitHub saver to work with GitLab as well You can choose which provider you want to use, the data is given in the same place. I tried to avoid code duplication, so service providers' unique properties are in separate files, the settings of the selected provider are loaded. In two fields I am not sure that it fits into the current structure: * module-type: gitservice Which module is a `gitservice` type, it will be listed in the drop-down menu. * default-api-url: https://gitlab.com/api/v4 The default URL to access the provider's API. This is just a sketch, not a final version, suggestions for modification are welcome! * Rename saver from GitHub to GitService, update docs * Split GitHub and GitLab to separate savers, apply common lingo Sadly, it doesn't seem to make much sense to search for common parts in the code, because there might be a Git service that is very different from the GitHub API (such as BitBucket). Therefore, I feel that Git savers are not able to share other than the translations. I deleted the defaults values from the translations and set it to the text entry because they should not depend on the translations. * Add more information about the password field It is not clear how to create a personal access token, thus added a link to the help pages. In addition, GitLab only accepts personal access token, GitHub also accepts the password, so I made this clear. * Extract commit message to lingo * Fix indentation * Use improved base64 encoder Fix conflict with a06acc4eb8ade26cbb17b9f5911876bac1da7715
2019-07-31 20:38:52 +00:00
* ''Path'' - (optional) the path to the target file. Defaults to `/`
* ''Filename'' - (mandatory) the filename of the target file
Notes
* The Git service password is stored persistently in browser local storage. Be sure to clear the password if using a shared machine. Using a [[personal access token|]] for authentication offers an extra layer of security: if the access token is accidentally exposed it can be revoked without needing to reset the account password
Reference in New Issue Copy Permalink