diff --git a/.github/workflows/Compliance.yml.jinja b/.github/workflows/Compliance.yml.jinja index 41ac2c7f..68072a88 100644 --- a/.github/workflows/Compliance.yml.jinja +++ b/.github/workflows/Compliance.yml.jinja @@ -11,7 +11,7 @@ jobs: steps: - uses: actions/checkout@v3 with: - token: ${{ secrets.GITHUB_TOKEN }} + token: ${{ secrets.COMPLIANCE_PAT }} - uses: julia-actions/setup-julia@v1 with: version: "1" @@ -25,7 +25,7 @@ jobs: id: cpr uses: peter-evans/create-pull-request@v3 with: - token: ${{ secrets.GITHUB_TOKEN }} + token: ${{ secrets.COMPLIANCE_PAT }} commit-message: ":robot: COPIERTemplate.jl update" title: "[AUTO] COPIERTemplate.jl update" branch: auto-copier-template-update diff --git a/.github/workflows/Docs.yml.jinja b/.github/workflows/Docs.yml.jinja index 05baaf44..a95c6d19 100644 --- a/.github/workflows/Docs.yml.jinja +++ b/.github/workflows/Docs.yml.jinja @@ -32,7 +32,7 @@ jobs: - uses: actions/checkout@v2 - uses: julia-actions/setup-julia@v1 with: - version: '1' + version: "1" - run: | julia --project=docs -e ' using Pkg @@ -46,7 +46,7 @@ jobs: doctest({{ PackageName }})' - run: julia --project=docs docs/make.jl env: - JULIA_PKG_SERVER: '' + JULIA_PKG_SERVER: "" {% raw %}GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} {% endraw %} diff --git a/.github/workflows/Test.yml.jinja b/.github/workflows/Test.yml.jinja index 7caaa64c..1309f657 100644 --- a/.github/workflows/Test.yml.jinja +++ b/.github/workflows/Test.yml.jinja @@ -32,9 +32,9 @@ jobs: fail-fast: false matrix: version: - - '{{ JuliaMinVersion }}' - - '1' - - 'nightly' + - "{{ JuliaMinVersion }}" + - "1" + - "nightly" os: - ubuntu-latest {% if not AddMacToCI %}#{% endif %}- macOS-latest diff --git a/README.md b/README.md index 687c8cb2..2759d6b2 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,26 @@ I have done that in the past, but now I want even less manual intervention. ```bash git remote add origin https://github.com/UserName/PackageName.jl + ``` + +6. Create a `DOCUMENTER_KEY`, which will be used by for documentation purposes. + + ```bash + pkg> activate --temp + pkg> add DocumenterTools + julia> using DocumenterTools + julia> DocumenterTools.genkeys(user="UserName", repo="PackageName.jl") + ``` + + Follow the instruction in the terminal. + +7. Create a Personal Access Token to be used by the Compliance workflow. + + 1. Go to . + 2. Create a token with "Content", "Pull-request", and "Workflows" permissions. + 3. Copy the Token. + 4. Go to your YOUR_PACKAGE_URL/settings/secrets/actions. + 5. Create a "New repository secret" named `COMPLIANCE_PAT`. ## What are all these files? diff --git a/README.md.jinja b/README.md.jinja index dc600b5e..6e963f3d 100644 --- a/README.md.jinja +++ b/README.md.jinja @@ -1,7 +1,7 @@ # {{ PackageName }} -[![Stable Documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://{{ PackageOwner }}.github.io/{{ PackageName }}.jl/{{ PackageName }}.jl/stable) -[![In development documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://{{ PackageOwner }}.github.io/{{ PackageName }}.jl/{{ PackageName }}.jl/dev) +[![Stable Documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://{{ PackageOwner }}.github.io/{{ PackageName }}.jl/stable) +[![In development documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://{{ PackageOwner }}.github.io/{{ PackageName }}.jl/dev) [![Build Status](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/workflows/Test/badge.svg)](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/actions) [![Test workflow status](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/actions/workflows/Test.yml/badge.svg?branch=main)](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/actions/workflows/Test.yml?query=branch%3Amain) [![Lint workflow Status](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/actions/workflows/Lint.yml/badge.svg?branch=main)](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/actions/workflows/Lint.yml?query=branch%3Amain) diff --git a/docs/src/contributing.md.jinja b/docs/src/contributing.md.jinja index 1175c4fe..af864172 100644 --- a/docs/src/contributing.md.jinja +++ b/docs/src/contributing.md.jinja @@ -22,5 +22,5 @@ Otherwise, say what your proposed solution is and wait for a discussion around i > > Feel free to ping us after a few days if there are no responses. -If your solution involves code (or something that requires running the package locally), check the [developer documentation](developer). +If your solution involves code (or something that requires running the package locally), check the [developer documentation](developer.md). Otherwise, you can use the GitHub interface directly to create your pull request. diff --git a/docs/src/developer.md.jinja b/docs/src/developer.md.jinja index dc921a5b..7c4a99bf 100644 --- a/docs/src/developer.md.jinja +++ b/docs/src/developer.md.jinja @@ -1,6 +1,6 @@ # Developer documentation -If you haven't, please read the [Contributing guidelindes](CONTRIBUTING.md) first. +If you haven't, please read the [Contributing guidelindes](contributing.md) first. ## Linting and formatting