Merge pull request 'Use the kebab-case repository name' (#79) from rename-repo-kebab-case into main
Quality checks / quality-checks (push) Successful in 24s
TirSystem/github-action: Publish wiki / publish-wiki (push) Failing after 7s
TirSystem/github-action: Sync GitHub mirror metadata / sync-metadata (push) Successful in 6s
Quality / quality (push) Successful in 25s

Reviewed-on: #79
This commit was merged in pull request #79.
This commit is contained in:
2026-10-12 11:59:00 +02:00
5 changed files with 11 additions and 11 deletions
+4 -4
View File
@@ -52,8 +52,8 @@ Requirements:
| `jq` (optional) | JSON parsing; without it a small built-in reader is used | | `jq` (optional) | JSON parsing; without it a small built-in reader is used |
```bash ```bash
git clone https://git.tirsystem.com/TirSystem-BashScript/RepoFoundry.git git clone https://git.tirsystem.com/TirSystem-BashScript/repo-foundry.git
cd RepoFoundry cd repo-foundry
src/create-project.sh --help src/create-project.sh --help
``` ```
@@ -69,7 +69,7 @@ command (below):
```bash ```bash
cd ~/work # the folder that will hold my-app cd ~/work # the folder that will hold my-app
~/src/RepoFoundry/src/create-project.sh # creates ~/work/my-app ~/src/repo-foundry/src/create-project.sh # creates ~/work/my-app
``` ```
### Make it a global command ### Make it a global command
@@ -104,7 +104,7 @@ run `export MSYS=winsymlinks:nativestrict` before the `ln -s`, or use an alias
in `~/.bashrc`, which works because the script finds its own folder: in `~/.bashrc`, which works because the script finds its own folder:
```bash ```bash
alias repo-foundry='bash /c/Users/me/RepoFoundry/src/create-project.sh' alias repo-foundry='bash /c/Users/me/repo-foundry/src/create-project.sh'
``` ```
## Configuration ## Configuration
+2 -2
View File
@@ -13,8 +13,8 @@
## Install ## Install
```bash ```bash
git clone https://git.tirsystem.com/TirSystem-BashScript/RepoFoundry.git git clone https://git.tirsystem.com/TirSystem-BashScript/repo-foundry.git
cd RepoFoundry cd repo-foundry
src/create-project.sh --help src/create-project.sh --help
``` ```
+2 -2
View File
@@ -16,5 +16,5 @@ It is a Bash script. It shows a plan first and creates nothing until you pass `-
| [SSH and tokens](SSH-and-tokens) | SSH access to Gitea and the two access tokens | | [SSH and tokens](SSH-and-tokens) | SSH access to Gitea and the two access tokens |
| [Troubleshooting](Troubleshooting) | Common failures and what to do | | [Troubleshooting](Troubleshooting) | Common failures and what to do |
The full reference (configuration files, security decisions, error handling, known limitations) is the [README](https://git.tirsystem.com/TirSystem-BashScript/RepoFoundry/src/branch/main/README.md). The full reference (configuration files, security decisions, error handling, known limitations) is the [README](https://git.tirsystem.com/TirSystem-BashScript/repo-foundry/src/branch/main/README.md).
Report a problem as an [issue](https://git.tirsystem.com/TirSystem-BashScript/RepoFoundry/issues). Report a problem as an [issue](https://git.tirsystem.com/TirSystem-BashScript/repo-foundry/issues).
+2 -2
View File
@@ -13,7 +13,7 @@ The framework submodule is fetched over SSH on port **10022**. Before you run th
A message that you have successfully authenticated, without shell access, means it works. A message that you have successfully authenticated, without shell access, means it works.
> **Passphrase keys.** The script never prompts for a passphrase. A key with a passphrase must already be loaded in `ssh-agent` (`ssh-add`). This is tracked in [issue 77](https://git.tirsystem.com/TirSystem-BashScript/RepoFoundry/issues/77). > **Passphrase keys.** The script never prompts for a passphrase. A key with a passphrase must already be loaded in `ssh-agent` (`ssh-add`). This is tracked in [issue 77](https://git.tirsystem.com/TirSystem-BashScript/repo-foundry/issues/77).
## Tokens ## Tokens
@@ -22,4 +22,4 @@ The framework submodule is fetched over SSH on port **10022**. Before you run th
| Gitea access token | `GITEA_TOKEN` | always | access token with scopes | | Gitea access token | `GITEA_TOKEN` | always | access token with scopes |
| GitHub personal access token | `GITHUB_PAT` | only when you choose GitHub | **classic** personal access token | | GitHub personal access token | `GITHUB_PAT` | only when you choose GitHub | **classic** personal access token |
Step by step with pictures: [how to create the access tokens](https://git.tirsystem.com/TirSystem-BashScript/RepoFoundry/src/branch/main/howto/create-access-tokens.md). The exact permissions are under [Token permissions](https://git.tirsystem.com/TirSystem-BashScript/RepoFoundry/src/branch/main/README.md#token-permissions) in the README. Step by step with pictures: [how to create the access tokens](https://git.tirsystem.com/TirSystem-BashScript/repo-foundry/src/branch/main/howto/create-access-tokens.md). The exact permissions are under [Token permissions](https://git.tirsystem.com/TirSystem-BashScript/repo-foundry/src/branch/main/README.md#token-permissions) in the README.
+1 -1
View File
@@ -7,4 +7,4 @@
| A host rejects the token | The token is current and has the scopes in [SSH and tokens](SSH-and-tokens) | | A host rejects the token | The token is current and has the scopes in [SSH and tokens](SSH-and-tokens) |
| A run stopped half way | Fix the cause and run the same command again with `--apply`: what was already created is offered for reuse | | A run stopped half way | Fix the cause and run the same command again with `--apply`: what was already created is offered for reuse |
More: [Error handling and recovery](https://git.tirsystem.com/TirSystem-BashScript/RepoFoundry/src/branch/main/README.md#error-handling-and-recovery) and [Known limitations](https://git.tirsystem.com/TirSystem-BashScript/RepoFoundry/src/branch/main/README.md#known-limitations) in the README. More: [Error handling and recovery](https://git.tirsystem.com/TirSystem-BashScript/repo-foundry/src/branch/main/README.md#error-handling-and-recovery) and [Known limitations](https://git.tirsystem.com/TirSystem-BashScript/repo-foundry/src/branch/main/README.md#known-limitations) in the README.