Skip to content

Commit

Permalink
Add manual triggering support/documentation for release workflow
Browse files Browse the repository at this point in the history
Ref: datalad/release-action#51 for more info
  • Loading branch information
yarikoptic committed Jan 31, 2024
1 parent 08315c1 commit 8656fee
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ on:
- maint
types:
- closed
# Allow manually triggering a release via a "Run workflow" button on the
# workflow's page:
workflow_dispatch:

jobs:
release:
Expand Down
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -630,6 +630,8 @@ changelog based on the pull requests since the last release, commits the
results, tags the new commit with the next version number, and creates a GitHub
release for the tag.
This in turn triggers a job for building an sdist & wheel for the project and uploading them to PyPI.
The release workflow alternatively could be triggered by visiting [release workflow page](https://github.com/datalad/datalad/actions/workflows/release.yml) and pressing "Run workflow" and choosing corresponding (`maint`) branch to release.
Note that release workflow would fail if there were no commits since the most recent tagged release.

### CHANGELOG entries and labelling pull requests

Expand Down

0 comments on commit 8656fee

Please sign in to comment.