Adding additional questions to copier template for use outside of the OCA #144
Conversation
|
Divided opinion. I'm un favor to have OCA tools that can be used for other repo. That promote OCA standards and possibly generate new contributors for OCA tools. |
|
I'm in favor. These represent a low maintenance cost for OCA and make the template more versatile. Making the dev status check optional is also important for older OCA branches where making it mandatory would make many repos red, generating unncessary busywork. Could you add a question to enable the license check too for the same reason, and so it closes #83 . |
src/.github/workflows/{% if ci == 'GitHub' %}test.yml{% endif %}.jinja
Outdated
Show resolved
Hide resolved
src/.github/workflows/{% if ci == 'GitHub' %}test.yml{% endif %}.jinja
Outdated
Show resolved
Hide resolved
I didn't thought about old OCA branches. It's a 👍 |
|
In the same vein, I created #145. |
theangryangel
force-pushed
the
T3227
branch
2 times, most recently
from
6ac240a
to
ac87904
Compare
For the stale question, for me, it's 100% selfish, and I'd understand it if that's not something the OCA want to accept. We don't use GitHub issues for 99% of the repositories until they're open source, and even then the traffic we get on them is currently so low - if we don't need the action running I'd prefer to try and save the planet, even if it's just a very small amount :)
Done :) I've adjusted the implementation so that the GitHub stale question doesn't depend on if ci == 'GitHub', I assumed there are scenarios where Travis is used, but stale does need to be enabled? I've also tried to work around what I believe is python-poetry/poetry#3010 which was causing the Python 2.7 tests to intermittently fail on GitHub runners by slightly adjusting the repo's own test.yml. Do you want me to add further tests for coverage? |
| - name: Check development status | ||
| run: manifestoo -d . check-dev-status --default-dev-status=Beta | ||
| - name: Initialize test db | ||
| run: oca_init_test_database | ||
| {%- if not github_enforce_dev_status_compatibility %} | ||
| if: always() |
There was a problem hiding this comment.
Is it not continue-on-error instead ?
Can you do the same for the license check ?
And ideally show a test run somewhere ?
There was a problem hiding this comment.
Is it not continue-on-error instead ?
Apologies I thought that was only available at the job level.
Can you do the same for the license check ?
Added
And ideally show a test run somewhere ?
I'll set something setup now :)
… used outside of the OCA more easily, fixes T3227
|
Some sample runs are available at https://github.com/GlodoUK/oca_addons-repo-template-pr-144/pulls against 2 different branches, with slightly different settings. |
| type: bool | ||
| default: yes | ||
| help: GitHub action checks the minimum development status? | ||
| when: &ci_is_github "{{ ci == 'GitHub' }}" |
| @@ -54,6 +54,9 @@ jobs: | |||
| key: >- | |||
| cache ${{ secrets.CACHE_DATE }} ${{ env.PY }} ${{ runner.os }} ${{ | |||
| hashFiles('pyproject.toml') }} ${{ hashFiles('poetry.lock') }} | |||
| # HACK python-poetry/poetry#3010 and 3336 workaround for GitHub actions | |||
| # and poetry 1.1.2 throwing 'Incorrectly nested style tag found.' | |||
| - run: poetry config experimental.new-installer false | |||
There was a problem hiding this comment.
I can't help thinking that poetry is overkill for this project.
|
Thanks Stéphane, much appreciated <3 |
The OCA addons repo template is a great resource for all partners, it allows us to build with the possibility of easily offering new modules to the OCA in the future by aligning as close as reasonably possible to the OCA's standards from the outset.
To ease this process we're proposing a few additional questions in the copier template that can disable certain areas that are problematic.
We have set all answers to default to ensure no change in current behaviour. We have setup all (except
github_enable_stale_action) questions to only be asked whenci == 'GitHub'.github_check_license: Check the manifest licensegithub_enforce_dev_status_compatibility: Disable the development status, applicable for early work which legitimately may be alpha/pre-alphagithub_enable_codecov: Disable the codecov actiongithub_enable_makepot: Disable the update of pot files, for not-yet-open-source repositories, this functionality currently failsgithub_enable_stale_action: Disable the GitHub stale actionBy introducing these questions it allows usage for outside of the OCA without needing to edit github workflows directly.
I've raised this as a draft for discussion, as I'm sure changes will need to be made, tests added, etc. But before we add those I wanted to check if this has the possibility of being accepted, or if it's completely out of scope of the project :)
cc @GlodoUK T3227