mirror of
https://codeberg.org/forgejo/docs.git
synced 2024-11-25 18:19:26 -05:00
docs: actions user documentation
# Conflicts: # user/actions.md
This commit is contained in:
parent
207689f5e8
commit
ac06f28fdd
6 changed files with 42 additions and 0 deletions
BIN
_images/user/actions/actions-demo.png
Normal file
BIN
_images/user/actions/actions-demo.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 81 KiB |
BIN
_images/user/actions/demo-yaml.png
Normal file
BIN
_images/user/actions/demo-yaml.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 51 KiB |
BIN
_images/user/actions/enable-repository.png
Normal file
BIN
_images/user/actions/enable-repository.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 30 KiB |
BIN
_images/user/actions/workflow-demo.png
Normal file
BIN
_images/user/actions/workflow-demo.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 58 KiB |
41
user/actions.md
Normal file
41
user/actions.md
Normal file
|
@ -0,0 +1,41 @@
|
||||||
|
---
|
||||||
|
layout: '~/layouts/Markdown.astro'
|
||||||
|
title: 'Forgejo Actions'
|
||||||
|
license: 'CC-BY-SA-4.0'
|
||||||
|
---
|
||||||
|
|
||||||
|
`Forgejo Actions` provides continuous integration driven from the files in the `.forgejo/workflows` directory of a repository.
|
||||||
|
|
||||||
|
# Quick start
|
||||||
|
|
||||||
|
- Verify that `Enable Repository Actions` is checked in the `Repository` tab of the `/{owner}/{repository}/settings` page.
|
||||||
|
|
||||||
|
![enable actions](../../../../images/v1.20/user/actions/enable-repository.png)
|
||||||
|
|
||||||
|
- Add the following to the `.forgejo/workflows/demo.yaml` file in the repository.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
on: [push]
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- run: echo All Good
|
||||||
|
```
|
||||||
|
|
||||||
|
![demo.yaml file](../../../../images/v1.20/user/actions/demo-yaml.png)
|
||||||
|
|
||||||
|
- Go to the `Actions` tab of the `/{owner}/{repository}/actions` page of the repository to see the result of the run.
|
||||||
|
|
||||||
|
![actions results](../../../../images/v1.20/user/actions/actions-demo.png)
|
||||||
|
|
||||||
|
- Click on the workflow link to see the details and the job execution logs.
|
||||||
|
|
||||||
|
![actions results](../../../../images/v1.20/user/actions/workflow-demo.png)
|
||||||
|
|
||||||
|
# Glossary
|
||||||
|
|
||||||
|
- **workflow:** a file in the `.forgejo/workflows` directory that contains **jobs**.
|
||||||
|
- **job:** a sequential set of **steps**.
|
||||||
|
- **step:** a command the **runner** is required to carry out.
|
||||||
|
- **runner:** the [Forgejo runner](https://code.forgejo.org/forgejo/runner) daemon tasked to execute the **workflows**.
|
|
@ -27,6 +27,7 @@ involved in running it on their machines.
|
||||||
- [Branch and tag protection](protection)
|
- [Branch and tag protection](protection)
|
||||||
- Advanced Usage
|
- Advanced Usage
|
||||||
- [Issue and Pull Request Templates](issue-pull-request-templates)
|
- [Issue and Pull Request Templates](issue-pull-request-templates)
|
||||||
|
- [Actions](actions)
|
||||||
- [Merge Message templates](merge-message-templates)
|
- [Merge Message templates](merge-message-templates)
|
||||||
- [Generating an Access Token](https://docs.codeberg.org/advanced/access-token/)
|
- [Generating an Access Token](https://docs.codeberg.org/advanced/access-token/)
|
||||||
- [Webhooks](webhooks)
|
- [Webhooks](webhooks)
|
||||||
|
|
Loading…
Reference in a new issue