Add readme

This commit is contained in:
benjamin melançon 2023-10-05 18:19:46 -04:00
parent ab23c86e82
commit 33b35a3566

27
README.md Normal file
View file

@ -0,0 +1,27 @@
# Forgejo Helpers
Setup:
```bash
git clone https://git.agaric.com/agaric/forgejo_helpers.git
cd forgejo_helpers
cp .env.example .env
```
Set your instance URL there and your API token (with permission to read and write issues at least).
## Move issues
Currently this is the only script:
[`move_issue.py`](https://git.agaric.com/agaric/forgejo_helpers/src/branch/main/move_issue.py)
Use it by passing in the source owner, the source repository, the issue number, the destination owner, and the destination repository, like so:
```bash
python move_issue old-example-org old-example-repo 123 new-example-org new-example-repo
```
All five parameters are needed, even if it is within the same organization.
It would not be difficult to change it so these could be environment variables so that only the issue need to be passed in, and in would not be hard to allow passing in a list of issues, but this has not been done yet.