aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 064e7e4e2a1cb4d03598b442a4acd69a4e0db684 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# `upload-artifact`

As its name suggests, this project defines a simple shell script that
allows to upload one or more artifacts to a
[`slcl`](https://gitea.privatedns.org/xavi/slcl) instance.

In the context of Forgejo and Gitea, this shell script and `slcl` can
be used as minimalistic alternatives to
[`actions/checkout@v4`](https://code.forgejo.org/actions/checkout),
since this action requires a Node.JS Docker image to run, as well as
some non-trivial complexity on the action itself.

## How to use

Set up the following environment variables:

- `URL`: URL to the `slcl` instance.
- `USERNAME`: username to log into.
- `PASSWORD`: password for the given username.

Then, call `upload-artifact` with the list of artifacts to upload:

```
upload-artifact <artifact> ...
```

## License

```
upload-artifact, upload tool for slcl instances
Copyright (C) 2025  Xavier Del Campo Romero

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.
```

Also, see [`LICENSE`](LICENSE).