 Refactor docs (#23752)
This was intended to be a small followup for
https://github.com/go-gitea/gitea/pull/23712, but...here we are.
1. Our docs currently use `slug` as the entire URL, which makes
refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712).
Instead, this PR attempts to make future refactoring easier by using
slugs as an extension of the section. (Hugo terminology)
- What the above boils down to is this PR attempts to use directory
organization as URL management. e.g. `usage/comparison.en-us.md` ->
`en-us/usage/comparison/`, `usage/packages/overview.en-us.md` ->
`en-us/usage/packages/overview/`
- Technically we could even remove `slug`, as Hugo defaults to using
filename, however at least with this PR it means `slug` only needs to be
the name for the **current file** rather than an entire URL
2. This PR adds appropriate aliases (redirects) for pages, so anything
on the internet that links to our docs should hopefully not break.
3. A minor nit I've had for a while, renaming `seek-help` to `support`.
It's a minor thing, but `seek-help` has a strange connotation to it.
4. The commits are split such that you can review the first which is the
"actual" change, and the second is added redirects so that the first
doesn't break links elsewhere.
---------
Signed-off-by: jolheiser <john.olheiser@gmail.com> 1 year ago  Implement actions (#21937)
Close #13539.
Co-authored by: @lunny @appleboy @fuxiaohei and others.
Related projects:
- https://gitea.com/gitea/actions-proto-def
- https://gitea.com/gitea/actions-proto-go
- https://gitea.com/gitea/act
- https://gitea.com/gitea/act_runner
### Summary
The target of this PR is to bring a basic implementation of "Actions",
an internal CI/CD system of Gitea. That means even though it has been
merged, the state of the feature is **EXPERIMENTAL**, and please note
that:
- It is disabled by default;
- It shouldn't be used in a production environment currently;
- It shouldn't be used in a public Gitea instance currently;
- Breaking changes may be made before it's stable.
**Please comment on #13539 if you have any different product design
ideas**, all decisions reached there will be adopted here. But in this
PR, we don't talk about **naming, feature-creep or alternatives**.
### โ ๏ธ Breaking
`gitea-actions` will become a reserved user name. If a user with the
name already exists in the database, it is recommended to rename it.
### Some important reviews
- What is `DEFAULT_ACTIONS_URL` in `app.ini` for?
- https://github.com/go-gitea/gitea/pull/21937#discussion_r1055954954
- Why the api for runners is not under the normal `/api/v1` prefix?
- https://github.com/go-gitea/gitea/pull/21937#discussion_r1061173592
- Why DBFS?
- https://github.com/go-gitea/gitea/pull/21937#discussion_r1061301178
- Why ignore events triggered by `gitea-actions` bot?
- https://github.com/go-gitea/gitea/pull/21937#discussion_r1063254103
- Why there's no permission control for actions?
- https://github.com/go-gitea/gitea/pull/21937#discussion_r1090229868
### What it looks like
<details>
#### Manage runners
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205870657-c72f590e-2e08-4cd4-be7f-2e0abb299bbf.png">
#### List runs
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205872794-50fde990-2b45-48c1-a178-908e4ec5b627.png">
#### View logs
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205872501-9b7b9000-9542-4991-8f55-18ccdada77c3.png">
</details>
### How to try it
<details>
#### 1. Start Gitea
Clone this branch and [install from
source](https://docs.gitea.io/en-us/install-from-source).
Add additional configurations in `app.ini` to enable Actions:
```ini
[actions]
ENABLED = true
```
Start it.
If all is well, you'll see the management page of runners:
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205877365-8e30a780-9b10-4154-b3e8-ee6c3cb35a59.png">
#### 2. Start runner
Clone the [act_runner](https://gitea.com/gitea/act_runner), and follow
the
[README](https://gitea.com/gitea/act_runner/src/branch/main/README.md)
to start it.
If all is well, you'll see a new runner has been added:
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205878000-216f5937-e696-470d-b66c-8473987d91c3.png">
#### 3. Enable actions for a repo
Create a new repo or open an existing one, check the `Actions` checkbox
in settings and submit.
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205879705-53e09208-73c0-4b3e-a123-2dcf9aba4b9c.png">
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205879383-23f3d08f-1a85-41dd-a8b3-54e2ee6453e8.png">
If all is well, you'll see a new tab "Actions":
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205881648-a8072d8c-5803-4d76-b8a8-9b2fb49516c1.png">
#### 4. Upload workflow files
Upload some workflow files to `.gitea/workflows/xxx.yaml`, you can
follow the [quickstart](https://docs.github.com/en/actions/quickstart)
of GitHub Actions. Yes, Gitea Actions is compatible with GitHub Actions
in most cases, you can use the same demo:
```yaml
name: GitHub Actions Demo
run-name: ${{ github.actor }} is testing out GitHub Actions ๐
on: [push]
jobs:
Explore-GitHub-Actions:
runs-on: ubuntu-latest
steps:
- run: echo "๐ The job was automatically triggered by a ${{ github.event_name }} event."
- run: echo "๐ง This job is now running on a ${{ runner.os }} server hosted by GitHub!"
- run: echo "๐ The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
- name: Check out repository code
uses: actions/checkout@v3
- run: echo "๐ก The ${{ github.repository }} repository has been cloned to the runner."
- run: echo "๐ฅ๏ธ The workflow is now ready to test your code on the runner."
- name: List files in the repository
run: |
ls ${{ github.workspace }}
- run: echo "๐ This job's status is ${{ job.status }}."
```
If all is well, you'll see a new run in `Actions` tab:
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205884473-79a874bc-171b-4aaf-acd5-0241a45c3b53.png">
#### 5. Check the logs of jobs
Click a run and you'll see the logs:
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205884800-994b0374-67f7-48ff-be9a-4c53f3141547.png">
#### 6. Go on
You can try more examples in [the
documents](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions)
of GitHub Actions, then you might find a lot of bugs.
Come on, PRs are welcome.
</details>
See also: [Feature Preview: Gitea
Actions](https://blog.gitea.io/2022/12/feature-preview-gitea-actions/)
---------
Co-authored-by: a1012112796 <1012112796@qq.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: delvh <dev.lh@web.de>
Co-authored-by: ChristopherHX <christopher.homberger@web.de>
Co-authored-by: John Olheiser <john.olheiser@gmail.com> 1 year ago |
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137 |
- ---
- date: "2018-05-07T13:00:00+02:00"
- title: "ๆฏ่ผ Gitea ๅๅ
ถๅฎ่ช่จ็ฎก Git ๆๅ"
- slug: "comparison"
- sidebar_position: 5
- toc: false
- draft: false
- aliases:
- - /zh-tw/comparison
- menu:
- sidebar:
- parent: "installation"
- name: "ๆฏ่ผ"
- sidebar_position: 5
- identifier: "comparison"
- ---
-
- # ๆฏ่ผ Gitea ๅๅ
ถๅฎ่ช่จ็ฎก Git ๆๅ
-
- **็ฎ้**
-
- ็บไบๅนซๅฉๆจๅคๆท Gitea ๆฏๅฆ้ฉๅๆจ็้ๆฑ๏ผ้่ฃกๅๅบไบๅฎๅๅ
ถๅฎ่ช่จ็ฎก Git ๆๅ็ๆฏ่ผใ
-
- ่ซๆณจๆๆๅไธๆ็ถๅธธๆชขๆฅๅ
ถๅฎ็ขๅ็ๅ่ฝ็ฐๅ๏ผๆไปฅ้ไปฝๆธ
ๅฎๅฏ่ฝ้ๆ๏ผๅฆๆๆจๅจไธๆน่กจๆ ผไธญๆพๅฐ้่ฆๆดๆฐ็่ณๆ๏ผ่ซๅจ [GitHub ็ Issue](https://github.com/go-gitea/gitea/issues) ๅๅ ฑใ
-
- ่กจๆ ผไธญไฝฟ็จ็็ฌฆ่๏ผ
-
- - โ - ๆฏๆด
-
- - โ - ๆ้ๅบฆ็ๆฏๆด
-
- - โ - ไธๆฏๆด
-
- - _โ๏ธ - ็ฑ็ฌฌไธๆนๆๅๆๅคๆ็จๅผๆฏๆด_
-
- ## ไธ่ฌๅ่ฝ
-
- | ๅ่ฝ | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE |
- | ------------------------ | -------------------------------------------------- | ---- | --------- | --------- | --------- | --------- | ------------ |
- | ๅ
่ฒปๅ้ๆพๅๅง็ขผ | โ | โ | โ | โ | โ | โ | โ |
- | ไฝ่ณๆบไฝฟ็จ (RAM/CPU) | โ | โ | โ | โ | โ | โ | โ |
- | ๆฏๆดๅค็จฎ่ณๆๅบซ | โ | โ | โ | โ | โ | โ | โ |
- | ๆฏๆดๅค็จฎไฝๆฅญ็ณป็ตฑ | โ | โ | โ | โ | โ | โ | โ |
- | ็ฐกๅฎ็ๅ็ด็จๅบ | โ | โ | โ | โ | โ | โ | โ |
- | ๆฏๆด Markdown | โ | โ | โ | โ | โ | โ | โ |
- | ๆฏๆด Orgmode | โ | โ | โ | โ | โ | โ | ? |
- | ๆฏๆด CSV | โ | โ | โ | โ | โ | โ | ? |
- | ๆฏๆด็ฌฌไธๆนๆธฒๆๅทฅๅ
ท | โ | โ | โ | โ | โ | โ | ? |
- | Git ้ฉ
ๅ็้ๆ
้ ้ข | [โ๏ธ][gitea-pages-server], [โ๏ธ][gitea-caddy-plugin] | โ | โ | โ | โ | โ | โ |
- | Git ้ฉ
ๅ็ๆดๅ wiki | โ | โ | โ | โ | โ | โ | โ |
- | ้จ็ฝฒ Token | โ | โ | โ | โ | โ | โ | โ |
- | ๆๅฏซๅ
ฅๆฌ้็ๅฒๅญๅบซ Token | โ | โ | โ | โ | โ | โ | โ |
- | ๅ
งๅปบ Container Registry | [โ](https://github.com/go-gitea/gitea/issues/2316) | โ | โ | โ | โ | โ | โ |
- | ๅฐๅค้จ Git ้กๅ | โ | โ | โ | โ | โ | โ | โ |
- | FIDO (2FA) | โ | โ | โ | โ | โ | โ | โ |
- | ๅ
งๅปบ CI/CD | โ | โ | โ | โ | โ | โ | โ |
- | ๅญ็พค็ต: ็พค็ตไธญ็็พค็ต | โ | โ | โ | โ | โ | โ | โ |
-
- ## ็จๅผ็ขผ็ฎก็
-
- | ๅ่ฝ | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE |
- | ----------------------------------------- | ------------------------------------------------ | ---- | --------- | --------- | --------- | --------- | ------------ |
- | ๅฒๅญๅบซไธป้กๆ่ฟฐ | โ | โ | โ | โ | โ | โ | โ |
- | ๅฒๅญๅบซ็จๅผ็ขผๆๅฐ | โ | โ | โ | โ | โ | โ | โ |
- | ๅ
จๅ็จๅผ็ขผๆๅฐ | โ | โ | โ | โ | โ | โ | โ |
- | Git LFS 2.0 | โ | โ | โ | โ | โ | โ | โ |
- | ็พค็ต้็จ็ข | โ | โ | โ | โ | โ | โ | โ |
- | ็ฒพ็ดฐ็ไฝฟ็จ่
ๆฌ้๏ผ็จๅผ็ขผ, ๅ้ก, Wiki ็ญ๏ผ | โ | โ | โ | โ | โ | โ | โ |
- | ้ฉ่ญๆไบค่
| โ | โ | ? | โ | โ | โ | โ |
- | GPG ็ฐฝ็ฝฒๆไบค | โ | โ | โ | โ | โ | โ | โ |
- | ๆ็ตๆช็ถ็ฐฝ็ฝฒ็ๆไบค | [โ](https://github.com/go-gitea/gitea/pull/9708) | โ | โ | โ | โ | โ | โ |
- | ๅฒๅญๅบซๅๆ
้ | โ | โ | โ | โ | โ | โ | โ |
- | ๅๆฏ็ฎก็ | โ | โ | โ | โ | โ | โ | โ |
- | ๅปบ็ซๆฐๅๆฏ | โ | โ | โ | โ | โ | โ | โ |
- | ็ถฒ้ ็จๅผ็ขผ็ทจ่ผฏๅจ | โ | โ | โ | โ | โ | โ | โ |
- | ๆไบค็ทๅ | โ | โ | โ | โ | โ | โ | โ |
- | ๅฒๅญๅบซ็ฏๆฌ | [โ](https://github.com/go-gitea/gitea/pull/8768) | โ | โ | โ | โ | โ | โ |
-
- ## ๅ้ก่ฟฝ่นคๅจ
-
- | ๅ่ฝ | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE |
- | -------------------- | -------------------------------------------------- | --------------------------------------------- | --------- | ----------------------------------------------------------------------- | --------- | --------- | ------------ |
- | ๅ้ก่ฟฝ่นคๅจ | โ | โ | โ | โ | โ | โ | โ |
- | ๅ้ก็ฏๆฌ | โ | โ | โ | โ | โ | โ | โ |
- | ๆจ็ฑค | โ | โ | โ | โ | โ | โ | โ |
- | ๆ้่ฟฝ่นค | โ | โ | โ | โ | โ | โ | โ |
- | ๆๆดพๅ้ก็ตฆๅคๅๆๅก | โ | โ | โ | โ | โ | โ | โ |
- | ็ธ้ๅ้ก | โ | โ | โ | [โ](https://docs.gitlab.com/ce/user/project/issues/related_issues.html) | โ | โ | โ |
- | ๆฉๅฏๅ้ก | [โ](https://github.com/go-gitea/gitea/issues/3217) | โ | โ | โ | โ | โ | โ |
- | ๅฐ็่จ็ๅๆ | โ | โ | โ | โ | โ | โ | โ |
- | ้ๅฎๅฐ่ฉฑ | โ | โ | โ | โ | โ | โ | โ |
- | ๆนๆฌก่็ๅ้ก | โ | โ | โ | โ | โ | โ | โ |
- | ๅ้ก็ๆฟ๏ผ็ๆฟๆนๆณ๏ผ | [โ](https://github.com/go-gitea/gitea/pull/8346) | โ | โ | โ | โ | โ | โ |
- | ๅพๅ้กๅปบ็ซๆฐๅๆฏ | โ | โ | โ | โ | โ | โ | โ |
- | ๅ้กๆๅฐ | โ | โ | โ | โ | โ | โ | โ |
- | ๅ
จๅๅ้กๆๅฐ | [โ](https://github.com/go-gitea/gitea/issues/2434) | โ | โ | โ | โ | โ | โ |
- | ๅ้ก็ธไพ | โ | โ | โ | โ | โ | โ | โ |
- | ๅพ้ปๅญ้ตไปถๅปบ็ซๅ้ก | [โ](https://github.com/go-gitea/gitea/issues/6226) | [โ](https://github.com/gogs/gogs/issues/2602) | โ | โ | โ | โ | โ |
- | ๆๅๅฐ | [โ](https://github.com/go-gitea/gitea/issues/6219) | โ | โ | [โ](https://gitlab.com/groups/gitlab-org/-/epics/3103) | โ | โ | โ |
-
- ## ๆๅ/ๅไฝต่ซๆฑ
-
- | ๅ่ฝ | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE |
- | -------------------------- | -------------------------------------------------- | ---- | --------- | --------------------------------------------------------------------------------- | --------- | ------------------------------------------------------------------------ | ------------ |
- | ๆๅ/ๅไฝต่ซๆฑ | โ | โ | โ | โ | โ | โ | โ |
- | Squash ๅไฝต | โ | โ | โ | [โ](https://docs.gitlab.com/ce/user/project/merge_requests/squash_and_merge.html) | โ | โ | โ |
- | Rebase ๅไฝต | โ | โ | โ | โ | โ | โ | โ |
- | ๆๅ/ๅไฝต่ซๆฑ็่กๅ
ง็่จ | โ | โ | โ | โ | โ | โ | โ |
- | ๆๅ/ๅไฝต่ซๆฑ็ๆ ธๅฏ | โ | โ | โ | โ | โ | โ | โ |
- | ่งฃๆฑบๅไฝต่ก็ช | [โ](https://github.com/go-gitea/gitea/issues/5158) | โ | โ | โ | โ | โ | โ |
- | ้ๅถๆไบไฝฟ็จ่
็ๆจ้ๅๅไฝต | โ | โ | โ | โ | โ | โ | โ |
- | ้ๅๆๅฎ็ๆไบคๆๅไฝต่ซๆฑ | [โ](https://github.com/go-gitea/gitea/issues/5158) | โ | โ | โ | โ | โ | โ |
- | ๆๅ/ๅไฝต่ซๆฑ็ฏๆฌ | โ | โ | โ | โ | โ | โ | โ |
- | Cherry-picking ่ฎๆด | [โ](https://github.com/go-gitea/gitea/issues/5158) | โ | โ | โ | โ | โ | โ |
- | ไธ่ผ Patch | โ | โ | โ | โ | โ | [/](https://jira.atlassian.com/plugins/servlet/mobile#issue/BCLOUD-8323) | โ |
-
- ## ็ฌฌไธๆนๆดๅ
-
- | ๅ่ฝ | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE |
- | ------------------------- | ------------------------------------------------ | ---- | --------- | --------- | --------- | --------- | ------------ |
- | ๆฏๆด Webhook | โ | โ | โ | โ | โ | โ | โ |
- | ่ช่จ Git Hook | โ | โ | โ | โ | โ | โ | โ |
- | ๆดๅ AD / LDAP | โ | โ | โ | โ | โ | โ | โ |
- | ๆฏๆดๅค้ LDAP / AD ไผบๆๅจ | โ | โ | โ | โ | โ | โ | โ |
- | ๅๆญฅ LDAP ไฝฟ็จ่
| โ | โ | โ | โ | โ | โ | โ |
- | SAML 2.0 service provider | [โ](https://github.com/go-gitea/gitea/issues/5512) | [โ](https://github.com/gogs/gogs/issues/1221) | โ | โ | โ | โ | โ |
- | ๆฏๆด OpenId Connect | โ | โ | โ | โ | โ | ? | โ |
- | ๆดๅ OAuth 2.0 (ๅค้จ้ฉ่ญ) | โ | โ | โ | โ | โ | ? | โ |
- | ๆ็บ OAuth 2.0 ๆไพ่
| [โ](https://github.com/go-gitea/gitea/pull/5378) | โ | โ | โ | โ | โ | โ |
- | ๅ
ฉๆญฅ้ฉ้ฉ่ญ (2FA) | โ | โ | โ | โ | โ | โ | โ |
- | ๆดๅ Mattermost/Slack | โ | โ | โ | โ | โ | โ | โ |
- | ๆดๅ Discord | โ | โ | โ | โ | โ | โ | โ |
- | ๆดๅ Microsoft Teams | โ | โ | โ | โ | โ | โ | โ |
- | ้กฏ็คบๅค้จ CI/CD ็ๆ
| โ | โ | โ | โ | โ | โ | โ |
-
- [gitea-caddy-plugin]: https://github.com/42wim/caddy-gitea
- [gitea-pages-server]: https://codeberg.org/Codeberg/pages-server
|
