Skip to content

Commit

Permalink
📖 update the doc
Browse files Browse the repository at this point in the history
  • Loading branch information
tpoisot committed Dec 4, 2020
1 parent 469e280 commit d99be0c
Show file tree
Hide file tree
Showing 8 changed files with 35 additions and 21 deletions.
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ name: Bug report
about: Create a report to help us improve
title: ''
labels: bug, need-triage
assignees: ''

assignees: 'tpoisot'
---

**Describe the bug**
Expand Down
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement, need-triage
assignees: ''

assignees: 'tpoisot'
---

**Is your feature request related to a problem? Please describe.**
Expand Down
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/to-do.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: To-do
about: Short notes on development tasks
title: ''
labels: need-triage, to do
assignees: 'tpoisot'
---

**What to do?**

...

**Why?**

...

**## **Any ideas how?**

...
2 changes: 2 additions & 0 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ on:
push:
branches:
- main
tags:
- '*'
pull_request:

jobs:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/CompatHelper.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: CompatHelper

on:
schedule:
- cron: '00 00 * * *'
- cron: '0 * * * *'

jobs:
CompatHelper:
Expand Down
23 changes: 9 additions & 14 deletions .github/workflows/Documentation.yml
Original file line number Diff line number Diff line change
@@ -1,31 +1,26 @@
name: Documentation


on:
release:
type: [published,edited]
push:
branches:
- main
tags:
- '*'
tags: '*'
pull_request:

jobs:
docs:
name: Documentation
build:
name: "Build the documentation"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@v1
- uses: julia-actions/setup-julia@latest
with:
version: '1.5'
- uses: julia-actions/julia-buildpkg@latest
- run: |
julia --project=docs -e '
using Pkg
Pkg.develop(PackageSpec(path=pwd()))
Pkg.instantiate()'
- run: julia --project=docs docs/make.jl
- name: Install dependencies
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- name: Build and deploy
env:
GITHUB_TOKEN: ${{ secrets.TOKEN }}
GITHUB_TOKEN: ${{ secrets.TOKEN }} # For authentication with GitHub Actions token
run: julia --project=docs/ docs/make.jl
2 changes: 1 addition & 1 deletion .github/workflows/TagBot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ jobs:
steps:
- uses: JuliaRegistries/TagBot@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
token: ${{ secrets.TOKEN }}
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "NCBITaxonomy"
uuid = "f88b31d2-eb98-4433-b52d-2dd32bc6efce"
authors = ["Timothée Poisot <[email protected]>"]
version = "0.0.2"
version = "0.0.3"

[deps]
Arrow = "69666777-d1a9-59fb-9406-91d4454c9d45"
Expand Down

2 comments on commit d99be0c

@tpoisot
Copy link
Member Author

@tpoisot tpoisot commented on d99be0c Dec 5, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/25855

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.0.3 -m "<description of version>" d99be0c0c9311fa6bd17170d3e1f97ed6923544e
git push origin v0.0.3

Please sign in to comment.