Skip to content

Commit

Permalink
Update templates
Browse files Browse the repository at this point in the history
  • Loading branch information
gcotelli committed May 14, 2024
1 parent 10359f8 commit fc61b33
Show file tree
Hide file tree
Showing 16 changed files with 30 additions and 23 deletions.
7 changes: 5 additions & 2 deletions .github/workflows/markdown-lint.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
6 changes: 4 additions & 2 deletions .github/workflows/shellcheck.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion templates/.github/workflows/markdown-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 1 addition & 3 deletions templates/.github/workflows/pharo-loading-targets.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
name: Pharo Loading Targets

on:
- push
- pull_request
- workflow_dispatch

jobs:
loading-targets:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
smalltalk:
- Pharo64-10
- Pharo64-11
- Pharo64-12
load-target:
- development
- dependent-sunit-extensions
Expand Down
6 changes: 2 additions & 4 deletions templates/.github/workflows/pharo-unit-tests.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
name: Pharo Unit Tests

on:
- push
- pull_request
- workflow_dispatch

jobs:
unit-tests:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
smalltalk:
- Pharo64-10
- Pharo64-11
- Pharo64-12
name: Unit Tests - ${{ matrix.smalltalk }}
steps:
- uses: actions/checkout@v4
Expand All @@ -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 }}
2 changes: 1 addition & 1 deletion templates/.properties
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
#format : #tonel,
#format : 'tonel',
#version: '3.0'
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ SmalltalkCISpec {
#baseline : '{{BASELINE_NAME}}',
#directory : '../source',
#load : [ 'Dependent-SUnit-Extensions' ],
#platforms : [ #pharo ]
#platforms : [ #pharo ],
#failOn : [ #Warning ]
}
],
#testing : {
Expand Down
3 changes: 2 additions & 1 deletion templates/.smalltalkci/loading.deployment.ston
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ SmalltalkCISpec {
#baseline : '{{BASELINE_NAME}}',
#directory : '../source',
#load : [ 'Deployment' ],
#platforms : [ #pharo ]
#platforms : [ #pharo ],
#failOn : [ #Warning ]
}
],
#testing : {
Expand Down
3 changes: 2 additions & 1 deletion templates/.smalltalkci/loading.development.ston
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ SmalltalkCISpec {
#baseline : '{{BASELINE_NAME}}',
#directory : '../source',
#load : [ 'Development' ],
#platforms : [ #pharo ]
#platforms : [ #pharo ],
#failOn : [ #Warning ]
}
],
#testing : {
Expand Down
3 changes: 2 additions & 1 deletion templates/.smalltalkci/loading.tests.ston
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ SmalltalkCISpec {
#baseline : '{{BASELINE_NAME}}',
#directory : '../source',
#load : [ 'Tests' ],
#platforms : [ #pharo ]
#platforms : [ #pharo ],
#failOn : [ #Warning ]
}
],
#testing : {
Expand Down
3 changes: 2 additions & 1 deletion templates/.smalltalkci/loading.tools.ston
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ SmalltalkCISpec {
#baseline : '{{BASELINE_NAME}}',
#directory : '../source',
#load : [ 'Tools' ],
#platforms : [ #pharo ]
#platforms : [ #pharo ],
#failOn : [ #Warning ]
}
],
#testing : {
Expand Down
3 changes: 2 additions & 1 deletion templates/.smalltalkci/unit-tests.ston
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ SmalltalkCISpec {
#baseline : '{{BASELINE_NAME}}',
#directory : '../source',
#load : [ 'CI' ],
#platforms : [ #pharo ]
#platforms : [ #pharo ],
#failOn : [ #Warning ]
}
],
#testing : {
Expand Down
2 changes: 1 addition & 1 deletion templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down
2 changes: 1 addition & 1 deletion templates/docs/how-to/how-to-load-in-pharo.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion templates/docs/how-to/how-to-use-as-dependency-in-pharo.md
Original file line number Diff line number Diff line change
Expand Up @@ -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*
Expand Down

0 comments on commit fc61b33

Please sign in to comment.