Skip to content

Commit a98625c

Browse files
committed
chore(actions): implement auto check
1 parent 20cb543 commit a98625c

36 files changed

+66
-599
lines changed

.github/workflows/auto-check-workflow.yml

Lines changed: 0 additions & 67 deletions
This file was deleted.

.github/workflows/ci-workflow.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Arcadia Continuous Integration
1+
name: Goo Continuous Integration
22

33
on:
44
push:

.github/workflows/release-workflow.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Arcadia Release
1+
name: Goo Release
22

33
on:
44
push:

.goreleaser.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ before:
55
# - go mod generate
66

77
builds:
8-
- id: "arcadia"
8+
- id: "goo"
99
env:
1010
- CGO_ENABLED=0
1111
goos:

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# 🦄 arcadia: ___Go template for Cobra based cli applications___
1+
# 🦄 goo: ___Go template for Cobra based cli applications___
22

33
[![A B](https://img.shields.io/badge/branching-commonflow-informational?style=flat)](https://commonflow.org)
44
[![A B](https://img.shields.io/badge/merge-rebase-informational?style=flat)](https://git-scm.com/book/en/v2/Git-Branching-Rebasing)
55
[![A B](https://img.shields.io/badge/branch%20history-linear-blue?style=flat)](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule)
6-
[![Go Reference](https://pkg.go.dev/badge/github.com/snivilised/arcadia.svg)](https://pkg.go.dev/github.com/snivilised/arcadia)
7-
[![Go report](https://goreportcard.com/badge/github.com/snivilised/arcadia)](https://goreportcard.com/report/github.com/snivilised/arcadia)
8-
[![Coverage Status](https://coveralls.io/repos/github/snivilised/arcadia/badge.svg?branch=master)](https://coveralls.io/github/snivilised/arcadia?branch=master&kill_cache=1)
9-
[![Arcadia Continuous Integration](https://github.com/snivilised/arcadia/actions/workflows/ci-workflow.yml/badge.svg)](https://github.com/snivilised/arcadia/actions/workflows/ci-workflow.yml)
6+
[![Go Reference](https://pkg.go.dev/badge/github.com/snivilised/goo.svg)](https://pkg.go.dev/github.com/snivilised/goo)
7+
[![Go report](https://goreportcard.com/badge/github.com/snivilised/goo)](https://goreportcard.com/report/github.com/snivilised/goo)
8+
[![Coverage Status](https://coveralls.io/repos/github/snivilised/goo/badge.svg?branch=master)](https://coveralls.io/github/snivilised/goo?branch=master&kill_cache=1)
9+
[![Goo Continuous Integration](https://github.com/snivilised/goo/actions/workflows/ci-workflow.yml/badge.svg)](https://github.com/snivilised/goo/actions/workflows/ci-workflow.yml)
1010
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
1111
[![A B](https://img.shields.io/badge/commit-conventional-commits?style=flat)](https://www.conventionalcommits.org/)
1212

@@ -53,7 +53,7 @@ By using this template, there is no need to use the cobra-cli to scaffold your a
5353

5454
### 📝 Checklist of required changes
5555

56-
The following is list of actions that must be performed before using this template. Most of the changes concern changing the name `Arcadia` to the name of the new application. As the template is instantiated from github, the new name will automatically replace the top level directory name, that being ___arcadia___. However, there are 2 situations at hand:
56+
The following is list of actions that must be performed before using this template. Most of the changes concern changing the name `Goo` to the name of the new application. As the template is instantiated from github, the new name will automatically replace the top level directory name, that being ___goo___. However, there are 2 situations at hand:
5757

5858
1) target repo is owned by the snivilised organisation: the changes required will be made automatically after the repo has been created from the template WITHOUT user intervention
5959

@@ -73,7 +73,7 @@ $ git commit -m "chore: initialise repository from template"
7373
$ git push
7474
```
7575

76-
➕ The following descriptions use owner name ___pandora___ and repo name ___maestro___ as an example. That is to say the client has instantiated ___arcadia___ template into github at url _github.com/pandora/maestro_
76+
➕ The following descriptions use owner name ___pandora___ and repo name ___maestro___ as an example. That is to say the client has instantiated ___goo___ template into github at url _github.com/pandora/maestro_
7777

7878
#### 🤖 Automated changes
7979

@@ -121,7 +121,7 @@ Of course, its up to the user what settings they use in their repo, these are ju
121121

122122
### 🌐 l10n Translations
123123

124-
This template has been setup to support localisation. The default language is `en-GB` with support for `en-US`. There is a translation file for `en-US` defined as __locale/i18n/deploy/arcadia.active.en-US.json__. This is the initial translation for `en-US` that should be deployed with the app.
124+
This template has been setup to support localisation. The default language is `en-GB` with support for `en-US`. There is a translation file for `en-US` defined as __locale/i18n/deploy/goo.active.en-US.json__. This is the initial translation for `en-US` that should be deployed with the app.
125125

126126
Make sure that the go-i18n package has been installed so that it can be invoked as cli, see [go-i18n](https://github.com/nicksnyder/go-i18n) for installation instructions.
127127

Taskfile.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ dotenv: [".env"]
55

66
vars:
77
FORMAT: json
8-
BINARY_NAME: arcadia
8+
BINARY_NAME: goo
99
DEPLOY_DIR: ./locale/i18n/deploy
1010
OUT_DIR: ./locale/i18n/out
1111
DIST_DIR: ./dist
@@ -216,7 +216,7 @@ tasks:
216216
- rm ./{{.OUT_DIR}}/* --recursive
217217

218218
# extract: scans for i18m messages in source code
219-
# - creates empty out/l10n/arcadia.translate.en-US.json
219+
# - creates empty out/l10n/goo.translate.en-US.json
220220
# - extracts messages into out/active.en-GB.json
221221
#
222222
extract:

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v0.3.4
1+
v0.1.0

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
module github.com/snivilised/arcadia
1+
module github.com/snivilised/goo
22

33
go 1.26.0
44

resources/doc/i18n-README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@ The local directory structure is as follows:
88

99
- ___default___: contains the translation file created by the __newt__ (new translation task). Actually, this task creates an __active__ file (`active.en-GB.json`) in the `i18n/out` folder, the result of which needs to be manually copied into the __active__ file in the `default` folder.
1010

11-
- ___deploy___: contains all the translations files that are intended to be deployed with the application. There will be one per supported language and by default this template project includes a translation file for __en-US__ (`arcadia.active.en-US.json`)
11+
- ___deploy___: contains all the translations files that are intended to be deployed with the application. There will be one per supported language and by default this template project includes a translation file for __en-US__ (`goo.active.en-US.json`)
1212

1313
## ⚙️ Translation Workflow
1414

1515
### ✨ New Translations
1616

17-
__goi18n__ instructs the user to manually create an empty translation message file that they want to add (eg `translate.en-US.json`). This is taken care of by the __newt__ task. Then the requirement is to run the goi18n merge \<active\> command (goi18n merge `arcadia.active.en-US.json` `arcadia.translate.en-US.json`). This has been wrapped up into the __merge__ task and the result is that the translation file `arcadia.translation.en-US.json` is populated with the messages to be translated. So the sequence goes:
17+
__goi18n__ instructs the user to manually create an empty translation message file that they want to add (eg `translate.en-US.json`). This is taken care of by the __newt__ task. Then the requirement is to run the goi18n merge \<active\> command (goi18n merge `goo.active.en-US.json` `goo.translate.en-US.json`). This has been wrapped up into the __merge__ task and the result is that the translation file `goo.translation.en-US.json` is populated with the messages to be translated. So the sequence goes:
1818

19-
- run __newt__ task: (generates default language file `./locale/i18n/out/active.en-GB.json` and empty `./locale/i18n/out/us-US/arcadia.translation.en-US.json` file). This task can be run from the root folder, __goi18n__ will recursively search the directory tree for files with translate-able content, ie files with template definitions (___i18n.Message___)
20-
- run __merge__ task: derives a translation file for the requested language __en-US__ using 2 files as inputs: source active file (`./locale/i18n/out/active.en-GB.json`) and the empty __en-US__ translate file (`./locale/i18n/out/us-US/arcadia.translation.en-US.json`), both of which were generated in the previous step.
19+
- run __newt__ task: (generates default language file `./locale/i18n/out/active.en-GB.json` and empty `./locale/i18n/out/us-US/goo.translation.en-US.json` file). This task can be run from the root folder, __goi18n__ will recursively search the directory tree for files with translate-able content, ie files with template definitions (___i18n.Message___)
20+
- run __merge__ task: derives a translation file for the requested language __en-US__ using 2 files as inputs: source active file (`./locale/i18n/out/active.en-GB.json`) and the empty __en-US__ translate file (`./locale/i18n/out/us-US/goo.translation.en-US.json`), both of which were generated in the previous step.
2121
- hand the translate file to your translator for them to translate
22-
- rename the translate file to the active equivalent (`arcadia.translation.en-US.json`). Save this into the __deploy__ folder. This file will be deployed with the application.
22+
- rename the translate file to the active equivalent (`goo.translation.en-US.json`). Save this into the __deploy__ folder. This file will be deployed with the application.
2323

2424
### 🧩 Update Existing Translations (⚠️ not finalised)
2525

@@ -36,7 +36,7 @@ However, in this template, the user can execute the following steps:
3636

3737
- run task __update__: this will re-extract messages into `active.en-GB.json` and then runs merge to create an updated translate file.
3838
- hand the translate file to your translator for them to translate
39-
- as before, this translated file should be used to update the active file `arcadia.active.en-US.json` inside the __deploy__ folder.
39+
- as before, this translated file should be used to update the active file `goo.active.en-US.json` inside the __deploy__ folder.
4040

4141
## 🎓 Task Reference
4242

@@ -64,7 +64,7 @@ Outputs:
6464
Inputs:
6565

6666
- ./locale/i18n/out/active.en-GB.json
67-
- ./locale/i18n/out/en-US/arcadia.translate-en-US.json
67+
- ./locale/i18n/out/en-US/goo.translate-en-US.json
6868

6969
Outputs:
7070

0 commit comments

Comments
 (0)