Compare commits

..

3 Commits

Author SHA1 Message Date
Sascha Mann
0fb79b8f6a Improve deprecation warning 2023-03-15 23:05:59 +01:00
Sascha Mann
a29dc8944a Remove linebreaks 2023-03-15 23:04:45 +01:00
Sascha Mann
e4bba91d95 Deprecate @master
Turns out GitHub doesn't forward @master to @main
2023-03-15 22:59:44 +01:00
8 changed files with 83 additions and 224 deletions

View File

@@ -1,11 +0,0 @@
version: 2
updates:
- package-ecosystem: github-actions
directory: /
schedule:
interval: monthly
open-pull-requests-limit: 99
labels:
- dependencies
- github-actions

33
.github/workflows/backup.yml vendored Normal file
View File

@@ -0,0 +1,33 @@
name: Backup
on:
schedule:
- cron: '5 4 * * 0'
workflow_dispatch:
jobs:
backup:
runs-on: ubuntu-20.04
steps:
- name: Configure cache
uses: actions/cache@v2
with:
path: |
${{ env.GITHUB_WORKSPACE }}
~/.cache/restic
key: ${{ runner.os }}
- name: Install the correct Python version
uses: actions/setup-python@v2
with:
python-version: '3.x'
- name: Run backup action
uses: julia-actions/restic-action@main
env: # Options: https://restic.readthedocs.io/en/latest/040_backup.html#environment-variables
RESTIC_REPOSITORY: b2:${{ secrets.B2_BUCKET }}:${{ github.repository }}
RESTIC_PASSWORD: ${{ secrets.RESTIC_PASSWORD }}
B2_ACCOUNT_ID: ${{ secrets.B2_ACCOUNT_ID }}
B2_ACCOUNT_KEY: ${{ secrets.B2_ACCOUNT_KEY }}

View File

@@ -7,24 +7,17 @@ on:
- "master"
pull_request:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
test:
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
runs-on: ${{ matrix.os }}
timeout-minutes: 5
strategy:
fail-fast: false
matrix:
version:
- "1.0"
- "lts"
- "1" # automatically expands to the latest stable 1.x release of Julia
- "pre"
- "nightly"
- nightly
os:
- ubuntu-latest
- macOS-latest
@@ -32,26 +25,14 @@ jobs:
arch:
- x64
- x86
- aarch64
# 32-bit Julia binaries are not available on macOS
# macOS runners use Apple Silicon (ARM64)
exclude:
- os: macOS-latest
arch: x86
- os: macOS-latest
arch: x64
- os: ubuntu-latest
arch: aarch64
- os: windows-latest
arch: aarch64
# Julia 1.0 didn't support ARM64
- os: macOS-latest
arch: aarch64
version: "1.0"
steps:
- name: Checkout Example.jl
uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
uses: actions/checkout@v2
with:
repository: julia-actions/Example.jl
@@ -60,29 +41,35 @@ jobs:
shell: bash
- name: Checkout julia-runtest
uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
uses: actions/checkout@v2
with:
path: ./.github/actions/julia-runtest
- uses: julia-actions/setup-julia@5c9647d97b78a5debe5164e9eec09d653d29bd71 # v2.6.1
- uses: julia-actions/setup-julia@v1
with:
version: ${{ matrix.version }}
arch: ${{ matrix.arch }}
- uses: julia-actions/cache@d10a6fd8f31b12404a54613ebad242900567f2b9 # v2.1.0
- uses: actions/cache@v1
env:
cache-name: cache-artifacts
with:
path: ~/.julia/artifacts
key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
restore-keys: |
${{ runner.os }}-test-${{ env.cache-name }}-
${{ runner.os }}-test-
${{ runner.os }}-
- uses: julia-actions/julia-buildpkg@e3eb439fad4f9aba7da2667e7510e4a46ebc46e1 # v1.7.0
- uses: julia-actions/julia-buildpkg@v1
- uses: ./.github/actions/julia-runtest
- uses: julia-actions/julia-processcoverage@03114f09f119417c3242a9fb6e0b722676aedf38
- uses: julia-actions/julia-processcoverage@v1
- uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # v5.5.2
- uses: codecov/codecov-action@v1
with:
files: lcov.info
token: ${{ secrets.CODECOV_TOKEN }}
fail-ci-if-error: true
file: lcov.info
- name: Verify that test output file exists
run: test -f "$HOME/julia-runtest"

