Skip to content

📝 Add a tutorial for parsing pipeline configs with FROM keys #4

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
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
17 changes: 17 additions & 0 deletions .github/workflows/cache-branch-binder-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Copyright (C) 2024 C-PAC Developers
# This file is part of C-PAC_tutorials.
# C-PAC_tutorials is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
# C-PAC_tutorials is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
# You should have received a copy of the GNU Lesser General Public License along with C-PAC. If not, see <https://www.gnu.org/licenses/>.
name: Cache branch Binder build
on: [push]

jobs:
Create-MyBinderOrg-Cache:
runs-on: ubuntu-latest
steps:
- name: Cache Binder build on mybinder.org
uses: jupyterhub/repo2docker-action@master
with:
NO_PUSH: true
MYBINDERORG_TAG: ${{ github.event.ref }}
28 changes: 28 additions & 0 deletions .github/workflows/link-pr-to-binder.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Copyright (C) 2024 C-PAC Developers
# This file is part of C-PAC_tutorials.
# C-PAC_tutorials is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
# C-PAC_tutorials is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
# You should have received a copy of the GNU Lesser General Public License along with C-PAC. If not, see <https://www.gnu.org/licenses/>.
name: Link PR to Binder
on:
pull_request:
types: [opened, reopened]

jobs:
Create-Binder-Badge:
runs-on: ubuntu-latest
steps:
- name: comment on PR with Binder link
uses: actions/github-script@v1
with:
github-token: ${{secrets.GITHUB_TOKEN}}
script: |
var BRANCH_NAME = process.env.BRANCH_NAME;
github.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: `[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/${context.repo.owner}/${context.repo.repo}/${BRANCH_NAME}) :point_left: Launch a binder notebook on this branch`
})
env:
BRANCH_NAME: ${{ github.event.pull_request.head.ref }}
7 changes: 7 additions & 0 deletions C-PAC-requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Copyright (C) 2024 C-PAC Developers
# This file is part of C-PAC_tutorials.
# C-PAC_tutorials is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
# C-PAC_tutorials is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
# You should have received a copy of the GNU Lesser General Public License along with C-PAC. If not, see <https://www.gnu.org/licenses/>.
CPAC @ git+https://github.com/FCP-INDI/C-PAC.git
ipykernel
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ You should have received a copy of the GNU Lesser General Public License along w

1. Check out a feature branch, and, if relevant, open an issue and/or a draft PR.
1. Create one or more notebooks, either in the top level of this repository (for a single-notebook tutorial) or in a subdirectory (for a tutorial with one or more notebooks).
1. If a notebook has any requirements that aren't already included in this repository's [`requirements.txt`](./requirements.txt), add them to that file.
1. If a notebook has any requirements that aren't already included in an environment in this repository's `requirements.txt`(./requirements.txt) or [`postBuild`](./postBuild), add them to the appropriate file, creating an environment in `postBuild` if necessary.
1. Make sure the `metadata.kernelspec` in each `.ipynb` file is configured to the correct kernel.
1. If any of the output cells in a notebook are too long, edit the JSON in the raw `*.ipynb` file to abridge or truncate the overlong output(s) to reduce the file size and emphasize the relevant portion(s) of the output. For example, several sections of [this output](https://github.com/FCP-INDI/C-PAC_tutorials/blob/ba88d7b91513bfba0d67eeae51fdaba29f84bb10/observed_usage.ipynb?short_path=b38a683#L24-L60) are replaced with `[…]`.
1. If you want the tutorial to appear in the user docs, add it to the TOC tree in [`index.rst`](./index.rst)
1. (optionally), add a download link to the top of your notebook.
Loading
Loading