Skip to content

Commit 77cd56c

Browse files
samtkaplansamtkaplan
committed
Merged PR 179758: Docs etc.
2 parents 2adddc8 + 9177e72 commit 77cd56c

20 files changed

+220
-630
lines changed

‎.github/workflows/CompatHelper.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: CompatHelper
2+
on:
3+
schedule:
4+
- cron: '00 00 * * *'
5+
workflow_dispatch:
6+
jobs:
7+
CompatHelper:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Pkg.add("CompatHelper")
11+
run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
12+
- name: CompatHelper.main()
13+
env:
14+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
15+
COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }} # optional
16+
run: julia -e 'using CompatHelper; CompatHelper.main()'

‎.github/workflows/Documentation.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
tags: '*'
8+
pull_request:
9+
10+
jobs:
11+
build:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v2
15+
- uses: julia-actions/setup-julia@latest
16+
with:
17+
version: '1.5'
18+
- name: Install dependencies
19+
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
20+
- name: Build and deploy
21+
env:
22+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
23+
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
24+
run: julia --project=docs/ docs/make.jl

‎.github/workflows/TagBot.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: TagBot
2+
on:
3+
schedule:
4+
- cron: 0 * * * *
5+
jobs:
6+
TagBot:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: JuliaRegistries/TagBot@v1
10+
with:
11+
token: ${{ secrets.GITHUB_TOKEN }}
12+
ssh: ${{ secrets.DOCUMENTER_KEY }}

‎.github/workflows/Tests.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Tests
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
test:
7+
runs-on: ${{ matrix.os }}
8+
strategy:
9+
matrix:
10+
julia-version: [1.0, 1.5]
11+
os: [ubuntu-latest, windows-latest, macOS-latest]
12+
steps:
13+
- uses: actions/checkout@v1.0.0
14+
- uses: julia-actions/setup-julia@latest
15+
with:
16+
version: ${{ matrix.julia-version }}
17+
- uses: julia-actions/julia-buildpkg@master
18+
- uses: julia-actions/julia-runtest@master
19+
- uses: julia-actions/julia-processcoverage@v1
20+
- uses: codecov/codecov-action@v1
21+
with:
22+
file: lcov.info

‎CONTRIBUTING.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# JetPack.jl contributor guidelines
2+
3+
## Issue reporting
4+
If you have found a bug in JetPack.jl or have any suggestions for changes to
5+
JetPack.jl functionality, please consider filing an issue using the GitHub
6+
issue tracker. Please do not forget to search for an existing issue
7+
which may already cover your suggestion.
8+
9+
## Contributing
10+
We try to follow GitHub flow (https://guides.github.com/introduction/flow/) for
11+
making changes to JetPack.jl.
12+
13+
Contributors retain copyright on their contributions, and the MIT license
14+
(https://opensource.org/licenses/MIT) applies to the contribution.
15+
16+
The basic steps to making a contribution are as follows, and assume some knowledge of
17+
git:
18+
1. fork the JetPack.jl repository
19+
2. create an appropriately titled branch for your contribution
20+
3. if applicable, add a unit-test to ensure the functionality of your contribution
21+
(see the `test` subfolder).
22+
4. run `]test JetPack` in the `test` folder
23+
5. make a pull-request
24+
6. have fun
25+
26+
## Coding conventions
27+
We try to follow the same coding conventions as https://github.com/JuliaLang/julia.
28+
This primarily means using 4 spaces to indent (no tabs). In addition, we make a
29+
best attempt to follow the guidelines in the style guide chapter of the julia
30+
manual: https://docs.julialang.org/en/v1/manual/style-guide/

‎LICENSE.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
The JetPack.jl package is licensed under the MIT "Expat" License:
2+
3+
> Copyright (c) 2020: Chevron U.S.A. Inc.
4+
>
5+
> Permission is hereby granted, free of charge, to any person obtaining
6+
> a copy of this software and associated documentation files (the
7+
> "Software"), to deal in the Software without restriction, including
8+
> without limitation the rights to use, copy, modify, merge, publish,
9+
> distribute, sublicense, and/or sell copies of the Software, and to
10+
> permit persons to whom the Software is furnished to do so, subject to
11+
> the following conditions:
12+
>
13+
> The above copyright notice and this permission notice shall be
14+
> included in all copies or substantial portions of the Software.
15+
>
16+
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17+
> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18+
> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19+
> IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20+
> CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21+
> TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22+
> SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎Project.toml‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
name = "JetPack"
22
uuid = "24ef3835-3876-54c3-8a7a-956cf69ca0b2"
3-
version = "0.6.0"
3+
version = "1.0.0"
44

55
[deps]
66
FFTW = "7a1cc6ca-52ef-59f5-83cd-3a7055c09341"
77
Jets = "2a57b368-ab28-5ba9-84aa-637fe7991822"
88
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
99
Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
1010

11+
[compat]
12+
julia = "1"
13+
FFTW = "1.2"
14+
Jets = "0.9, 1"
15+
1116
[extras]
1217
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
13-
DocumenterMarkdown = "997ab1e6-3595-5248-9280-8efb232c3433"
1418
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
1519

1620
[targets]
17-
docs = ["Documenter", "DocumenterMarkdown"]
21+
docs = ["Documenter"]
1822
test = ["Test"]

0 commit comments

Comments
 (0)