docs: Added README 📝

This commit is contained in:
2024-07-25 11:26:51 +12:00
parent 5b60906c2f
commit 8c4e685840

69
README.md Normal file
View File

@@ -0,0 +1,69 @@
# Ubuntu ACT Runner
This container is based on catthehacker/ubuntu:act-22.04 its purpose is to be used with Gitea Actions.
Included in this image is go-semantic-release and plugins for git,github,gitea and gitlab releases.
## Getting Started
These instructions will cover usage information and for the docker container
### Prerequisities
In order to run this container you'll need docker installed.
* [Windows](https://docs.docker.com/windows/started)
* [OS X](https://docs.docker.com/mac/started/)
* [Linux](https://docs.docker.com/linux/started/)
### Usage
#### Container Parameters
List the different parameters available to your container
```shell
docker run cybercinch/ubuntu:act_gitea-latest
```
You can get a shell into a container instance by running
```shell
docker run -rm -it cybercinch/ubuntu:act_gitea-latest bash
```
## Built With
* go-semantic-release v2.30.0
## Find Us
* [Gitea](https://hub.cybercinch.nz/cybercinch/ubuntu-act_gitea/)
* [DockerHub](https://hub.docker.com/r/cybercinch/ubuntu/)
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the
[tags on this repository](https://hub.cybercinch.nz/cybercinch/ubuntu-act_gitea/tags).
## Authors
* **Aaron Guise** - *Initial work* - [guisea](https://hub.cybercinch.nz/guisea)
See also the list of [contributors](https://hub.cybercinch.nz/cybercinch/ubuntu-act_gitea/activity/contributors) who
participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
## Acknowledgments
* People you want to thank
* If you took a bunch of code from somewhere list it here