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

Recipe release #253

Merged
merged 3 commits into from
Sep 10, 2023
Merged
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 docs/contributing/Publish_a_new_release.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "Publish a new release"
---

On this page, we provide a step-by-step guidance on how to publish a new release for DASCore.

## Step 1: Draft a new release and publish

On DASCore GitHub page, you should go to [Releases](https://github.com/DASDAE/dascore/releases), draft a new release. On the draft, choose a new tag a release title (e.g. 0.0.14). Finally, generate release notes and publish the relase.

## Step 2: Check the release status

On [Actions](https://github.com/DASDAE/dascore/actions), check the release status for both "PublishPackage" and "BuildDeployStableDocs". Also, make sure [PyPI](https://pypi.org/project/dascore/) is updated.

## Step 3: Commit required changes for Conda

For [conda](https://github.com/conda-forge/dascore-feedstock), you need to wait a few hours to get a pull request, and then verify/edit the dependencies, extras, etc. on [meta.yaml](https://github.com/conda-forge/dascore-feedstock/blob/main/recipe/meta.yaml) at /dascore-feedstock/recipe directory based on [pyproject.toml](https://github.com/DASDAE/dascore/blob/master/pyproject.toml) at /dascore directory. Therefore, if they do not match, you need to clone the dascore-feedstock branch, modify and push it. After merging the pull request, you can verify the latest DASCore version at [conda-forge](https://anaconda.org/conda-forge/dascore).
7 changes: 7 additions & 0 deletions docs/contributing/dev_install.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,16 @@ pre-commit install -f

If you have already installed dascore but it has been a while, please do the following before creating a new branch:

```bash
conda activate dascore
```
```bash
git checkout master
```
```bash
git pull origin master --tags
```
```bash
pip install -e ".[dev]"
```

Expand Down
4 changes: 2 additions & 2 deletions scripts/_templates/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,8 @@ website:
- id: Recipes
title: 'Recipes'
contents:
- recipes/overview.qmd
- plotting_channel_number.qmd
- text: Plotting channel number
- href: recipes/plotting_channel_number.qmd

- text: How to Contribute?
href: recipes/how_to_contribute.qmd
Expand Down
Loading