Add workflows related to translation updates #21
Conversation
| @@ -0,0 +1,31 @@ | |||
| # https://crontab.guru/crontab.5.html | |||
There was a problem hiding this comment.
Placing this file in .github/workflows has an unfortunate side effect that this action would be run for addonTemplate repo which is not what we want. Perhaps these sample actions should be moved to something like GitHubActions/sampleActions and documented in the readme.
There was a problem hiding this comment.
Disabling this action for add-on template repository would work but only for this repo. If someone uses this template as is and their add-on is not registered in the translations system they would be getting failures by default. I still maintain that moving these files from .github/workflows and documenting each of these actions in the readme is the simplest way to deal with the problem though I don't have any authority over this repository obviously.
| run: | | ||
| git config --global user.name github-actions | ||
| git config --global user.email [email protected] | ||
| git remote add l10n https://github.com/nvdaaddons/addonName # Replace with the repo name, for example, clipContentsDesigner |
There was a problem hiding this comment.
I'd be nice not to hardcode name of the repository. Have you tried playing with GITHUB_REPOSITORY to get the repo name?
| git pull | ||
| git push | ||
|
|
||
|
|
There was a problem hiding this comment.
This is still not addressed though not very important obviously.
|
Hello:
As far as I know, Actions can be disabled for specific repos on
GitHub, so if desired these workflows can be stored in the template.
About if I tried to play with a way to get the repo name without hard
coding it, yes, i did, though not in this case just for laziness
(smile). I'll fix this ASAP.
Thanks
2021-09-20 11:33 GMT+02:00, Łukasz Golonka ***@***.***>:
… @lukaszgo1 commented on this pull request.
> @@ -0,0 +1,31 @@
+# https://crontab.guru/crontab.5.html
Placing this file in `.github/workflows` has an unfortunate side effect that
this action would be run for addonTemplate repo which is not what we want.
Perhaps these sample actions should be moved to something like
`GitHubActions/sampleActions` and documented in the readme.
> + schedule:
+ # * is a special character in YAML so you have to quote this string
+ - cron: '1 * * * *' # Once every hour (minute 1)
+
+jobs:
+ update-translations:
+ runs-on: windows-latest
+ steps:
+ - name: Checkout main
+ uses: ***@***.***
+
+ - name: Push changes
+ run: |
+ git config --global user.name github-actions
+ git config --global user.email ***@***.***
+ git remote add l10n https://github.com/nvdaaddons/addonName #
Replace with the repo name, for example, clipContentsDesigner
I'd be nice not to hardcode name of the repository. Have you tried playing
with `GITHUB_REPOSITORY` to get the repo name?
> + steps:
+ - name: Checkout main
+ uses: ***@***.***
+
+ - name: Push changes
+ run: |
+ git config --global user.name github-actions
+ git config --global user.email ***@***.***
+ git remote add l10n https://github.com/nvdaaddons/addonName #
Replace with the repo name, for example, clipContentsDesigner
+ git fetch l10n
+ git reset l10n/stable addon/doc addon/locale
+ git commit -m "Update translations"
+ git pull
+ git push
+
+
A new line here please.
--
You are receiving this because you authored the thread.
Reply to this email directly or view it on GitHub:
#21 (review)
|
Would it be possible to perform actions only if repo is not addonTemplate? As an additional solution to disable for that repo. |
|
Oh, supergreat idea! I think it's possible checking the repo name. For
now I'veen successful, after various tests performing the workflow
without hard coding the repo name in clipContentsDesigner using
git remote add l10n https://github.com/nvdaaddons/${{
github.event.repository.name }}
2021-09-20 12:24 GMT+02:00, Alberto Buffolino ***@***.***>:
…> Placing this file in .github/workflows has an unfortunate side effect that
> this action would be run for addonTemplate repo which is not what we
> want.
Would it be possible to perform actions only if repo is not addonTemplate?
As an additional solution to disable for that repo.
--
You are receiving this because you authored the thread.
Reply to this email directly or view it on GitHub:
#21 (comment)
|
|
@lukaszgo1 , I think that I've addressed your suggestions. |
|
I have never played with GitHub actions, so I will not review the yaml files. However, it seems to me that a paragraph in the readme would be worth. For now the readme does not even speak about hosting the add-on on GitHub. To perform automatic checkIf you decide to host your add-on on GitHub some auto check are available. Just copy the file xxx.yaml from GitHubActions/sampleActions to .github/workflows. Check BOM... Check translationIf your add-on is registered in auto translation system, you can ... |
|
Of course this needs to be documented in the readme as optional code to be included. Since there are other workflows for linting, testing with NVDA, releasing etc., I haven"t writen any documentation until all or some of them can be accepted. Where the new line should be writen? After git push?
I think that it"s easier that the yaml files are in the workflows folder and disablin them, even individually, for example if someone doesn"t register an addn to be translated, all the yaml files can be included and disabled just checkfortranslations.yaml ol, alternatively, just include the desired files.
Enviado desde mi iPhone
… El 22 sept 2021, a las 14:50, Cyrille Bougot ***@***.***> escribió:
I have never played with GitHub actions, so I will not review the yaml files.
However, it seems to me that a paragraph in the readme would be worth. For now the readme does not even speak about hosting the add-on on GitHub.
E.g.
To perform automatic check
If you decide to host your add-on on GitHub some auto check are available. Just copy the file xxx.yaml from GitHubActions/sampleActions to .github/workflows.
Check BOM
...
Check translation
If your add-on is registered in auto translation system, you can ...
...
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub, or unsubscribe.
|
Having the doc in the same PR allows to ease review and to have an up-to-date documentation when merged.
Where is this
I think that all the actions should be optional and thus disabled by default. Remember that some may use the template with add-ons not part of the translation system or even not hosted on GitHub. I agree that enabling the actions should be easy. I have no preference between:
Technically, it is true that the doc asks to create an empty folder and to move files and folders from the template to the add-on's folder. Thus having .yaml files in the .github/workflows of the template should not be a problem for the users who do not use actions. They just do not need to copy the .github/workflows files in their add-on folder. Note, I thought that instructions regarding linting were added to the template but this does not seem to be the case. Am I right? |
If you look at the diff from this PR git complains that the action for fetching translations does not end with the carriage return just move to the end of file and press enter :-) |
+1 to this. Also who exactly can approve or reject this PR - it is not clear who has a final say for this repository.
I agree with this. I also tent to copy the entire template rather than picking particular files. If these actions are going to remain where they are now readme should clearly document how to disable them. Given that this procedure may change over time as GitHub modifies their interface not enabling them by default seems easier.
What exactly should be documented regarding linting in your opinion? |
Inform that this template has been linted with NVDA rules and describe how to lint an add-on based on this template. |
|
Hello, replying afterreading all your comments: Seems that workflows are enabled by default when someone creates a repo, even if the repo is created from a template and the workflow is disabled in the template repo. My suggestion is:
Regarding linting, I use a flake8.ini and a workflow (yaml file) to lint all files inthe add-on. Previously I just linted diffs in pull requests. Authors may want to disable this too if they don't want to lint all Python files contained in the addons folder. Of course the configuration file can be set to exclude paths, useful for example if an add-on uses a third party library. @lukaszgo1 ,the maintainer of this addonTemplate repo is @josephsl |
|
Hi @nvdaes , |
|
I love this! I'll see.
2021-09-23 12:38 GMT+02:00, Alberto Buffolino ***@***.***>:
… Hi @nvdaes ,
maybe it's a daredevil idea, but... is gh (github-cli) usable from a
template?
And, if yes, can you instruct a template x.yaml to runs "gh workflow disable
x.yaml" when execution conditions fail?
Just to increase automation...
--
You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub:
#21 (comment)
|
|
@ABuffEr and all, seems that your idea can be a reality. The problem is that now I don't know the option to enable the workflow from github.com interface. But when I try to run it from GitHub CLI, I get a message saying that it's not possible to run a disabled workflow. https://github.com/nvdaes/test/actions/runs/1269376153/workflow I can enable the workflow again from GitHub CLI. |
|
Hi,
|
|
I'll see this in more detail to check all your questions.
For now, the workflow is auto-disabled if the repo with the same name
is not present in the nvdaaddons org, or if it's present without a
stable branch.
To enable it, I'll test what happens if we create a different workflow
that check the condition and enable or disable it when appropriate.
2021-09-24 14:15 GMT+02:00, Alberto Buffolino ***@***.***>:
… Hi,
well, neither I know from Github, but are you saying that it's different as
usual?
Just to clarify, my idea was:
- dev (that we can suppose a novice and/or creating a new add-on not
official yet) create a new repo using this as template;
- included workflows run automatically, so checkForTranslations.yaml verify
that there aren't conditions to run (stable branch, fork on nvdaaddons,
etc), and autodisable itself, without dev intervention;
- when add-on is ready, dev asks for inclusion in translation system, and
receive an ok to re-enable the checkForTranslations.yaml workflow.
--
You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub:
#21 (comment)
|
|
Í"ve been thinking and I believe that a possibility will be to store the checkForTranslations.yaml file in an external repo, not in add-on template, and, when the personal add-on repo is folforked in this nvdaaddons organization, trigger an event to copy (and merge) the checkFor translations yaml file in the personal repo. So, in the add-on template repo we may include a yaml file for this, which is run in the fork event, since we fork repos just when people request the registration in the translation system. Since this is temporal and a different system is planned, we can store the checkForTranslations workflow in the existing l10N test repo created by @mhameed and also contributed by me for testing. |
|
Is this ready for review/merge in 2023? Thanks. |
Background
This has been discussed on the add-ons mailing list with @abdel792
@mhameed is the author of the workflow to check for symbols like BOM, which cause problems with Gettext, and help me a lot to practice and learn GitHub Actions.
@ABuffEr, @lukaszgo1, @CyrilleB79 and @grisov (who created a workflow to perform typing checks with Mypy) maybe interested.
This pull request also includes a workflow to update translations from stable branch of add-ons hosted in this organization, copying doc and locale folders to personal repos, once every hour.
I use these workflows in my add-ons. For this pr I have included some comments for clarification.