RGBCube/GitHub2Forgejo
1
Fork 0
mirror of https://github.com/RGBCube/GitHub2Forgejo synced 2025-07-26 20:57:44 +00:00
Code Issues Activity Actions

doc: specify case sensitivity

Browse source
This commit is contained in:
RGBCube 2025-04-11 19:41:41 +03:00
parent 5fcc8e423b
commit 875305869a
Signed by: RGBCube
SSH key fingerprint: SHA256:CzqbPcfwt+GxFYNnFVCqoN5Itn4YFrshg1TrnACpA5M
2 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -14,7 +14,7 @@ Migrates a GitHub users repositories to a Forgejo instance.
Accepted environment variables: Accepted environment variables:
GITHUB_USER: The user to fetch the repositories from. GITHUB_USER: The user to fetch the repositories from. Case sensitive.
GITHUB_TOKEN: An access token for fetching private repositories. Optional. GITHUB_TOKEN: An access token for fetching private repositories. Optional.
FORGEJO_URL: The URL to the Forgejo instance. Must include the protocol (https://). FORGEJO_URL: The URL to the Forgejo instance. Must include the protocol (https://).
@ -37,12 +37,13 @@ Usage:
> github2forgejo > github2forgejo
Flags: Flags:
-h, --help - Display the help message for this command -h, --help: Display the help message for this command
``` ```
</details> </details>
You can either specify all the environment variables You can either specify all the environment variables for a uninteractive run, or
for a uninteractive run, or run the script like so: run the script like so:
```nu ```nu
./github2forgejo ./github2forgejo
@ -119,13 +120,12 @@ The script is also available as a package, you just need to use the
### What is the difference between mirroring and cloning? ### What is the difference between mirroring and cloning?
- **Mirroring:** Will get updated every now and then, - **Mirroring:** Will get updated every now and then, keeping the repository in
keeping the repository in sync with the remote. sync with the remote.
- **Cloning:** Will only clone the remote, and will - **Cloning:** Will only clone the remote, and will not update or link to it
not update or link to it anywhere in the repository. anywhere in the repository. This is good for when you are migrating off GitHub
This is good for when you are migrating off GitHub permanently permanently and will never come back.
and will never come back.
### Can I migrate specific repositories? ### Can I migrate specific repositories?

2
github2forgejo
View file

@ -12,7 +12,7 @@ def or-default [default: closure] {
# #
# Accepted environment variables: # Accepted environment variables:
# #
# GITHUB_USER: The user to fetch the repositories from. # GITHUB_USER: The user to fetch the repositories from. Case sensitive.
# GITHUB_TOKEN: An access token for fetching private repositories. Optional. # GITHUB_TOKEN: An access token for fetching private repositories. Optional.
# #
# FORGEJO_URL: The URL to the Forgejo instance. Must include the protocol (https://). # FORGEJO_URL: The URL to the Forgejo instance. Must include the protocol (https://).