Skip to content

Commit

Permalink
Recipe release (#255)
Browse files Browse the repository at this point in the history
  • Loading branch information
ahmadtourei authored Sep 12, 2023
1 parent 3bec2bc commit 2d96d75
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 3 deletions.
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).
4 changes: 2 additions & 2 deletions docs/recipes/overview.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ own.

# Contributing

[Contributing to documentation](contributing_to_documentation.qmd)

[Contributing step by step](how_to_contribute.qmd)

[Contributing to documentation](contributing_to_documentation.qmd)
7 changes: 6 additions & 1 deletion scripts/_templates/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,10 @@ website:
- id: Recipes
title: 'Recipes'
contents:
- recipes/overview.qmd

- text: Plotting channel number
- href: recipes/plotting_channel_number.qmd
href: recipes/plotting_channel_number.qmd

- text: How to Contribute?
href: recipes/how_to_contribute.qmd
Expand Down Expand Up @@ -149,6 +151,9 @@ website:
- text: "Adding a new format"
href: contributing/new_format.qmd

- text: "Publish a new release"
href: contributing/publish_a_new_release.qmd

- text: "Code of Conduct"
href: contributing/code_of_conduct.qmd

Expand Down

0 comments on commit 2d96d75

Please sign in to comment.