Update IntegrationTest syntax (#56)

Author: mtfishman

Project.toml

@@ -1,7 +1,7 @@
 name = "ITensorPkgSkeleton"
 uuid = "3d388ab1-018a-49f4-ae50-18094d5f71ea"
 authors = ["ITensor developers <support@itensor.org> and contributors"]
-version = "0.2.6"
+version = "0.3.0"
 
 [deps]
 DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"

src/ITensorPkgSkeleton.jl

@@ -96,7 +96,6 @@ end
 This processes inputs like:
 ```julia
 ITensorPkgSkeleton.generate("NewPkg"; downstreampkgs=["ITensors"])
-ITensorPkgSkeleton.generate("NewPkg"; downstreampkgs=[(ghuser="ITensor", repo="ITensors")])
 ```
 =#
 function format_downstreampkgs(user_replacements)
@@ -107,16 +106,8 @@ function format_downstreampkgs(user_replacements)
     return delete(user_replacements, :downstreampkgs)
   end
   downstreampkgs = ""
-  for ghuser_and_or_repo in user_replacements.downstreampkgs
-    ghuser, repo = if ghuser_and_or_repo isa AbstractString
-      # Only the repo was passed as a standalone value.
-      default_ghuser(), ghuser_and_or_repo
-    else
-      # The user and repo were passed in a NamedTuple,
-      # or just the repo was passed in a NamedTuple.
-      get(ghuser_and_or_repo, :ghuser, default_ghuser()), ghuser_and_or_repo.repo
-    end
-    downstreampkgs *= "           - \'$(ghuser)/$(repo).jl\'\n"
+  for pkg in user_replacements.downstreampkgs
+    downstreampkgs *= "           - \'$(pkg)\'\n"
   end
   # Remove extraneous trailing newline character.
   downstreampkgs = chop(downstreampkgs)
@@ -208,8 +199,6 @@ julia> ITensorPkgSkeleton.generate("NewPkg"; path=mktempdir(), ignore_templates=
 julia> ITensorPkgSkeleton.generate("NewPkg"; path=mktempdir(), ghuser="MyOrg");
 
 julia> ITensorPkgSkeleton.generate("NewPkg"; path=mktempdir(), downstreampkgs=["ITensors", "ITensorMPS"]);
-
-julia> ITensorPkgSkeleton.generate("NewPkg"; path=mktempdir(), downstreampkgs=[(ghuser="ITensor", repo="ITensors")]);
 ```
 
 # Arguments
@@ -221,7 +210,7 @@ julia> ITensorPkgSkeleton.generate("NewPkg"; path=mktempdir(), downstreampkgs=[(
 - `path::AbstractString`: Path where the package will be generated. Defaults to the [development directory](https://pkgdocs.julialang.org/v1/api/#Pkg.develop), i.e. `$(default_path())`.
 - `templates`: A list of templates to use. Select a subset of `ITensorPkgSkeleton.all_templates() = $(all_templates())`. Defaults to `ITensorPkgSkeleton.default_templates() = $(default_templates())`.
 - `ignore_templates`: A list of templates to ignore. This is the same as setting `templates=setdiff(templates, ignore_templates)`.
-- `downstreampkgs`: Specify the downstream packages that depend on this package. Setting this will create a workflow where the downstream tests will be run alongside the tests for this package in Github Actions to ensure that changes to your package don't break the specified downstream packages. Specify it as a list of packages, for example `["DownstreamPkg1", "DownstreamPkg2"]`, which assumes the packages are in the `$(default_ghuser())` organization. Alternatively, specify the organization with `[(ghuser="Org1", repo="DownstreamPkg1"), (ghuser="Org2", repo="DownstreamPkg2")]`; . Defaults to an empty list.
+- `downstreampkgs`: Specify the downstream packages that depend on this package. Setting this will create a workflow where the downstream tests will be run alongside the tests for this package in Github Actions to ensure that changes to your package don't break the specified downstream packages. Defaults to an empty list.
 - `uuid`: Replaces `{UUID}` in the template. Defaults to the existing UUID in the `Project.toml` if the path points to an existing package, otherwise generates one randomly with `UUIDs.uuid4()`.
 - `year`: Replaces `{YEAR}` in the template. Year the package/repository was created. Defaults to the current year.
 """

templates/downstreampkgs/.github/workflows/IntegrationTest.yml

@@ -16,9 +16,9 @@ jobs:
     name: "IntegrationTest"
     strategy:
        matrix:
-         repo:
+         pkg:
 {DOWNSTREAMPKGS}
     uses: "ITensor/ITensorActions/.github/workflows/IntegrationTest.yml@main"
     with:
       localregistry: "https://github.com/ITensor/ITensorRegistry.git"
-      repo: "${{ matrix.repo }}"
+      pkg: "${{ matrix.pkg }}"

test/test_basics.jl

@@ -24,8 +24,7 @@ using Test: @test, @testset
   end
   @testset "generate with downstream tests" begin
     for templates in (ITensorPkgSkeleton.default_templates(), [])
-      for (downstreampkgs, ghuser) in
-          ((["DownstreamPkg"], "ITensor"), ([(ghuser="Org", repo="DownstreamPkg")], "Org"))
+      for downstreampkgs in (["DownstreamPkg"],)
         path = mktempdir()
         ITensorPkgSkeleton.generate("NewPkg"; path, templates, downstreampkgs)
         @test isdir(joinpath(path, "NewPkg"))
@@ -36,7 +35,7 @@ using Test: @test, @testset
         @test open(
           joinpath(path, "NewPkg", ".github", "workflows", "IntegrationTest.yml"), "r"
         ) do io
-          return contains(read(io, String), "- '$(ghuser)/DownstreamPkg.jl'")
+          return contains(read(io, String), "- 'DownstreamPkg'")
         end
         for dir in setdiff(pkgdirs, [".github", ".github/workflows"])
           @test isdir(joinpath(path, "NewPkg", dir)) == !isempty(templates)