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.

Sign up for GitHub

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 #255

Merged
merged 5 commits into from
Sep 12, 2023
Merged

Recipe release #255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
336b6c8
add recipe for publishing a new release
ahmadtourei Sep 9, 2023
1c6c834
fix typo
ahmadtourei Sep 9, 2023
5431565
move it to Contributing, fixed hyperlinking
ahmadtourei Sep 9, 2023
4a0d546
fix #254, add release recipe to side menu
ahmadtourei Sep 11, 2023
352c95d
resolve a merge conflict
ahmadtourei Sep 12, 2023
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Loading