You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributing.md
+16-5Lines changed: 16 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,7 +76,7 @@ By including this additional information, the document now provides a more compr
76
76
77
77
### Integration testing
78
78
79
-
Cross-repo integration testing is available in the [spatialdata-integration-testing](https://github.com/scverse/spatialdata-integration-testing/) repo. Please follow the instructions in the Readme. For questions ask Luca.
79
+
Cross-repo integration testing is available in the [spatialdata-integration-testing](https://github.com/scverse/spatialdata-integration-testing/) repo. Please follow the instructions in the Readme (which also includes a video overview).
80
80
81
81
## Publishing a release
82
82
@@ -118,13 +118,24 @@ It's important that the tag for a pre-release follows this naming convention as
118
118
119
119
### Making a release on GitHub and publishing to PyPI
120
120
121
-
If you already tagged and pushed a commit as explained above and you want to create a release from that tag, you can go to the [Tags page on GitHub](https://github.com/scverse/spatialdata/tags), select the (latest) tag and press the "Create release from tag" button. Please name the release with the same string used for the tag (including the `v` prefix).
121
+
#### Recommended: Create the release via GitHub
122
122
123
-
Alternatively you can go to the [Releases page on GitHub](https://github.com/scverse/spatialdata/releases) and press the "Draft a new release button". Now press "Choose a tag" and create a new tag.
123
+
- Go to the [Releases page on GitHub](https://github.com/scverse/spatialdata/releases) and press the “Draft a new release” button.
124
+
- Press “Choose a tag” and create a new tag.
125
+
- Please name the tag with the same string you intend for the release, including the `v` prefix.
126
+
- Alternatively, go to the [Tags page on GitHub](https://github.com/scverse/spatialdata/tags), select the latest tag, and press “Create release from tag”.
127
+
- Please name the release with the same string used for the tag (including the `v` prefix).
128
+
- Both approaches lead to the same page and view. From there:
129
+
- Specify whether the release is a pre-release and whether it should be set as the latest release (use the checkboxes accordingly).
130
+
- Fill in the release notes (explained in the next section).
131
+
- Press “Publish release” to make the release available on GitHub.
132
+
- A [GitHub Action](https://github.com/scverse/spatialdata/blob/main/.github/workflows/release.yaml) will automatically build the package and [upload it to PyPI](https://pypi.org/project/spatialdata/#history).
133
+
- The action may fail; check the [workflow status badge in the README](https://github.com/scverse/spatialdata/actions/workflows/release.yaml).
124
134
125
-
Both approaches lead to the same page and view. From this, you need to specify if the release is a pre-release or if it should be set as the latest release (please use the checkboxes accordingly).
135
+
#### Not recommended: Manual tag-first workflow
126
136
127
-
The last step is to fill the releases notes (explained in the next session), after this, you can press the "Publish release" button and the release will be available on GitHub. A [GitHub action](https://github.com/scverse/spatialdata/blob/main/.github/workflows/release.yaml) will automatically build the package and [upload it to PyPI](https://pypi.org/project/spatialdata/#history). The action may fail, so please check the [status badge of the action from the Readme](https://github.com/scverse/spatialdata/actions/workflows/release.yaml).
137
+
- If you already tagged and pushed a commit as explained above and want to create a release from that tag, you can go to the [Tags page on GitHub](https://github.com/scverse/spatialdata/tags), select the latest tag, and press “Create release from tag”.
138
+
- Please name the release with the same string used for the tag (including the `v` prefix).
0 commit comments