PkgTemplates.jl로 포장 제작

PkgTemplates.jl로 포장 제작

GiitHub과 연합한 포장의 제작 방법.GiitHub Action을 사용한 CI도 활용한다.
참조이 페이지 - Travis CI 대신 GiitHub Action을 사용합니다.
다음은 패키지 이름PkgTest.jl, GiitHub의 사용자 이름shinaoka이다.

필요 환경

PkgTemplates.jl

git에 GiitHub의 계정 이름을 미리 등록한다(이하 ssh접근이 가능하다고 가정한다).

$ git config --global github.user shinaoka

매크로 패키지 작성

다음은 Juria의 작업입니다.PkgTest라는 이름으로 GiitHub Action과 연합한 패키지를 제작한다.

julia> using PkgTemplates
julia> t = Template(;
           ssh=true,
           plugins=[
              GitHubActions(),
              Documenter{GitHubActions}(),
           ]
           ,
       )
julia> generate("PkgTest", t)

정상적으로 끝나면파일은 juria/dev/PkgTest 이하일 수 있습니다.

$ tree ~/.julia/dev/PkgTest/
~/.julia/dev/PkgTest/
├── LICENSE
├── Manifest.toml
├── Project.toml
├── README.md
├── docs
│   ├── Manifest.toml
│   ├── Project.toml
│   ├── make.jl
│   └── src
│       └── index.md
├── src
│   └── PkgTest.jl
└── test
    └── runtests.jl

4 directories, 10 files

Doocument 만들기

$ cd ~/.julia/dev/PkgTest/
$ julia --project=docs -e '
          using Pkg;
          Pkg.develop(PackageSpec(path=pwd()));
          Pkg.instantiate();
          include("docs/make.jl");
'

HTTP 서버를 시작하여 Build 문서를 확인합니다.
이번에 8001호 포트에서 시동이 걸렸다.

$ cd docs/build/
$ python3 -m http.server --bind localhost 8001

GiitHub의 push로 이동

PkgTemplates.jl이git init와 최초 제출이 끝난 상태가 되었습니다.또한origin도 이미 적절하게 설정되었다.

$ cd ~/.julia/dev/PkgTest
$ git log
commit 66af6ba96f733ade0939b3b17b237f92d746b205 (HEAD -> master)
Author: Hiroshi Shinaoka <[email protected]>
Date:   Thu Feb 4 09:57:29 2021 +0900

    Files generated by PkgTemplates
    
    PkgTemplates version: 0.7.13

commit 9986eb0515f1c2ec860ac4f4c176db13fd2ad3d2
Author: Hiroshi Shinaoka <[email protected]>
Date:   Thu Feb 4 09:57:08 2021 +0900

    Initial commit
$ git remote -v
origin  https://github.com/[email protected]/PkgTest.jl (fetch)
origin  https://github.com/[email protected]/PkgTest.jl (push)

GiitHub 페이지에 PkgTest.jl라는 이름으로 창고를 만든 후
보통이랑 똑같이push하면 돼요.

$ git push -u origin master

공개 문서

참조이 페이지로 차분을 중심으로 설명합니다.
PkgTemplates.Jl은 ~/.julia/dev/PkgTest/.github/workflows/ci.yml 에서 GiitHub Actions 테스트와 문서 구축에 사용할 설정을 생성했습니다.
설치 상세 정보는 Documeter.jl 문서를 참조하십시오.
먼저 SSH Depolykey를 만듭니다.참조이 페이지, 다음 명령을 실행합니다.
방문

pkg> add DocumenterTools
julia> using DocumenterTools
julia> DocumenterTools.genkeys(user="shinaoka", repo="PkgTest.jl")

https://github.com/shinaoka/PkgTest.jl/settings/keys에서 deploykeys에 Doocumenter의 이름으로 RSA 공개 키를 등록합니다.Allow write access에서 뽑혔습니다.다음은 참조GiitHub 설명서 창고에 기밀 키 등록(title은 DOCUMENTER KEY)
그리고 파일push를 적당히 업데이트하면 됩니다.조금만 기다리면 dev 이하 문서가 공개된 것을 알 수 있다.