Skip to content

Commit

Permalink
stop triggering auto-deploys on release
Browse files Browse the repository at this point in the history
  • Loading branch information
ejolly committed Sep 8, 2023
1 parent 4f08c2a commit 1b11ab4
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 11 deletions.
4 changes: 1 addition & 3 deletions .github/workflows/Build.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
name: Build and Deploy on release
name: Build and Deploy
on:
release:
types: [published]
workflow_dispatch:
inputs:
upload_anaconda:
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/Build_noarch.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
name: Build and Deploy noarch on release
on:
release:
types: [published]
workflow_dispatch:
inputs:
upload_anaconda:
Expand Down
14 changes: 8 additions & 6 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,12 @@ A stable release can be installed from :code:`pip` or from :code:`conda` using t
2. A pip installable package uploaded to Pypi
3. Documentation site deployed to github pages

The primary way to create these is by publishing a new release via Github. This will **automatically** trigger the **Build** and **Build_noarch** workflows, which will:
To create a new release:

- Build, test, and upload conda packages for each platform to anaconda cloud
- Build and upload to Pypi
- Build and deploy docs to github-pages
1. Publish a new release via github
2. Manually trigger the **Build** and **Build_noarch** workflows and enable uploading to the main channel on anaconda, uploading to pypi, and deploying documentation

If any issues arise in this automated process both workflows can also be triggered *manually*. Separate options exist for choosing whether to upload each artifact or simply build them (e.g. deploy docs but don't upload builds to pypi or anaconda)
*Note: Previously this process was automated to trigger when a github release is made, but this seems to be unreliable as the commit hash is missing and causes runners to not find the built tarballs*

Packaging Development Releases
++++++++++++++++++++++++++++++
Expand All @@ -39,8 +38,11 @@ A development release only includes 1 artifact:

1. Conda packages for multiple platforms uploaded to the :code:`ejolly/label/pre-release` channel on anaconda cloud

The primary way to create a development release is by *manually triggering* the same **Build** and **Build_noarch** workflows and choosing the "pre-release" option for uploading to anaconda cloud. The default options when manually triggering will simply build packages but perform no uploading (useful for testing package builds).
Development releases are created the same way as stable releases using the same **Build** and **Build_noarch** workflows, but choosing the "pre-release" option for uploading to anaconda cloud and disabling pypi and documentation deploys. The default options for these works flow will simply build packages but perform no uploading at all which can useful for testing package builds.

Updating deployed documentation
+++++++++++++++++++++++++++++++
To deploy only documentation changes you can use *either* the **Build** workflow and enable the documentation deploy or the **Docs** workflow which is a bit faster as it skips packaging building.

Code Guidelines
---------------
Expand Down

0 comments on commit 1b11ab4

Please sign in to comment.