docs: update doc

This commit is contained in:
sebthom 2025-07-19 22:00:00 +02:00
parent d4d138e443
commit 2d141fd2bc
5 changed files with 41 additions and 21 deletions

View File

@ -3,7 +3,7 @@
# SPDX-License-Identifier: Apache-2.0
# SPDX-ArtifactOfProjectHomePage: https://github.com/vegardit/docker-gitea-act-runner
#
# https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions
# https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
name: Build
on:
@ -26,10 +26,10 @@ on:
- '.github/*.yml'
- '.github/workflows/stale.yml'
schedule:
# https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows
# https://docs.github.com/en/actions/reference/choosing-when-your-workflow-runs/events-that-trigger-workflows
- cron: '0 17 * * 3'
workflow_dispatch:
# https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#workflow_dispatch
# https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch
inputs:
VERSION:
type: string

View File

@ -3,10 +3,10 @@ name: Stale issues
on:
schedule:
# https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows
# https://docs.github.com/en/actions/reference/events-that-trigger-workflows
- cron: '0 15 1,15 * *'
workflow_dispatch:
# https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#workflow_dispatch
# https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch
permissions:
issues: write

View File

@ -60,7 +60,7 @@ representative at an online or offline event.
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
https://vegardit.com/en/legal/.
https://vegardit.com/en/legal/
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the

View File

@ -1,25 +1,45 @@
# Contributing
# Contributing to the Project
Thanks for your interest in contributing to this project!
Thank you for your interest in contributing to this project! We strive to make the contribution process clear and welcoming.
We want to make contributing as easy and transparent as possible.
Please take a moment to review the guidelines below.
## Code of Conduct
Our code of conduct is described in [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
Please review and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) in all your interactions with the project.
This helps us maintain a positive and respectful environment for everyone involved.
## Issues
## How to Contribute
We use GitHub issues to track bugs and feature requests. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
### Contributor Responsibilities
By submitting your contributions, you agree to the following:
- You are the sole author of the content you contribute, or you have the appropriate rights and permissions to contribute it.
- If employed, you have obtained any necessary permissions from your employer to contribute to this project.
- All contributions will be made available under the projects license.
### Issues
We use GitHub Issues to track bugs and feature requests. When submitting an issue, please ensure:
- The description is clear and concise.
- You provide enough details and steps to reproduce the issue, if applicable.
### Pull Requests
Before making substantial contributions:
1. **Discuss Changes**: Please file an issue first to discuss your proposed changes with the team. This helps ensure your contribution aligns with the projects goals.
2. **Follow Best Practices**: Adhere to the guidelines and ensure your code meets the projects standards (see [Code Guidelines](#code-guidelines)).
When submitting a pull request:
- Ensure your changes are well-documented.
- Include tests for any new features or significant changes.
- Reference the relevant issue(s) in your pull request description.
## Pull Requests
## Licensing
Before you make a substantial pull request, please file an issue and make sure someone from the team agrees that there is a problem or room for improvement.
By contributing to this project, you agree that your contributions will be licensed under the [Apache License 2.0](LICENSE.txt).
## License
By contributing your code, you agree to license your contribution under the [Apache License 2.0](LICENSE.txt).
The project itself is also licensed under the [Apache License 2.0](LICENSE.txt)).

View File

@ -1,4 +1,4 @@
# based on https://gitea.com/gitea/act_runner/src/tag/v0.2.11/internal/pkg/config/config.example.yaml
# based on https://gitea.com/gitea/act_runner/src/tag/v0.2.12/internal/pkg/config/config.example.yaml
log:
# The level of logging, can be trace, debug, info, warn, error, fatal
@ -37,8 +37,8 @@ runner:
# The interval for fetching the job from the Gitea instance.
fetch_interval: '${GITEA_RUNNER_FETCH_INTERVAL:-2s}'
# The labels of a runner are used to determine which jobs the runner can run, and how to run them.
# Like: "macos-arm64:host" or "ubuntu-latest:docker://gitea/runner-images:ubuntu-latest"
# Find more images provided by Gitea at https://gitea.com/gitea/runner-images .
# Like: "macos-arm64:host" or "ubuntu-latest:docker://docker.gitea.com/runner-images:ubuntu-latest"
# Find more images provided by Gitea at https://gitea.com/docker.gitea.com/runner-images .
# If it's empty when registering, it will ask for inputting labels.
# If it's empty when execute `daemon`, will use labels in `.runner` file.
labels: [ "${GITEA_RUNNER_LABELS//,/","}" ]