JuliaCI/PkgTemplates.jl

Custom registry support for GitHub based CI

Open

#109 opened on Nov 12, 2019

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Julia (697 stars) (112 forks)batch import
Julia v1.0help wantednew-feature

Description

As discussed in https://github.com/invenia/PkgTemplates.jl/issues/96, it would be great if the Github CI plugin would support custom registries as well.

Basically the latter simply requires an extra step in the workflow:

- name: Add CustomRegistry
  run: julia -e 'using Pkg; Pkg.Registry.add(Pkg.RegistrySpec(url="http://github.com/JuliaRegistries/General")); Pkg.Registry.add(Pkg.RegistrySpec(url="http://github.com/owner/CustomRegistry")); Pkg.Registry.status()'
  shell: bash

Note that one has to set shell: bash as otherwise Windows runs will fail. Also, one cannot test on Julia < 1.1 this way, since, as has been pointed out by @DilumAluthge in #96, the Pkg.Registry stuff requires Julia >= 1.1.

(See here for a working example.)

Contributor guide

Tech stack
None
Domain
ci cd
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Julia >=1.1GitHub Actions YAML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the GitHub CI workflow template in the repository, likely under `.github/workflows/`. Add a step to add custom registries using `Pkg.Registry.add` before the main test workflow. Refer to the provided example and the discussion in issue #96 for details on Julia version compatibility and Windows shell requirements.