View File

@@ -7,24 +7,17 @@ on:
- "master"
pull_request:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
test:
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
runs-on: ${{ matrix.os }}
timeout-minutes: 5
strategy:
fail-fast: false
matrix:
version:
- "1.6"
- "lts"
- "1" # automatically expands to the latest stable 1.x release of Julia
- "pre"
- "nightly"
- nightly
os:
- ubuntu-latest
- macOS-latest
@@ -32,32 +25,29 @@ jobs:
arch:
- x64
- x86
- aarch64
# 32-bit Julia binaries are not available on macOS
# macOS runners use Apple Silicon (ARM64)
exclude:
- os: macOS-latest
arch: x86
- os: macOS-latest
arch: x64
- os: ubuntu-latest
arch: aarch64
- os: windows-latest
arch: aarch64
# Julia 1.6 didn't support ARM64
- os: macOS-latest
arch: aarch64
version: "1.6"
steps:
- name: Checkout julia-runtest
uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
uses: actions/checkout@v2
- uses: julia-actions/setup-julia@5c9647d97b78a5debe5164e9eec09d653d29bd71 # v2.6.1
- uses: julia-actions/setup-julia@v1
with:
version: ${{ matrix.version }}
arch: ${{ matrix.arch }}
- uses: julia-actions/cache@d10a6fd8f31b12404a54613ebad242900567f2b9 # v2.1.0
- uses: actions/cache@v1
env:
cache-name: cache-artifacts
with:
path: ~/.julia/artifacts
key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
restore-keys: |
${{ runner.os }}-test-${{ env.cache-name }}-
${{ runner.os }}-test-
${{ runner.os }}-
- run: julia --color=yes --check-bounds=yes test_logger_tests.jl

View File

