|
1 | | -# 🌟 astrolib: ___Go template for library modules___ |
| 1 | +# 🌟 mamba: ___Go template for library modules___ |
2 | 2 |
|
3 | 3 | [](https://commonflow.org) |
4 | 4 | [](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) |
5 | 5 | [](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 | | -[](https://pkg.go.dev/github.com/snivilised/astrolib) |
7 | | -[](https://goreportcard.com/report/github.com/snivilised/astrolib) |
8 | | -[](https://coveralls.io/github/snivilised/astrolib?branch=main&kill_cache=1) |
9 | | -[](https://github.com/snivilised/astrolib/actions/workflows/ci-workflow.yml) |
| 6 | +[](https://pkg.go.dev/github.com/snivilised/mamba) |
| 7 | +[](https://goreportcard.com/report/github.com/snivilised/mamba) |
| 8 | +[](https://coveralls.io/github/snivilised/mamba?branch=main&kill_cache=1) |
| 9 | +[](https://github.com/snivilised/mamba/actions/workflows/ci-workflow.yml) |
10 | 10 | [](https://github.com/pre-commit/pre-commit) |
11 | 11 | [](https://www.conventionalcommits.org/) |
12 | 12 |
|
@@ -53,38 +53,38 @@ By using this template, there is no need to use the cobra-cli to scaffold your a |
53 | 53 |
|
54 | 54 | ### 📝 Checklist of required changes |
55 | 55 |
|
56 | | -The following is list of actions that must be performed before using this template. Most of the changes concern changing the name `astrolib` 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 ___astrolib___. |
| 56 | +The following is list of actions that must be performed before using this template. Most of the changes concern changing the name `mamba` 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 ___mamba___. |
57 | 57 |
|
58 | | -➕ The following descriptions use owner name ___pandora___ and repo name ___maestro___ as an example. That is to say the client has instantiated ___astrolib___ template into github at url _github.com/pandora/maestro_ |
| 58 | +➕ The following descriptions use owner name ___pandora___ and repo name ___maestro___ as an example. That is to say the client has instantiated ___mamba___ template into github at url _github.com/pandora/maestro_ |
59 | 59 |
|
60 | 60 | #### 🤖 Automated changes |
61 | 61 |
|
62 | 62 | Automated via `automate-checklist.sh` script. When the user instantiates the repo, a github actions workflow is executed which applies changes to the clients repo automatically. The following description describes the changes that are applied on the user's behalf and the workflow is automatically deleted. However, there are other changes that should be made. These compose the manual checklist and should be heeded by the user. |
63 | 63 |
|
64 | 64 | ##### ✅ Rename import statements |
65 | 65 |
|
66 | | -+ `rename import paths`: global search and replace ___snivilised/astrolib___ to ___pandora/maestro___ |
| 66 | ++ `rename import paths`: global search and replace ___snivilised/mamba___ to ___pandora/maestro___ |
67 | 67 |
|
68 | 68 | ##### ✅ Identifiers |
69 | 69 |
|
70 | | -+ `change astrolibTemplData`: perform a refactor rename (_Rename Symbol_) to ___maestroTemplData___ |
| 70 | ++ `change mambaTemplData`: perform a refactor rename (_Rename Symbol_) to ___maestroTemplData___ |
71 | 71 |
|
72 | | -##### ✅ Global search replace astrolib to maestro |
| 72 | +##### ✅ Global search replace mamba to maestro |
73 | 73 |
|
74 | 74 | Will take care of the following required changes: |
75 | 75 |
|
76 | 76 | + `change module name`: update the module name inside the .mod file in the root directory |
77 | 77 | + `change ApplicationName`: modify to reflect the new application name. This application name is incorporated into the name of any translation files to be loaded. |
78 | 78 | + `update BINARY_NAME`: Inside _Taskfile.yml_, change the value of ___BINARY_NAME___ to the name of the client application. |
79 | | -+ `update github action workflows`: change the name of the workflows in the .yaml files to replace ___astrolib___ to ___Maestro___ (note the change of case, if this is important). |
| 79 | ++ `update github action workflows`: change the name of the workflows in the .yaml files to replace ___mamba___ to ___Maestro___ (note the change of case, if this is important). |
80 | 80 |
|
81 | 81 | ##### ✅ Localisation/Internationalisation |
82 | 82 |
|
83 | | -+ `change the names of the translation files`: eg change ___astrolib.active.en-GB.json___ to ___maestro.active.en-GB.json___ |
| 83 | ++ `change the names of the translation files`: eg change ___mamba.active.en-GB.json___ to ___maestro.active.en-GB.json___ |
84 | 84 |
|
85 | 85 | ##### ✅ Miscellaneous automated changes |
86 | 86 |
|
87 | | -+ `reset version files`: this is optional because the release process automatically updates the version number according to the tag specified by the user, but will initially contain the version number which reflects the current value of astrolib at the time the client project is instantiated. |
| 87 | ++ `reset version files`: this is optional because the release process automatically updates the version number according to the tag specified by the user, but will initially contain the version number which reflects the current value of mamba at the time the client project is instantiated. |
88 | 88 | + `change SOURCE_ID`: to "github.com/pandora/maestro" |
89 | 89 |
|
90 | 90 | #### 🖐 Manual changes |
@@ -125,7 +125,7 @@ Of course, its up to the user what settings they use in their repo, these are ju |
125 | 125 |
|
126 | 126 | ### 🌐 l10n Translations |
127 | 127 |
|
128 | | -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 __src/i18n/deploy/astrolib.active.en-US.json__. This is the initial translation for `en-US` that should be deployed with the app. |
| 128 | +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 __src/i18n/deploy/mamba.active.en-US.json__. This is the initial translation for `en-US` that should be deployed with the app. |
129 | 129 |
|
130 | 130 | 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. |
131 | 131 |
|
|
0 commit comments