Skip to content

Commit 18516d5

Browse files
committed
edit docs
1 parent 9ebefaf commit 18516d5

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

developer-docs/PUBLISHING_GUIDE.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,8 @@ Instructions are provided for:
8686
8787
Follow the instructions on Notion [here](https://www.notion.so/arcadiascience/How-to-archive-a-GitHub-repository-on-Zenodo-at-time-of-publication-1cd6202af5bb4b5ba8464caaba8e9bed) to link your repo to Zenodo and create a new tagged release. (Note: this step is the same one you would follow for a "normal" non-notebook pub.)
8888
89+
Be sure to use a version number of the form 'v1' or 'v1.0' for this initial tagged release.
90+
8991
1. **Merge the auto-generated publication PR**
9092
9193
When you create a new tagged release in the step above, a GitHub Action automatically builds the public publication and opens a PR to merge the publication files into the `publish` branch.
@@ -113,7 +115,7 @@ git checkout main
113115
git pull
114116
```
115117

116-
Then, create a new tag and push it to the repo:
118+
Then, create a new tag and push it to the repo. For each revision, increment the tag by 1, e.g. 'v1' -> 'v2'. Be sure to use the same format as the initial tagged release (e.g. use 'v2.0' if the initial release was 'v1.0', or 'v2' if the initial release was 'v1').
117119

118120
```bash
119121
git tag v2

0 commit comments

Comments
 (0)