@@ -11,24 +11,19 @@ An example workflow that uses this action might look like this:
```yaml
name: Run tests
on:
on:
push:
branches:
- master
- main
pull_request:
# needed to allow julia-actions/cache to delete old caches that it has created
permissions:
actions: write
contents: read
jobs:
test:
runs-on: ${{ matrix.os }}
strategy:
matrix:
julia-version: ['lts', '1', 'pre']
julia-version: ['1.0', '1', 'nightly']
julia-arch: [x64, x86]
os: [ubuntu-latest, windows-latest, macOS-latest]
exclude:
@@ -36,23 +31,20 @@ jobs:
julia-arch: x86
steps:
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@v2
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@v1
with:
version: ${{ matrix.julia-version }}
arch: ${{ matrix.julia-arch }}
- uses: julia-actions/cache@v2
- uses: julia-actions/julia-buildpkg@v1
- uses: julia-actions/julia-runtest@v1
# with:
# annotate: true
with:
annotate: true
```
You can add this workflow to your repository by placing it in a file called `test.yml` in the folder `.github/workflows/`. [More info here](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions).
Here, setting `annotate: true` causes GitHub "annotations" to appear when reviewing the PR, pointing to failing tests, if any.
This functionality is only enabled on Julia 1.8 (even if `annotate` is set to `true`), since currently it does not work on other Julia versions (see [#76](https://github.com/julia-actions/julia-runtest/issues/76)).
By default, `annotate` is set to false, but that may change in future releases of this action.
### Prefixing the Julia command
@@ -72,7 +64,7 @@ If you only want to add this prefix on certain builds, you can [include addition
fail-fast: false
matrix:
os: [ubuntu-latest, windows-latest, macOS-latest]
version: ['lts', '1', 'pre']
version: ['1.0', '1', 'nightly']
arch: [x64]
include:
- os: ubuntu-latest
@@ -87,44 +79,6 @@ If you only want to add this prefix on certain builds, you can [include addition
This will add the prefix `xvfb-run` to all builds where the `os` is `ubuntu-latest`.
### Pass Arguments to Test Suite
You can pass arguments from the workflow specification to the test script via the `test_args` parameter.
This is useful, for example, to specify separate workflows for fast and slow tests, or conditionally enabling quality assurance tests.
The functionality can be incorporated as follows:
```yaml
# ...
steps:
# ...
- uses: julia-actions/julia-runtest@v1
with:
test_args: 'slow_tests "quality assurance"'
# ...
```
The value of `test_args` can be accessed in `runtest.jl` via the `ARGS` variable. An example for `runtest.jl` is given below.
```julia
using Test
# ...
# run fast tests by default
include("fast_tests.jl")
if "slow_tests" in ARGS
# run slow tests
include("slow_tests.jl")
end
if "quality assurance" in ARGS
# run quality assurance tests
include("qa.jl")
end
```
### Registry flavor preference

View File

@@ -32,26 +32,21 @@ inputs:
annotate:
description: 'Whether or not to attempt to create GitHub annotations to show test failures inline. Only effective on Julia 1.8+.'
default: 'false'
compiled_modules:
description: 'Whether to run tests with `compiled-modules`. For possible values, refer to https://docs.julialang.org/en/v1/manual/command-line-interface/#command-line-interface'
default: 'yes'
allow_reresolve:
description: 'Whether to allow re-resolving of package versions in the test environment. Only effective on Julia 1.9+. Options: true | false. Default value: true'
default: 'true'
test_args:
description: 'Arguments string that is passed on to test.'
default: ''
runs:
using: 'composite'
steps:
- name: 'DEPRECATION WARNING: julia-actions/julia-runtest@master will no longer receive updates and will start to error in the future. Please use version tags like julia-actions/julia-runtest@v1 or commit SHAs in your workflows!'
run: |
echo "::warning title=DEPRECATION WARNING::julia-actions/julia-runtest@master will no longer receive updates and will start to error in the future. Please use version tags like julia-actions/julia-runtest@v1 or commit SHAs in your workflows!"
echo "# :warning: DEPRECATION WARNING :warning: julia-actions/julia-runtest@master will no longer receive updates and will start to error in the future. Please use version tags like julia-actions/julia-runtest@v1 or commit SHAs in your workflows!" >> $GITHUB_STEP_SUMMARY
shell: bash
- name: Set and export registry flavor preference
run: echo "JULIA_PKG_SERVER_REGISTRY_PREFERENCE=${JULIA_PKG_SERVER_REGISTRY_PREFERENCE:-eager}" >> ${GITHUB_ENV}
shell: bash
- name: Install dependencies in their own (shared) environment
run: |
# Functionality only currently works on a narrow range of Julia versions... see #76
if v"1.8pre" < VERSION < v"1.9.0-beta3"
if VERSION > v"1.8pre"
using Pkg
Pkg.activate("tests-logger-env"; shared=true)
Pkg.add(Pkg.PackageSpec(name="GitHubActions", version="0.1"))
@@ -60,7 +55,7 @@ runs:
if: inputs.annotate == 'true'
- run: |
# The Julia command that will be executed
julia_cmd=( julia --color=yes --inline=${{ inputs.inline }} --project=${{ inputs.project }} -e 'include(joinpath(ENV["GITHUB_ACTION_PATH"], "test_harness.jl"))' -- ${{inputs.test_args}} )
julia_cmd=( julia --color=yes --depwarn=${{ inputs.depwarn }} --inline=${{ inputs.inline }} --project=${{ inputs.project }} -e 'include(joinpath(ENV["GITHUB_ACTION_PATH"], "test_harness.jl"))' )
# Add the prefix in front of the command if there is one
prefix=( ${{ inputs.prefix }} )
@@ -75,6 +70,3 @@ runs:
COVERAGE: ${{ inputs.coverage }}
FORCE_LATEST_COMPATIBLE_VERSION: ${{ inputs.force_latest_compatible_version }}
CHECK_BOUNDS: ${{ inputs.check_bounds }}
COMPILED_MODULES: ${{ inputs.compiled_modules }}
ALLOW_RERESOLVE: ${{ inputs.allow_reresolve }}
DEPWARN: ${{ inputs.depwarn }}

View File

@@ -6,10 +6,7 @@ include(joinpath(@__DIR__, "autodetect-dependabot.jl"))
function kwargs(; coverage,
force_latest_compatible_version,
allow_reresolve,
julia_args::AbstractVector{<:AbstractString}=String[],
test_args::AbstractVector{<:AbstractString}=String[],
)
julia_args::AbstractVector{<:AbstractString}=String[])
if coverage isa AbstractString
coverage = parse(Bool, coverage)
end
@@ -54,14 +51,6 @@ function kwargs(; coverage,
kwargs_dict[:force_latest_compatible_version] = force_latest_compatible_version::Bool
end
if VERSION >= v"1.9"
kwargs_dict[:allow_reresolve] = parse(Bool, allow_reresolve)
end
if !isempty(test_args)
kwargs_dict[:test_args] = test_args
end
return kwargs_dict
end

View File

@@ -2,90 +2,15 @@ import Pkg
include("kwargs.jl")
kwargs = Kwargs.kwargs(; coverage=ENV["COVERAGE"],
force_latest_compatible_version=ENV["FORCE_LATEST_COMPATIBLE_VERSION"],
allow_reresolve=ENV["ALLOW_RERESOLVE"],
julia_args=[string("--check-bounds=", ENV["CHECK_BOUNDS"]),
string("--compiled-modules=", ENV["COMPILED_MODULES"]),
# Needs to be done via `julia_args` to ensure `depwarn: no` is respected:
# https://github.com/JuliaLang/Pkg.jl/pull/1763#discussion_r406819660
string("--depwarn=", ENV["DEPWARN"]),],
test_args=ARGS,
)
julia_args=[string("--check-bounds=", ENV["CHECK_BOUNDS"])])
kwargs_reprs = map(kv -> string(kv[1], "=", repr(kv[2])), collect(kwargs))
kwargs_repr = join(kwargs_reprs, ", ")
# Warn if running on a merge commit (different from branch HEAD)
git_note = ""
if haskey(ENV, "GITHUB_SHA") && get(ENV, "GITHUB_EVENT_NAME", "") == "pull_request" && haskey(ENV, "GITHUB_HEAD_REF")
# For pull_request events, GITHUB_SHA is the merge commit, not the PR head commit
try
merge_commit = ENV["GITHUB_SHA"]
pr_branch = ENV["GITHUB_HEAD_REF"]
base_branch_name = get(ENV, "GITHUB_BASE_REF", "")
# Check if there's any difference between the merge commit and the PR head
# In GitHub Actions, HEAD^2 is the PR head (second parent of merge commit)
# First check if HEAD^2 exists (i.e., this is actually a merge commit)
if success(`git rev-parse --verify --quiet HEAD^2`)
# Compare tree hashes to check if content actually differs
merge_tree = chomp(read(`git rev-parse HEAD^\{tree\}`, String))
pr_tree = chomp(read(`git rev-parse HEAD^2^\{tree\}`, String))
has_diff = merge_tree != pr_tree
else
# Not a merge commit, so no difference to report
has_diff = false
end
if has_diff
base_branch = isempty(base_branch_name) ? "the base branch" : "'$base_branch_name'"
global git_note = """
│ Note: This is being run on merge commit $merge_commit (merge of PR branch '$pr_branch' into $base_branch).
│ The content differs from the actual commit on your PR branch.
│ To reproduce locally, update your branch with $base_branch first.
"""
end
catch e
@warn "Error while checking git diff" exception=(e, catch_backtrace())
end
end
print("""
│ To reproduce this CI run locally run the following from the same repository state on julia version $VERSION:
│ `import Pkg; Pkg.test(;$kwargs_repr)`
""")
print(git_note)
if parse(Bool, ENV["ANNOTATE"]) && v"1.8pre" < VERSION < v"1.9.0-beta3"
if parse(Bool, ENV["ANNOTATE"]) && VERSION > v"1.8pre"
push!(LOAD_PATH, "@tests-logger-env") # access dependencies
using GitHubActions, Logging
global_logger(GitHubActionsLogger())
include("test_logger.jl")
pop!(LOAD_PATH)
try
TestLogger.test(; kwargs...)
catch e
if e isa Pkg.Types.PkgError
# don't show the stacktrace of the test harness because it's not useful
showerror(stderr, e)
exit(1)
else
rethrow()
end
end
TestLogger.test(; kwargs...)
else
try
Pkg.test(; kwargs...)
catch e
if e isa Pkg.Types.PkgError
# don't show the stacktrace of the test harness because it's not useful
showerror(stderr, e)
exit(1)
else
rethrow()
end
end
Pkg.test(; kwargs...)
end