Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MAINT] Update to latest MNE version #66

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
159 changes: 159 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
# See: https://circleci.com/blog/deploying-documentation-to-github-pages-with-continuous-integration/
version: 2.1

jobs:
docs-build:
machine:
image: ubuntu-2004:202111-01
steps:
- checkout

# restore cache from last build. Unless __init__.py has changed since then
- restore_cache:
keys:
- data-cache-5-{{ checksum "./mne_bids/__init__.py" }}

# Also restore pip cache to speed up installations
- restore_cache:
keys:
- pip-cache-1-{{ checksum "./test_requirements.txt" }}-{{ checksum "./doc/requirements.txt" }}

- run:
name: Setup Python3 environment
command: |
python3 -m venv /home/circleci/mne_bids_env
echo "source /home/circleci/mne_bids_env/bin/activate" >> $BASH_ENV

- run:
name: Install Python packages
command: |
python -m pip install --upgrade --progress-bar off pip
python -m pip install --upgrade --progress-bar off -r test_requirements.txt
python -m pip install --upgrade --progress-bar off -r doc/requirements.txt
python -m pip install --upgrade https://api.github.com/repos/mne-tools/mne-python/zipball/main
python -m pip install -e .

- run:
name: Build the documentation
command: |
make build-doc

- persist_to_workspace:
root: doc/_build
paths: html

- store_artifacts:
path: doc/_build/html/
destination: dev

# Store the data cache
- save_cache:
key: data-cache-5-{{ checksum "./mne_bids/__init__.py" }}
paths:
- ~/mne_data

# Store pip cache
- save_cache:
key: pip-cache-1-{{ checksum "./test_requirements.txt" }}-{{ checksum "./doc/requirements.txt" }}
paths:
- ~/.cache/pip

docs-deploy:
# will only be run on main branch
docker:
- image: cimg/node:lts
steps:
- checkout

- attach_workspace:
at: doc/_build

- run:
name: Install and configure dependencies
# do not update gh-pages above 3.0.0
# see: https://github.com/tschaub/gh-pages/issues/354
command: |
npm install [email protected]
git config --global user.email "[email protected]"
git config --global user.name "Circle Ci"

- add_ssh_keys:
fingerprints:
- "7f:74:00:17:2b:1a:7d:68:56:68:6b:64:b5:e0:7f:91"

- run:
# push built docs into the `dev` directory on the `gh-pages` branch
name: Deploy docs to gh-pages branch
command: node_modules/gh-pages/bin/gh-pages.js --dotfiles --message "doc updates [skip ci]" --dist doc/_build/html --dest ./dev


link-check:
machine:
image: ubuntu-2004:202111-01
steps:
- checkout

- attach_workspace:
at: doc/_build

- restore_cache:
keys:
- pip-cache-1-{{ checksum "./test_requirements.txt" }}-{{ checksum "./doc/requirements.txt" }}

- run:
name: Setup Python3 environment
command: |
python3 -m venv /home/circleci/mne_bids_env
echo "source /home/circleci/mne_bids_env/bin/activate" >> $BASH_ENV

- run:
name: Install Python packages
command: |
python -m pip install --upgrade --progress-bar off pip
python -m pip install --upgrade --progress-bar off -r test_requirements.txt
python -m pip install --upgrade --progress-bar off -r doc/requirements.txt
python -m pip install --upgrade --no-deps https://api.github.com/repos/mne-tools/mne-python/zipball/main
python -m pip install -e .

- run:
name: Check links
command: |
make -C doc linkcheck

workflows:
commit:
jobs:
- docs-build
- docs-deploy:
requires:
- docs-build
filters:
branches:
only: main

nightly:
jobs:
- docs-build

triggers:
- schedule:
cron: "0 4 * * *"
filters:
branches:
only:
- main

weekly:
jobs:
- docs-build
- link-check:
requires:
- docs-build

triggers:
- schedule:
cron: "0 4 * * 0"
filters:
branches:
only:
- main
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/blank.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
name: Blank issue
about: Create an issue without a template.

---
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Bug report
about: Tell us about broken, incorrect, or inconsistent behavior.

---

#### Describe the bug
〈Replace this text with a clear and concise description of the bug.〉


#### Steps to reproduce
〈Replace this text with a code snippet or minimal working example [MWE] to
replicate your problem, using one of the [datasets shipped with MNE-Python],
preferably the one called [sample].
If you can't replicate on a built-in dataset, provide also
a link to a small, anonymized portion of your data that does yield the error.〉

[MWE]: https://en.wikipedia.org/wiki/Minimal_Working_Example
[built-in datasets]: https://mne.tools/dev/overview/datasets_index.html
[sample]: https://mne.tools/dev/overview/datasets_index.html#sample


#### Expected results
〈Replace this text with a clear and concise description of what you expected to
happen.〉


#### Actual results
〈Replace this text with the actual output, traceback, screenshot, or other
description of the results.〉


#### Additional information
〈Replace this text with information about your system. For example through
using MNE-Python and running `mne.sys_info()` and pasting the output here.〉
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Feature request
about: Suggest an idea for this project.

---

If your issue is a usage question, please consider asking on the
[MNE Forum](https://mne.discourse.group) instead of opening an issue.

#### Describe the problem
Please provide a clear and concise description of the problem.


#### Describe your solution
A clear and concise description of what you want to happen.


#### Describe possible alternatives
A clear and concise description of any alternative solutions or features you have considered.


#### Additional context
Add any other context or screenshots about the feature request here.
19 changes: 19 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Thanks for contributing. If this is your first time,
make sure to read [contributing.md](https://github.com/mne-tools/mne-hcp/blob/main/CONTRIBUTING.md)

PR Description
--------------

Describe your PR here

Merge checklist
---------------

Maintainer, please confirm the following before merging:

- [ ] All comments resolved
- [ ] This is not your own PR
- [ ] All CIs are happy
- [ ] PR title starts with [MRG]
- [ ] [whats_new.rst](https://github.com/mne-tools/mne-hcp/blob/main/doc/whats_new.rst) is updated
- [ ] PR description includes phrase "closes <#issue-number>"
21 changes: 21 additions & 0 deletions .github/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Configuration for welcome - https://github.com/behaviorbot/welcome

# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome

# Comment to be posted to on first time issues
newIssueWelcomeComment: >
Hello! 👋 Thanks for opening your first issue here! ❤️ We will try to get back to you soon. 🚴🏽‍♂️

# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome

# Comment to be posted to on PRs from first time contributors in your repository
newPRWelcomeComment: >
Hello! 👋 Thanks for opening your first pull request here! ❤️ We will try to get back to you soon. 🚴🏽‍♂️

# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge

# Comment to be posted to on pull requests merged by a first time user
firstPRMergeComment: >
🎉 Congrats on merging your first pull request! 🥳 Looking forward to seeing more from you in the future! 💪

# It is recommended to include as many gifs and emojis as possible!
13 changes: 13 additions & 0 deletions .github/workflows/circle_artifacts.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
on: [status]
jobs:
circleci_artifacts_redirector_job:
runs-on: ubuntu-20.04
name: Run CircleCI artifacts redirector
steps:
- name: GitHub Action step
uses: larsoner/circleci-artifacts-redirector-action@master
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
artifact-path: 0/dev/index.html
circleci-jobs: docs-build
job-title: Check the rendered docs here!
Loading