TirSystem/git-workflows
0
2
Fork 0
Code Issues 26 Pull Requests Actions Packages Projects Releases 11 Wiki Activity

Prepare release 2.2.0: changelog section and guides at @v2 #216

Merged
Tirsvad merged 1 commits from release-2.2.0 into main 2026-10-21 13:40:34 +02:00
Conversation 0 Commits 1 Files Changed 7
+13 -29
7 changed files with 13 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 01178370cb - Show all commits
CHANGELOG.md
+2
View File
@@ -20,6 +20,8 @@ Each release lists its changes in these groups, in this order:
## [Unreleased] ## [Unreleased]
## [2.2.0] - 2026-10-21
### Added ### Added
- `english-comments.yml`, a reusable workflow that judges the language of the comments and docstrings a pull request adds, fails the run when one is not English and writes one comment on the pull request that mentions the author (ADR-0012), with the scripts `tools/english_comments.py` and `tools/english_comments_report.py`, the guide `guides/english-comments.md` and wiki pages in three languages. The scanner of `tools/count_loc.py` can return the text of the comments it finds. - `english-comments.yml`, a reusable workflow that judges the language of the comments and docstrings a pull request adds, fails the run when one is not English and writes one comment on the pull request that mentions the author (ADR-0012), with the scripts `tools/english_comments.py` and `tools/english_comments_report.py`, the guide `guides/english-comments.md` and wiki pages in three languages. The scanner of `tools/count_loc.py` can return the text of the comments it finds.
docs/wiki/EnglishComments.da.md
+1 -4
View File
@@ -1,4 +1,4 @@
<!-- translation of EnglishComments.md, source sha256 98f3d6e44d62 --> <!-- translation of EnglishComments.md, source sha256 9dafcabbc807 -->
> Dette er en oversættelse af [`EnglishComments`](EnglishComments). Den engelske side er autoritativ, og ændringer her bliver overskrevet, næste gang wikien publiceres. > Dette er en oversættelse af [`EnglishComments`](EnglishComments). Den engelske side er autoritativ, og ændringer her bliver overskrevet, næste gang wikien publiceres.
@@ -28,9 +28,6 @@ jobs:
allowed-words-file: .english-comments-allowed-words allowed-words-file: .english-comments-allowed-words
``` ```
Indtil udgivelse 2.3.0 findes workflowet kun på `main`, så kald det med `@main`; `@v2` indeholder det
endnu ikke.
| Input | Standard | Betydning | | Input | Standard | Betydning |
| --- | --- | --- | | --- | --- | --- |
| `scope` | `changed` | `changed` kontrollerer kommentarerne på de linjer, pull requesten tilføjer; `all` kontrollerer hver sporet fil | | `scope` | `changed` | `changed` kontrollerer kommentarerne på de linjer, pull requesten tilføjer; `all` kontrollerer hver sporet fil |
docs/wiki/EnglishComments.md
-3
View File
@@ -28,9 +28,6 @@ jobs:
allowed-words-file: .english-comments-allowed-words allowed-words-file: .english-comments-allowed-words
``` ```
Until release 2.3.0 the workflow exists only on `main`, so call it at `@main`; `@v2` does not
contain it yet.
| Input | Default | Meaning | | Input | Default | Meaning |
| --- | --- | --- | | --- | --- | --- |
| `scope` | `changed` | `changed` checks the comments on the lines the pull request adds; `all` checks every tracked file | | `scope` | `changed` | `changed` checks the comments on the lines the pull request adds; `all` checks every tracked file |
docs/wiki/EnglishComments.ms.md
+1 -4
View File
@@ -1,4 +1,4 @@
<!-- translation of EnglishComments.md, source sha256 98f3d6e44d62 --> <!-- translation of EnglishComments.md, source sha256 9dafcabbc807 -->
> Ini ialah terjemahan [`EnglishComments`](EnglishComments). Halaman bahasa Inggeris ialah teks yang sah, dan perubahan di sini akan ditimpa pada penerbitan wiki yang seterusnya. > Ini ialah terjemahan [`EnglishComments`](EnglishComments). Halaman bahasa Inggeris ialah teks yang sah, dan perubahan di sini akan ditimpa pada penerbitan wiki yang seterusnya.
@@ -29,9 +29,6 @@ jobs:
allowed-words-file: .english-comments-allowed-words allowed-words-file: .english-comments-allowed-words
``` ```
Sehingga keluaran 2.3.0, aliran kerja hanya wujud pada `main`, jadi panggil dengan `@main`; `@v2` belum
mengandunginya.
| Input | Lalai | Maksud | | Input | Lalai | Maksud |
| --- | --- | --- | | --- | --- | --- |
| `scope` | `changed` | `changed` menyemak komen pada baris yang ditambah oleh pull request; `all` menyemak setiap fail yang dijejaki | | `scope` | `changed` | `changed` menyemak komen pada baris yang ditambah oleh pull request; `all` menyemak setiap fail yang dijejaki |
guides/english-comments.md
-3
View File
@@ -22,9 +22,6 @@ jobs:
allowed-words-file: .english-comments-allowed-words allowed-words-file: .english-comments-allowed-words
``` ```
Until release 2.3.0 the workflow exists only on `main`, so call it at `@main`; `@v2` does not
contain it yet.
| Input | Default | Meaning | | Input | Default | Meaning |
| --- | --- | --- | | --- | --- | --- |
| `scope` | `changed` | `changed` checks the comments on the lines the pull request adds; `all` checks every tracked file | | `scope` | `changed` | `changed` checks the comments on the lines the pull request adds; `all` checks every tracked file |
guides/vpn-tailscale.md
+4 -7
View File
@@ -5,7 +5,7 @@ a Gitea Actions runner, so the next steps of the same job (a deployment over
SSH, a migration) can reach hosts on the tailnet. It does what the GitHub SSH, a migration) can reach hosts on the tailnet. It does what the GitHub
marketplace action `tailscale/github-action` does, written for Gitea Actions: marketplace action `tailscale/github-action` does, written for Gitea Actions:
that action is built for GitHub and has not been verified on Gitea. It is that action is built for GitHub and has not been verified on Gitea. It is
**experimental**: it is on `main` but not released, and it has not yet run on a **experimental**: it is released in 2.2.0, and it has not yet run on a
runner with a real tailnet (MIL-012). For a plain tunnel without a third-party service, see runner with a real tailnet (MIL-012). For a plain tunnel without a third-party service, see
[WireGuard](vpn-wireguard.md). [WireGuard](vpn-wireguard.md).
@@ -23,7 +23,7 @@ jobs:
- uses: actions/checkout@v4.2.2 - uses: actions/checkout@v4.2.2
- name: Connect Tailscale - name: Connect Tailscale
uses: TirSystem/github-action/actions/connect-tailscale@main uses: TirSystem/github-action/actions/connect-tailscale@v2
with: with:
oauth-secret: ${{ secrets.TS_OAUTH_SECRET }} oauth-secret: ${{ secrets.TS_OAUTH_SECRET }}
tags: tag:ci tags: tag:ci
@@ -35,17 +35,14 @@ jobs:
- name: Disconnect Tailscale - name: Disconnect Tailscale
if: always() if: always()
uses: TirSystem/github-action/actions/connect-tailscale@main uses: TirSystem/github-action/actions/connect-tailscale@v2
with: with:
action: down action: down
``` ```
If the short form does not resolve on your instance (Gitea looks for the action If the short form does not resolve on your instance (Gitea looks for the action
on the host set in `DEFAULT_ACTIONS_URL`), use the full address: on the host set in `DEFAULT_ACTIONS_URL`), use the full address:
`https://git.tirsystem.com/TirSystem/github-action/actions/connect-tailscale@main`. `https://git.tirsystem.com/TirSystem/github-action/actions/connect-tailscale@v2`.
Until release 2.2.0 the actions exist only on `main`, so the examples call
`@main`; `@v2` does not contain them yet. After the release, use `@v2`.
## Inputs ## Inputs
guides/vpn-wireguard.md
+5 -8
View File
@@ -4,8 +4,8 @@ The composite action `actions/connect-wireguard` brings a WireGuard tunnel up on
a Gitea Actions runner, so the next steps of the same job (a deployment over a Gitea Actions runner, so the next steps of the same job (a deployment over
SSH, a database migration) can reach hosts that are not on the internet. It is SSH, a database migration) can reach hosts that are not on the internet. It is
the WireGuard counterpart of the Tailscale action. It is **experimental**: it the WireGuard counterpart of the Tailscale action. It is **experimental**: it
is on `main` but not released, and it has not yet run on a runner with a real is released in 2.2.0, and it has not yet run on a runner with a real tunnel
tunnel (MIL-012). (MIL-012).
A tunnel belongs to one job: every job that deploys brings its own tunnel up A tunnel belongs to one job: every job that deploys brings its own tunnel up
and takes it down. It cannot be a reusable workflow, because a called workflow and takes it down. It cannot be a reusable workflow, because a called workflow
@@ -21,7 +21,7 @@ jobs:
- uses: actions/checkout@v4.2.2 - uses: actions/checkout@v4.2.2
- name: Connect the VPN - name: Connect the VPN
uses: TirSystem/github-action/actions/connect-wireguard@main uses: TirSystem/github-action/actions/connect-wireguard@v2
with: with:
config: ${{ secrets.WG_CONFIG }} config: ${{ secrets.WG_CONFIG }}
health-check-host: 10.8.0.1 health-check-host: 10.8.0.1
@@ -31,17 +31,14 @@ jobs:
- name: Disconnect the VPN - name: Disconnect the VPN
if: always() if: always()
uses: TirSystem/github-action/actions/connect-wireguard@main uses: TirSystem/github-action/actions/connect-wireguard@v2
with: with:
action: down action: down
``` ```
If the short form does not resolve on your instance (Gitea looks for the action If the short form does not resolve on your instance (Gitea looks for the action
on the host set in `DEFAULT_ACTIONS_URL`), use the full address: on the host set in `DEFAULT_ACTIONS_URL`), use the full address:
`https://git.tirsystem.com/TirSystem/github-action/actions/connect-wireguard@main`. `https://git.tirsystem.com/TirSystem/github-action/actions/connect-wireguard@v2`.
Until release 2.2.0 the actions exist only on `main`, so the examples call
`@main`; `@v2` does not contain them yet. After the release, use `@v2`.
## Inputs ## Inputs