<section data-background-image="https://raw.githubusercontent.com/MaxUlysse/maxulysse.github.io/main/assets/img/svg/green_white_bg.svg" data-background-opacity=0.9 >
<a href="https://www.nf-co.re"><img src="https://raw.githubusercontent.com/nf-core/logos/master/byte-size-logos/bytesize-darkbg.svg" width="65%"><img></a>
# Bytesize \#15: Pipeline first release
Alexander Peltzer / <img src="https://openmoji.org/data/color/svg/E040.svg" width=50> @alex_peltzer / <img src="https://openmoji.org/data/color/svg/E045.svg" width=50> @apeltzer
Boehringer Ingelheim Pharma GmbH & Co KG
---
# Overview
- :question: Steps required to release a pipeline on nf-core
- :bulb: How to make a first release of a pipeline
---
# Prerequisites
- :handshake: You joined the community - [Join here](https://nf-co.re/join)
- :page_with_curl: You created a pipeline from the template - [How To](https://nf-co.re/developers/adding_pipelines#create-a-pipeline-from-the-template)
- :thinking_face: You added some test data - [How?](https://nf-co.re/developers/adding_pipelines#add-some-test-data)
- :100: You added the pipeline to the nf-core organization - [See here](https://nf-co.re/developers/adding_pipelines#adding-your-pipeline-to-the-nf-core-organisation)
---
# First steps :arrow_forward:
- All CI tests on `dev` should be passing
- Check for `nf-core lint` warnings and fix them
- Make `master` [the default branch again](https://docs.github.com/en/github/administering-a-repository/managing-branches-in-your-repository/changing-the-default-branch)
---
# Use the tools 
- Bump version numbers on `dev`, e.g. `nf-core bump-versions 1.0.0`
- Update `CHANGELOG.md`, follow other [examples](https://github.com/nf-core/sarek/blob/master/CHANGELOG.md)
- [Open the first Pull Request (PR)](https://help.github.com/en/articles/creating-a-pull-request) from `dev` to `master` :crossed_fingers:
> :information_source: Semantic Versioning https://semver.org/
> :information_source: https://www.codenamegenerator.com/
---
# Review Phase (Fake Pull Request) 
- :open_book: Thorough core pipeline review
- Fake pull request review against the first commit in the pipeline
- Ping `@core-team` or write in `#request-review`, `#new-pipelines` on slack to get people to have a look
- Fix all the :bug:s!
- Once Fake PR is reviewed, we'll close it for you :rolled_up_newspaper:
---
# Release :octopus:
- Once `dev` :arrow_right: `master` :heavy_check_mark: :heavy_check_mark: , you can merge to `master`
- Then create a [new release](https://help.github.com/en/articles/creating-releases)
:warning: Use same version as in `nf-core bump-version` e.g. 1.0.0 - :no_entry: `v` or `V` prefix for versions!
:information_source: CodeName is a good idea for the description
---
# After your very first release :heavy_check_mark:
- Ask someone from `@core-team` to get you the DOI that allows you to `Cite all versions` of your pipeline
- Remove `TODO` from main `Readme.md` and add that DOI there - you can for once commit this (and only this!) to the `master` branch
- You can optionally add a Zenodo Badge [](https://doi.org/10.5281/zenodo.2634132), check out [nf-core/atacseq](https://github.com/nf-core/atacseq/blob/fa1e3f8993cd20e249b9df09d29c5498eff311d2/README.md)
---
# After release :checkered_flag:
- `bump-version` on `dev` branch again to e.g. `1.0.1dev`
- Update `CHANGELOG.md`, new section for `1.0.1dev`
:information_source: (if on fork): Open PR to `dev` in nf-core/yourpipeline from your fork with the above
---
# Continue reading 
- Subsequent Releases - [Tips & Tricks](https://nf-co.re/developers/adding_pipelines#subsequent-releases)
- Adding features to [existing pipelines](https://nf-co.re/developers/adding_pipelines#adding-new-pipeline-features-to-existing-pipelines)
- Live pipeline release of [nf-core/nanoseq](https://youtu.be/Bl0txLqI-hI?t=2563) from the Crick 2020 Hackathon in London
---
## Need help?
[Making the first release](https://nf-co.re/developers/adding_pipelines#making-the-first-release)
[Release Checklist](https://nf-co.re/developers/release_checklist.md)
Chat: [`https://nf-co.re/join`](https://nf-co.re/join) <img src="https://cdn.brandfolder.io/5H442O3W/at/pl546j-7le8zk-6gwiyo/Slack_Mark.svg" width=7.5%></img>`#new-pipelines`
<div style="margin-top:0.1em"> </div>
<p align="center">
Follow nf-core on
<a href="https://www.twitter.com/nf_core"><img src="https://openmoji.org/data/color/svg/E040.svg" width=6%></a>
<a href="https://github.com/nf-core"><img src="https://openmoji.org/data/color/svg/E045.svg" width=6%></a>
<a href="https://www.youtube.com/c/nf-core"><img src="https://openmoji.org/data/color/svg/E044.svg" width=6%></a>
</a>
</p>
<a href="https://nf-co.re/" style="color: #000000; font-family:Monaco, monospace; font-weight:bold;">https://nf-co.re/</a>
<div style="display: flex; justify-content: space-evenly; align-items:center;">
<img src="https://chanzuckerberg.com/wp-content/themes/czi/img/logo.svg" width=15%>
<div style="font-style:italic; font-size: 0.5em; color: #666;">Icons:<br><a href="https://openmoji.org">openmoji.org</a></div></div>
<section .slide: data-background-image="https://raw.githubusercontent.com/MaxUlysse/maxulysse.github.io/master/assets/img/svg/green_white_bg.svg" data-background-opacity=0.9 >
<style>
.reveal section img { background:none; border:none; box-shadow:none; }
body {
background-image: url(https://raw.githubusercontent.com/nf-core/logos/main/nf-core-logos/nf-core-logo-square.svg);
background-size: 7.5%;
background-repeat: no-repeat;
background-position: 3% 96%;
background-color: #181a1b;
}
.reveal body {
font-family: 'Roboto', sans-serif;
font-weight: 300;
color: white;
}
.reveal p {
font-family: 'Roboto', sans-serif;
font-weight: 300;
color: white;
}
.reveal h1 {
font-family: 'Roboto', sans-serif;
font-style: bold;
font-weight: 400;
color: white;
font-size: 62px;
}
.reveal h2 {
font-family: 'Roboto', sans-serif;
font-weight: 300;
color: white;
}
.reveal h3 {
font-family: 'Roboto', sans-serif;
font-style: italic;
font-weight: 300;
color: white;
}
.reveal p {
font-family: 'Roboto', sans-serif;
font-weight: 300;
color: white;
}
.reveal li {
font-family: 'Roboto', sans-serif;
font-weight: 300;
color: white;
}
.reveal pre {
background-color: #272822 !important;
display: inline-block;
border-radius: 7px;
color: #aaaba9;
}
.reveal pre code {
color: #eeeeee;
background-color: #272822;
font-size: 100%;
}
.reveal code {
background-color: #272822;
font-size: 75%;
}
.reveal .progress {
color: #24B064;
}
.reveal .controls button {
color: #24B064;
}
.reveal blockquote {
display: block;
position: relative;
width: 90%;
margin: 20px auto;
padding: 5px;
background: rgba(255, 255, 255, 0.05);
box-shadow: 0px 0px 2px rgb(0 0 0 / 20%);
}
</style>
{"metaMigratedAt":"2023-06-16T01:12:08.160Z","metaMigratedFrom":"YAML","title":"nf-core/bytesize 15 - Pipeline first release","breaks":true,"contributors":"[{\"id\":\"07755eb0-739a-4628-85e2-ad4a4a341d04\",\"add\":5100,\"del\":2217},{\"id\":\"fb193497-1111-470c-a594-827d34b6f673\",\"add\":7,\"del\":10}]"}