Compare commits

...

3 commits

Author SHA1 Message Date
BradBot_1 5c4040acc5 CHORE: update docker compose to new requirements
All checks were successful
continuous-integration/drone/push Build is passing
2023-02-23 23:10:21 +00:00
BradBot_1 27ec51a3ee CHORE: update readme to reflect changes 2023-02-23 23:10:06 +00:00
BradBot_1 b1facb1cba FEAT: Configurable readme committer 2023-02-23 23:06:14 +00:00
3 changed files with 20 additions and 4 deletions

View file

@ -36,6 +36,15 @@ The password for the SSL certification, no default
Environment version of [data.json](https://git.bb1.fun/BradBot_1/GiteaForwarder/src/branch/master/data.json), no default
### `README_NAME`
The name of the user that will commit the readme changes (if enabled), defaults to GiteaForwarder
### `README_EMAIL`
The email of the user that will commit the readme changes (if enabled), defaults to donotreply@bb1.fun
## Examples
### Docker run
@ -43,13 +52,13 @@ Environment version of [data.json](https://git.bb1.fun/BradBot_1/GiteaForwarder/
#### With an environment variable
```shell
docker run --name forwarder -e PORT=80 -e DATA='[{"origin":"https://git.example.com/user/repo","recipients":[{"modifyReadme":true,"url":"https://gitlab.com/user/repo","authors":[{"old":"user@example.com","email":"00000000+user@users.noreply.github.com","name":"user"}]}]}]' -p 80:80 -d bradbot1/gitea-forwarder
docker run --name forwarder -e PORT=80 -e README_NAME=GiteaForwarder -e README_EMAIL=donotreply@bb1.fun -e DATA='[{"origin":"https://git.example.com/user/repo","recipients":[{"modifyReadme":true,"url":"https://gitlab.com/user/repo","authors":[{"old":"user@example.com","email":"00000000+user@users.noreply.github.com","name":"user"}]}]}]' -p 80:80 -d bradbot1/gitea-forwarder
```
#### With a volume mount (preffered)
```shell
docker run --name forwarder -e PORT=80 -v ./data.json:./data.json -p 80:80 -d bradbot1/gitea-forwarder
docker run --name forwarder -e PORT=80 -e README_NAME=GiteaForwarder -e README_EMAIL=donotreply@bb1.fun -v ./data.json:./data.json -p 80:80 -d bradbot1/gitea-forwarder
```
You can find an example of [data.json here](https://git.bb1.fun/BradBot_1/GiteaForwarder/src/branch/master/data.json)
@ -69,6 +78,8 @@ services:
environment:
PORT: 80
DATA: '[{"origin":"https://git.example.com/user/repo","recipients":[{"url":"https://gitlab.com/user/repo","authors":[{"old":"user@example.com","email":"00000000+user@users.noreply.github.com","name":"user"}]}]}]'
README_NAME: GiteaForwarder
README_EMAIL: donotreply@bb1.fun
```
#### With a volume mount (preffered)
@ -78,11 +89,14 @@ version: '3'
services:
forwarder:
build: .
image: bradbot1/gitea-forwarder
ports:
- '80:80'
environment:
PORT: 80
README_NAME: GiteaForwarder
README_EMAIL: donotreply@bb1.fun
volumes:
- ./data.json:./data.json
```

View file

@ -12,5 +12,7 @@ services:
#SSL_CERT_PATH:
#SSL_KEY_PATH:
#SSL_PASSWORD:
README_NAME: GiteaForwarder
README_EMAIL: donotreply@bb1.fun
volumes:
- ./data.json:./data.json

View file

@ -84,12 +84,12 @@ export async function changeCommitAuthors(recipient: Recipient, out: string = __
}
export async function insertToReadme(projectName: string, projectLink: string, out: string = __dirname): Promise<void> {
const git = Git(out).addConfig('user.email', 'BradBot_1@outlook.com').addConfig('user.name', 'BradBot1');
const git = Git(out).addConfig('user.email', process.env['README_EMAIL']||"donotreply@bb1.fun").addConfig('user.name', process.env['README_NAME']||"GiteaForwarder");
var data: string = `> This was cloned from [${projectName}](${projectLink})\n`;
if (existsSync(out + "README.md")) data = data + readFileSync(out + "README.md").toString();
writeFileSync(out + "README.md", data);
await git.add("README.md")
await git.commit("Modify README.md", "README.md", {
"--author": '"BradBot1 <BradBot_1@outlook.com>"'
"--author": `"${process.env['README_NAME']||"GiteaForwarder"} <${process.env['README_EMAIL']||"donotreply@bb1.fun"}>"`
});
}