From fc61b3319d7d6f55ea9846481a3c935f81ad99c7 Mon Sep 17 00:00:00 2001 From: Gabriel Omar Cotelli Date: Tue, 14 May 2024 17:22:25 -0300 Subject: [PATCH] Update templates --- .github/workflows/markdown-lint.yml | 7 +++++-- .github/workflows/shellcheck.yml | 6 ++++-- README.md | 2 +- templates/.github/workflows/markdown-lint.yml | 2 +- templates/.github/workflows/pharo-loading-targets.yml | 4 +--- templates/.github/workflows/pharo-unit-tests.yml | 6 ++---- templates/.properties | 2 +- .../.smalltalkci/loading.dependent-sunit-extensions.ston | 3 ++- templates/.smalltalkci/loading.deployment.ston | 3 ++- templates/.smalltalkci/loading.development.ston | 3 ++- templates/.smalltalkci/loading.tests.ston | 3 ++- templates/.smalltalkci/loading.tools.ston | 3 ++- templates/.smalltalkci/unit-tests.ston | 3 ++- templates/README.md | 2 +- templates/docs/how-to/how-to-load-in-pharo.md | 2 +- templates/docs/how-to/how-to-use-as-dependency-in-pharo.md | 2 +- 16 files changed, 30 insertions(+), 23 deletions(-) diff --git a/.github/workflows/markdown-lint.yml b/.github/workflows/markdown-lint.yml index fbb50fa..84e4633 100644 --- a/.github/workflows/markdown-lint.yml +++ b/.github/workflows/markdown-lint.yml @@ -1,11 +1,14 @@ name: Markdown Lint -on: [push,pull_request,workflow_dispatch] +on: + - push + - pull_request + - workflow_dispatch jobs: remark-lint: name: runner / markdownlint runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: markdownlint uses: reviewdog/action-markdownlint@v0 with: diff --git a/.github/workflows/shellcheck.yml b/.github/workflows/shellcheck.yml index 89dd89b..bf61791 100644 --- a/.github/workflows/shellcheck.yml +++ b/.github/workflows/shellcheck.yml @@ -1,10 +1,12 @@ name: Shellcheck -on: [push,pull_request] +on: + - push + - pull_request jobs: shellcheck: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Run Shellcheck uses: reviewdog/action-shellcheck@v1 with: diff --git a/README.md b/README.md index 47150d0..ea6602e 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ The code is licensed under [MIT](LICENSE). ### Usage - Clone this repository -- Execute `setup.sh` providing the [required information](.usage.sh) +- Run `setup.sh` providing the [required information](.usage.sh) - Choose the name of your default branch. We use `release-candidate`, if you want a different one adapt the next steps as needed and use `-d` option - Review the proposed files and adapt it to your own needs diff --git a/templates/.github/workflows/markdown-lint.yml b/templates/.github/workflows/markdown-lint.yml index 20d9be0..9a7f3d6 100644 --- a/templates/.github/workflows/markdown-lint.yml +++ b/templates/.github/workflows/markdown-lint.yml @@ -8,7 +8,7 @@ jobs: name: Markdown Lint runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: markdownlint uses: reviewdog/action-markdownlint@v0 with: diff --git a/templates/.github/workflows/pharo-loading-targets.yml b/templates/.github/workflows/pharo-loading-targets.yml index 0be2d0d..9d77b2c 100644 --- a/templates/.github/workflows/pharo-loading-targets.yml +++ b/templates/.github/workflows/pharo-loading-targets.yml @@ -1,10 +1,8 @@ name: Pharo Loading Targets - on: - push - pull_request - workflow_dispatch - jobs: loading-targets: runs-on: ubuntu-latest @@ -12,8 +10,8 @@ jobs: fail-fast: false matrix: smalltalk: - - Pharo64-10 - Pharo64-11 + - Pharo64-12 load-target: - development - dependent-sunit-extensions diff --git a/templates/.github/workflows/pharo-unit-tests.yml b/templates/.github/workflows/pharo-unit-tests.yml index 1de39ce..a070bd3 100644 --- a/templates/.github/workflows/pharo-unit-tests.yml +++ b/templates/.github/workflows/pharo-unit-tests.yml @@ -1,10 +1,8 @@ name: Pharo Unit Tests - on: - push - pull_request - workflow_dispatch - jobs: unit-tests: runs-on: ubuntu-latest @@ -12,8 +10,8 @@ jobs: fail-fast: false matrix: smalltalk: - - Pharo64-10 - Pharo64-11 + - Pharo64-12 name: Unit Tests - ${{ matrix.smalltalk }} steps: - uses: actions/checkout@v4 @@ -27,7 +25,7 @@ jobs: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} timeout-minutes: 15 - name: Upload coverage to Codecov - uses: codecov/codecov-action@v3 + uses: codecov/codecov-action@v4 with: name: Unit-Tests-${{matrix.smalltalk}} token: ${{ secrets.CODECOV_TOKEN }} diff --git a/templates/.properties b/templates/.properties index 34653b7..5e7b65c 100644 --- a/templates/.properties +++ b/templates/.properties @@ -1,4 +1,4 @@ { - #format : #tonel, + #format : 'tonel', #version: '3.0' } diff --git a/templates/.smalltalkci/loading.dependent-sunit-extensions.ston b/templates/.smalltalkci/loading.dependent-sunit-extensions.ston index 8a6e246..958feeb 100644 --- a/templates/.smalltalkci/loading.dependent-sunit-extensions.ston +++ b/templates/.smalltalkci/loading.dependent-sunit-extensions.ston @@ -4,7 +4,8 @@ SmalltalkCISpec { #baseline : '{{BASELINE_NAME}}', #directory : '../source', #load : [ 'Dependent-SUnit-Extensions' ], - #platforms : [ #pharo ] + #platforms : [ #pharo ], + #failOn : [ #Warning ] } ], #testing : { diff --git a/templates/.smalltalkci/loading.deployment.ston b/templates/.smalltalkci/loading.deployment.ston index e5de824..667f57a 100644 --- a/templates/.smalltalkci/loading.deployment.ston +++ b/templates/.smalltalkci/loading.deployment.ston @@ -4,7 +4,8 @@ SmalltalkCISpec { #baseline : '{{BASELINE_NAME}}', #directory : '../source', #load : [ 'Deployment' ], - #platforms : [ #pharo ] + #platforms : [ #pharo ], + #failOn : [ #Warning ] } ], #testing : { diff --git a/templates/.smalltalkci/loading.development.ston b/templates/.smalltalkci/loading.development.ston index a5c8499..abb8dae 100644 --- a/templates/.smalltalkci/loading.development.ston +++ b/templates/.smalltalkci/loading.development.ston @@ -4,7 +4,8 @@ SmalltalkCISpec { #baseline : '{{BASELINE_NAME}}', #directory : '../source', #load : [ 'Development' ], - #platforms : [ #pharo ] + #platforms : [ #pharo ], + #failOn : [ #Warning ] } ], #testing : { diff --git a/templates/.smalltalkci/loading.tests.ston b/templates/.smalltalkci/loading.tests.ston index ce463bb..4ffc5f8 100644 --- a/templates/.smalltalkci/loading.tests.ston +++ b/templates/.smalltalkci/loading.tests.ston @@ -4,7 +4,8 @@ SmalltalkCISpec { #baseline : '{{BASELINE_NAME}}', #directory : '../source', #load : [ 'Tests' ], - #platforms : [ #pharo ] + #platforms : [ #pharo ], + #failOn : [ #Warning ] } ], #testing : { diff --git a/templates/.smalltalkci/loading.tools.ston b/templates/.smalltalkci/loading.tools.ston index a843b21..14fe33e 100644 --- a/templates/.smalltalkci/loading.tools.ston +++ b/templates/.smalltalkci/loading.tools.ston @@ -4,7 +4,8 @@ SmalltalkCISpec { #baseline : '{{BASELINE_NAME}}', #directory : '../source', #load : [ 'Tools' ], - #platforms : [ #pharo ] + #platforms : [ #pharo ], + #failOn : [ #Warning ] } ], #testing : { diff --git a/templates/.smalltalkci/unit-tests.ston b/templates/.smalltalkci/unit-tests.ston index 04496d5..13bd025 100644 --- a/templates/.smalltalkci/unit-tests.ston +++ b/templates/.smalltalkci/unit-tests.ston @@ -4,7 +4,8 @@ SmalltalkCISpec { #baseline : '{{BASELINE_NAME}}', #directory : '../source', #load : [ 'CI' ], - #platforms : [ #pharo ] + #platforms : [ #pharo ], + #failOn : [ #Warning ] } ], #testing : { diff --git a/templates/README.md b/templates/README.md index d3f5967..ec0c9bb 100644 --- a/templates/README.md +++ b/templates/README.md @@ -10,8 +10,8 @@ What is this thing? “the motto”, the goals, the vision. [![Markdown Lint](https://github.com/{{OWNER}}/{{REPO_NAME}}/actions/workflows/markdown-lint.yml/badge.svg)](https://github.com/{{OWNER}}/{{REPO_NAME}}/actions/workflows/markdown-lint.yml) [![GitHub release](https://img.shields.io/github/release/{{OWNER}}/{{REPO_NAME}}.svg)](https://github.com/{{OWNER}}/{{REPO_NAME}}/releases/latest) -[![Pharo 10](https://img.shields.io/badge/Pharo-10-informational)](https://pharo.org) [![Pharo 11](https://img.shields.io/badge/Pharo-11-informational)](https://pharo.org) +[![Pharo 12](https://img.shields.io/badge/Pharo-12-informational)](https://pharo.org) Why would I care about this thing? When to use it? For whom is it designed? When not to use it? diff --git a/templates/docs/how-to/how-to-load-in-pharo.md b/templates/docs/how-to/how-to-load-in-pharo.md index 85b0d20..da61a59 100644 --- a/templates/docs/how-to/how-to-load-in-pharo.md +++ b/templates/docs/how-to/how-to-load-in-pharo.md @@ -18,7 +18,7 @@ ## Using Iceberg -1. Download [pharo VM and image](https://pharo.org/download) +1. Download [Pharo VM and image](https://pharo.org/download) 2. Open your Pharo image 3. Open Iceberg 4. Click the *Add* repository button diff --git a/templates/docs/how-to/how-to-use-as-dependency-in-pharo.md b/templates/docs/how-to/how-to-use-as-dependency-in-pharo.md index 164f3b8..7e3bce1 100644 --- a/templates/docs/how-to/how-to-use-as-dependency-in-pharo.md +++ b/templates/docs/how-to/how-to-use-as-dependency-in-pharo.md @@ -3,7 +3,7 @@ In order to include **{{PROJECT_NAME}}** as part of your project, you should reference the package in your product baseline: -1. Define the {{PROJECT_NAME}} repository and version to be used, and the [baseline groups](../reference/Baseline-groups.md) +1. Define the {{PROJECT_NAME}} repository and version to be used, and the [loading targets](../reference/loading-targets.md) you want to depend on (usually it will be `Deployment`). If you're unsure on what to depend use the *Dependency Analyzer*