cossmass/git-next
1
0
Fork 0
forked from kemitix/git-next
Code Pull requests Activity

docs(readme): fix typos and clarifications

Browse source
This commit is contained in:
Paul Campbell 2024-05-31 19:13:14 +01:00
parent 8d42945c37
commit 9462957c5e
1 changed files with 18 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -93,7 +93,7 @@ the server starts up.
#### forge #### forge
Within the forge tree, specify each forge you want to monitore repos on. Within the forge tree, specify each forge you want to monitor repos on.
Give your forge an alias, e.g. `default`, `gh`, `github`. Give your forge an alias, e.g. `default`, `gh`, `github`.
@ -143,7 +143,7 @@ lines. Both are equivalent. What is not equivalent between `my-repo` and
itself. `other-repo` specifies the `main`, `next` and `dev` branches to be itself. `other-repo` specifies the `main`, `next` and `dev` branches to be
used, but `my-repo` doesn't. used, but `my-repo` doesn't.
A sample `.git-next-toml` file that would need to exist in the `user/other` A sample `.git-next-toml` file that would need to exist in `my-repo`'s `owner/repo`
repo, on the `main` branch: repo, on the `main` branch:
```toml ```toml
@ -154,8 +154,8 @@ dev = "dev"
``` ```
- **repo** - the owner and name of the repo to be monitored - **repo** - the owner and name of the repo to be monitored
- **branch** - the branch to look for a `.git-next.toml` file is needed - **branch** - the branch to look for a `.git-next.toml` file if needed
- **gitdir** - (optional) you can use local copy of the repo - **gitdir** - (optional) you can use a local copy of the repo
- **main** - the branch to use as `main` - **main** - the branch to use as `main`
- **next** - the branch to use as `next` - **next** - the branch to use as `next`
- **dev** - the branch to use as `dev` - **dev** - the branch to use as `dev`
@ -164,15 +164,17 @@ dev = "dev"
Additional notes on using `gitdir`: Additional notes on using `gitdir`:
When you specify the `gitdir` value, the repo will be used for perform the When you specify the `gitdir` value, the repo cloned in that directory will
equivalent of `git fetch`, `git push` and `git push --force-with-lease`. be used for perform the equivalent of `git fetch`, `git push` and `git push
--force-with-lease`.
These commands will not affect the contents of your working tree, not will These commands will not affect the contents of your working tree, nor will
it change any local branches. Only the details about branches on the remote it change any local branches. Only the details about branches on the remote
forge will be updated. forge will be updated.
Currently `git-next` can only use a `gitdir` if the forge is the same one Currently `git-next` can only use a `gitdir` if the forge and repo is the
specified as `origin`. Otherwise the behaviour is untested/undefined. same one specified as the `origin` remote. Otherwise the behaviour is
untested and undefined.
## Behaviour ## Behaviour
@ -320,9 +322,14 @@ git next server start
The following forges are supported: The following forges are supported:
- [ForgeJo](https://forgejo.org) - [ForgeJo](https://forgejo.org) (probably compatible with Gitea, but not tested)
- [GitHub](https://github.com/) - [GitHub](https://github.com/)
Note: ForgeJo is a hard fork of Gitea, but currently they are largely compatible.
For now using a `forge_type` of `ForgeJo` with a Gitea instance will probably work
okay. The only API calls we make are around registering and unregistering webhooks.
So, as long as those APIs remain the same, they should be compatible.
#### ForgeJo #### ForgeJo
Configure the forge in `git-next-server.toml` like: Configure the forge in `git-next-server.toml` like:
@ -350,7 +357,7 @@ Configure the forge in `git-next-server.toml` like:
```toml ```toml
[forge.gh] [forge.gh]
forge_type = "GitHub" forge_type = "GitHub"
hostname = "github.com" hostname = "github.com" # required even for GitHub
user = "bob" user = "bob"
token = "..." token = "..."