mirror of
https://gitea.computerliebe.org/ComputerLiebe_ORG_private/Gitea-VSCode-Clone-Plugin.git
synced 2024-12-29 00:11:53 +00:00
Peter Schuemann
f2ed934e91
* feat(gitea-git-clone): update CHANGELOG.md for version 1.0.1 * feat(gitea-git-clone): add LICENSE file * feat(gitea-git-clone): update README.md with new features and commands * feat(gitea-git-clone): add gitea-workflow-1.0.0.vsix file * feat(gitea-git-clone): add vscode_gitea_plugin.png image * feat(gitea-git-clone): update package.json version to 1.0.1
59 lines
2.5 KiB
Markdown
59 lines
2.5 KiB
Markdown
A Visual Studio Code extension that allows you to clone repositories from your Gitea instance via SSH, manage Gitea authentication using a Personal Access Token (PAT), and create Pull Requests (PRs) directly from your workspace.
|
|
Features
|
|
|
|
### Gitea Authentication:
|
|
- Authenticate with your Gitea instance using a Personal Access Token.
|
|
### Clone via SSH:
|
|
- Clone repositories from Gitea using SSH URLs.
|
|
### Auto-Open Repository:
|
|
- After cloning, the repository will be automatically opened in the workspace.
|
|
### Create Pull Requests:
|
|
- Create Pull Requests directly from your workspace without leaving VSCode. Automatically set the title, body, and branch for the PR.
|
|
|
|
## Commands
|
|
|
|
`Gitea: Authenticate` Authenticate with your Gitea instance using your Personal Access Token (PAT).
|
|
`Gitea: Configure` Set the URL of your Gitea instance and your PAT.
|
|
`Gitea: Clone Repository` Clone a repository from Gitea via SSH.
|
|
`Gitea: Create Pull Request` Create a Pull Request for the current repository.
|
|
|
|
## Requirements
|
|
|
|
A Gitea instance with SSH access.
|
|
A Personal Access Token (PAT) from your Gitea instance for authentication.
|
|
|
|
## Configuration
|
|
|
|
You can configure the Gitea instance URL and your Personal Access Token in your VSCode settings:
|
|
|
|
````json
|
|
|
|
{
|
|
"gitea.instanceUrl": "https://your-gitea-instance.com",
|
|
"gitea.personalAccessToken": "your-personal-access-token"
|
|
}
|
|
````
|
|
|
|
## Usage
|
|
Authentication
|
|
|
|
Run <Gitea: Authenticate> to authenticate with your Gitea instance.
|
|
You can set or update your Gitea instance URL and Personal Access Token by running <Gitea: Configure>
|
|
|
|
Cloning a Repository
|
|
|
|
Run <Gitea: Clone Repository> to clone a repository from your Gitea account.
|
|
Choose the repository you want to clone and select the folder where you want to clone it.
|
|
The repository will be cloned via SSH and automatically opened in VSCode.
|
|
|
|
Creating a Pull Request
|
|
|
|
Ensure that you are on the branch for which you want to create a Pull Request.
|
|
Run <Gitea: Create Pull Request> from the command palette.
|
|
The PR title will be automatically set to the latest commit message, and the body will include the commit description (if any).
|
|
The current branch will be used as the source (head), and the base branch will be automatically fetched from the repository's default branch (e.g., main or master).
|
|
Once the Pull Request is created, the Gitea web interface will open in your browser for further review.
|
|
|
|
## Issues
|
|
|
|
If you encounter any issues or have feature requests, please feel free to submit them in the issues section. |