From e95d77f38af08dfe980428f264ae1a079433d7e3 Mon Sep 17 00:00:00 2001
From: Daniel Gibbs <me@danielgibbs.co.uk>
Date: Wed, 14 Jun 2023 23:54:31 +0100
Subject: [PATCH] chore: update GitHub workflow names and add more descriptive
names
This commit updates the name of several GitHub workflows to use proper capitalization and adds more descriptive names. The changes include:
- Add to project workflow: updated name from "Add game server requests to project" to "Add to Project"
- Details check workflow: updated name from "Details Check" to "Check LinuxGSM game server config and parameter variables"
- Git sync workflow: updated name from "Github to Bitbucket sync" to "Sync GitHub repo with backup Bitbucket repo"
- Issue labeler workflow: updated name from "Issue Labeler" to "Automatically label issues based on configuration file"
- Lock threads workflow: updated name from "Lock Threads" to "Automatically lock inactive threads after one week"
- Potential duplicates workflow: updated name from "Potential Duplicates" to "Detect potential duplicate issues and apply a label"
- Server list validation workflow: updated name from "Server list Validation" to Validate LinuxGSM serverlist.json format
- Trigger docker build workflow: added more descriptive names for each job
- Update copyright years in license file workflow: removed unnecessary dashes at the beginning, added a more concise description
- Version check workflow: added a more concise description
---
.github/workflows/add-to-project.yml | 6 ++---
.github/workflows/details-check.yml | 9 ++++---
.github/workflows/git-sync.yml | 9 ++++---
.github/workflows/label-sponsors.yml | 14 ----------
.github/workflows/labeler.yml | 26 ++++++++++++-------
.github/workflows/lock.yml | 14 +++++-----
.github/workflows/potential-duplicates.yml | 19 ++++----------
.github/workflows/serverlist-validate.yml | 7 ++---
.github/workflows/trigger-docker-build.yml | 9 ++++---
...update-copyright-years-in-license-file.yml | 8 +++---
.github/workflows/version-check.yml | 9 ++++---
11 files changed, 58 insertions(+), 72 deletions(-)
delete mode 100644 .github/workflows/label-sponsors.yml
diff --git a/.github/workflows/add-to-project.yml b/.github/workflows/add-to-project.yml
index 1a20ef190..e429645bf 100644
--- a/.github/workflows/add-to-project.yml
+++ b/.github/workflows/add-to-project.yml
@@ -1,4 +1,4 @@
-name: Add to project
+name: Add to Project
on:
issues:
types:
@@ -7,10 +7,10 @@ on:
jobs:
add-to-project:
- name: Add game server requests to project
runs-on: ubuntu-latest
steps:
- - uses: actions/add-to-project@v0.5.0
+ - name: Add to Project
+ uses: actions/add-to-project@v0.5.0
with:
project-url: https://github.com/orgs/GameServerManagers/projects/11
github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}
diff --git a/.github/workflows/details-check.yml b/.github/workflows/details-check.yml
index eaaea86e9..609b90a52 100644
--- a/.github/workflows/details-check.yml
+++ b/.github/workflows/details-check.yml
@@ -1,5 +1,5 @@
-name: Details Check
# This action will check that LinuxGSM is picking up game server config and parameter variables.
+name: Details Check
on:
workflow_dispatch:
push:
@@ -16,7 +16,8 @@ jobs:
- name: Generate matrix with generate-matrix.sh
run: chmod +x .github/workflows/detals-check-generate-matrix.sh; .github/workflows/detals-check-generate-matrix.sh
- - id: set-matrix
+ - name: Set Matrix
+ id: set-matrix
run: |
shortnamearray=$(cat shortnamearray.json)
echo "${shortnamearray}"
@@ -43,8 +44,8 @@ jobs:
- name: Enable developer mode
run: LGSM_GITHUBBRANCH="${GITHUB_REF#refs/heads/}" ./${{ matrix.shortname }}server developer
- - id: sets-servercfgname
- name: Generate servercfgname
+ - name: Generate servercfgname
+ id: sets-servercfgname
run: |
servercfg=$(sed -n "/^\<servercfgdefault\>/ { s/.*= *\"\?\([^\"']*\)\"\?/\1/p;q }" lgsm/config-lgsm/${{ matrix.shortname }}server/_default.cfg)
echo "servercfgname=$servercfg" >> "$GITHUB_OUTPUT"
diff --git a/.github/workflows/git-sync.yml b/.github/workflows/git-sync.yml
index e013ae32d..42ddd42e5 100644
--- a/.github/workflows/git-sync.yml
+++ b/.github/workflows/git-sync.yml
@@ -1,4 +1,4 @@
-name: Github to Bitbucket sync
+name: Github to Bitbucket Sync
# This action will sync the github repo with a backup bitbucket repo.
# This will allow LinuxGSM to use Bitbucket as and alternative download if github fails.
on:
@@ -6,16 +6,17 @@ on:
branches:
- master
- develop
+
jobs:
- GitHub-to-Bitbucket:
+ gitHub-to-bitbucket:
runs-on: ubuntu-latest
steps:
- - name: webfactory/ssh-agent@v0.8.0
+ - name: SSH Agent
uses: webfactory/ssh-agent@v0.8.0
with:
ssh-private-key: ${{ secrets.BITBUCKET_SECRET }}
- - name: wei/git-sync@v3.0.0
+ - name: Git Sync
uses: wei/git-sync@v3.0.0
with:
ssh_private_key: ${{ secrets.BITBUCKET_SECRET }}
diff --git a/.github/workflows/label-sponsors.yml b/.github/workflows/label-sponsors.yml
deleted file mode 100644
index c16f66ff6..000000000
--- a/.github/workflows/label-sponsors.yml
+++ /dev/null
@@ -1,14 +0,0 @@
-name: Label sponsors
-on:
- pull_request:
- types: [opened]
- issues:
- types: [opened]
-jobs:
- build:
- name: is-sponsor-label
- runs-on: ubuntu-latest
- steps:
- - uses: JasonEtco/is-sponsor-label-action@v2
- env:
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/labeler.yml b/.github/workflows/labeler.yml
index ebf260f6f..f04630831 100644
--- a/.github/workflows/labeler.yml
+++ b/.github/workflows/labeler.yml
@@ -1,24 +1,30 @@
-name: "Issue Labeler"
+name: Issue Labeler
on:
issues:
- types: [opened, edited]
- pull_request:
- types: [opened, edited]
+ types:
+ - opened
+ - edited
permissions:
+ issues: write
contents: read
jobs:
- triage:
- permissions:
- contents: read # for github/issue-labeler to get repo contents
- issues: write # for github/issue-labeler to create or remove labels
+ issue-labeler:
runs-on: ubuntu-latest
steps:
- - uses: github/issue-labeler@v3.1
+ - name: Issue Labeler
+ uses: github/issue-labeler@v3.1
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
configuration-path: .github/labeler.yml
- not-before:
enable-versioned-regex: 0
include-title: 1
+
+ is-sponsor-label:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Is Sponsor Label
+ uses: JasonEtco/is-sponsor-label-action@v2
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/lock.yml b/.github/workflows/lock.yml
index 774f84364..4883914f8 100644
--- a/.github/workflows/lock.yml
+++ b/.github/workflows/lock.yml
@@ -1,20 +1,18 @@
-name: "Lock Threads"
-
+name: Lock Threads
on:
schedule:
- - cron: "0 0 * * *"
+ - cron: "0 0 * * 1"
permissions:
- contents: read
+ issues: write
+ pull-requests: write
jobs:
lock:
- permissions:
- issues: write # for dessant/lock-threads to lock issues
- pull-requests: write # for dessant/lock-threads to lock PRs
runs-on: ubuntu-latest
steps:
- - uses: dessant/lock-threads@v4
+ - name: Lock Threads
+ uses: dessant/lock-threads@v4
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
issue-comment: >
diff --git a/.github/workflows/potential-duplicates.yml b/.github/workflows/potential-duplicates.yml
index f1e783674..3c7f4334c 100644
--- a/.github/workflows/potential-duplicates.yml
+++ b/.github/workflows/potential-duplicates.yml
@@ -1,30 +1,21 @@
name: Potential Duplicates
on:
issues:
- types: [opened]
+ types:
+ - opened
jobs:
- run:
+ potential-duplicates:
runs-on: ubuntu-latest
steps:
- - uses: wow-actions/potential-duplicates@v1
+ - name: Potential Duplicates
+ uses: wow-actions/potential-duplicates@v1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- # Issue title filter work with anymatch https://www.npmjs.com/package/anymatch.
- # Any matched issue will stop detection immediately.
- # You can specify multi filters in each line.
filter: ""
- # Exclude keywords in title before detecting.
exclude: ""
- # Label to set, when potential duplicates are detected.
label: potential-duplicate
- # Get issues with state to compare. Supported state: 'all', 'closed', 'open'.
state: all
- # If similarity is higher than this threshold([0,1]), issue will be marked as duplicate.
threshold: 0.8
- # Reactions to be add to comment when potential duplicates are detected.
- # Available reactions: "-1", "+1", "confused", "laugh", "heart", "hooray", "rocket", "eyes"
- #reactions: 'eyes, confused'
- # Comment to post when potential duplicates are detected.
comment: >
Potential duplicates: {{#issues}}
- [#{{ number }}] {{ title }} ({{ accuracy }}%)
diff --git a/.github/workflows/serverlist-validate.yml b/.github/workflows/serverlist-validate.yml
index e12c0e95c..39f37e1df 100644
--- a/.github/workflows/serverlist-validate.yml
+++ b/.github/workflows/serverlist-validate.yml
@@ -1,4 +1,4 @@
-name: Server list Validation
+name: Server List Validation
on:
workflow_dispatch:
push:
@@ -7,7 +7,8 @@ jobs:
serverlist-validate:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v3
+ - name: Checkout
+ uses: actions/checkout@v3
- - name: compare versions
+ - name: Compare Versions
run: chmod +x .github/workflows/serverlist-validate.sh; .github/workflows/serverlist-validate.sh
diff --git a/.github/workflows/trigger-docker-build.yml b/.github/workflows/trigger-docker-build.yml
index dec3dd462..76d4275a6 100644
--- a/.github/workflows/trigger-docker-build.yml
+++ b/.github/workflows/trigger-docker-build.yml
@@ -3,12 +3,13 @@ on:
release:
types:
- published
+
jobs:
trigger_build_docker-linuxgsm:
- name: Trigger Build docker-linuxgsm
runs-on: ubuntu-latest
steps:
- - uses: convictional/trigger-workflow-and-wait@v1.6.5
+ - name: Trigger Workflow and Wait (linuxgsm)
+ uses: convictional/trigger-workflow-and-wait@v1.6.5
with:
owner: GameServerManagers
repo: docker-linuxgsm
@@ -16,10 +17,10 @@ jobs:
workflow_file_name: docker-publish.yml
trigger_build_docker-gameserver:
- name: Trigger Build docker-linuxgsm
runs-on: ubuntu-latest
steps:
- - uses: convictional/trigger-workflow-and-wait@v1.6.5
+ - name: Trigger Workflow and Wait (gameserver)
+ uses: convictional/trigger-workflow-and-wait@v1.6.5
with:
owner: GameServerManagers
repo: docker-gameserver
diff --git a/.github/workflows/update-copyright-years-in-license-file.yml b/.github/workflows/update-copyright-years-in-license-file.yml
index 162a27944..d90ba4a5d 100644
--- a/.github/workflows/update-copyright-years-in-license-file.yml
+++ b/.github/workflows/update-copyright-years-in-license-file.yml
@@ -1,6 +1,4 @@
----
name: Update copyright year(s) in license file
-
on:
workflow_dispatch:
schedule:
@@ -10,10 +8,12 @@ jobs:
update-license-year:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v3
+ - name: Checkout
+ uses: actions/checkout@v3
with:
fetch-depth: 0
- - uses: FantasticFiasco/action-update-license-year@v3
+ - name: Action Update License Year
+ uses: FantasticFiasco/action-update-license-year@v3
with:
token: ${{ secrets.GITHUB_TOKEN }}
path: LICENSE.md
diff --git a/.github/workflows/version-check.yml b/.github/workflows/version-check.yml
index a12b34420..cb51d4b2f 100644
--- a/.github/workflows/version-check.yml
+++ b/.github/workflows/version-check.yml
@@ -1,6 +1,6 @@
name: Version Check
-
-on: push
+on:
+ push:
permissions:
contents: read
@@ -9,7 +9,8 @@ jobs:
version-Check:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v3
+ - name: Checkout
+ uses: actions/checkout@v3
- - name: compare versions
+ - name: Version Check
run: chmod +x .github/workflows/version-check.sh; .github/workflows/version-check.sh