Skip to content

Commit a452025

Browse files
committed
Add updating zenodo info as step to release process docs
1 parent a221fa5 commit a452025

1 file changed

Lines changed: 31 additions & 15 deletions

File tree

docs/docs_maintenance/making-releases.md

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,7 @@ Before creating a release, ensure:
2525

2626
## Release Process
2727

28-
### Step 1: Update Release Information in Documentation
29-
30-
The `docs/index.md` file contains references to the latest release version that need to be updated before creating a new release.
28+
### Step 1: Create Feature Branch
3129

3230
Navigate to your local clone of the voc4cat repository. Make sure you are on the main branch and have the latest changes:
3331

@@ -37,15 +35,33 @@ C:\Users\dlinke\MyProg_local\gh-nfdi4cat\voc4cat
3735
λ git pull
3836
```
3937

40-
Create a feature branch for the documentation update:
38+
Create a feature branch for the release preparation:
4139

4240
```bat
4341
C:\Users\dlinke\MyProg_local\gh-nfdi4cat\voc4cat(main -> origin)
4442
λ git switch -c release-prep-vYYYY-MM-DD
4543
Switched to a new branch 'release-prep-vYYYY-MM-DD'
4644
```
4745

48-
Update 2 files in the `docs/` folder:
46+
### Step 2: Update Contributor Information (if needed)
47+
48+
If there are new contributors since the last release, update the `.zenodo.json` file to include them. This ensures proper attribution when the release is archived on Zenodo.
49+
50+
1. Check for new contributors by reviewing recent commit history and pull requests
51+
2. For each new contributor, add an entry to the `creators` array in `.zenodo.json`:
52+
```json
53+
{
54+
"name": "LastName, FirstName",
55+
"orcid": "0000-0000-0000-0000",
56+
"affiliation": "Institution Name"
57+
}
58+
```
59+
3. Ensure contributors are listed in the order they should appear on Zenodo
60+
4. Use the affiliation format as shown on the contributor's ORCID profile or their institution's ROR records
61+
62+
### Step 3: Update Release Information in Documentation
63+
64+
Update the following files in the `docs/` folder:
4965

5066
1. The announcement banner (in `docs/conf.py`):
5167
```python
@@ -63,13 +79,13 @@ Update 2 files in the `docs/` folder:
6379
- **vYYYY-MM-DD**: [Documentation (HTML)](https://w3id.org/nfdi4cat/voc4cat/vYYYY-MM-DD), permanent url `https://w3id.org/nfdi4cat/voc4cat/vYYYY-MM-DD`
6480
```
6581

66-
### Step 2: Create and Merge Pull Request
82+
### Step 4: Create and Merge Pull Request
6783

6884
Commit and push your documentation changes:
6985

7086
```bat
7187
C:\Users\dlinke\MyProg_local\gh-nfdi4cat\voc4cat(release-prep-vYYYY-MM-DD)
72-
λ git add docs/index.md docs/conf.py
88+
λ git add docs/index.md docs/conf.py .zenodo.json
7389
7490
C:\Users\dlinke\MyProg_local\gh-nfdi4cat\voc4cat(release-prep-vYYYY-MM-DD)
7591
λ git commit -m "Prepare documentation for vYYYY-MM-DD release"
@@ -82,7 +98,7 @@ Create a pull request on GitHub and get the PR reviewed and approved by another
8298

8399
Then merge it to `main`. After merging, delete the feature branch on GitHub.
84100

85-
### Step 3: Pull Updated Main Branch
101+
### Step 5: Pull Updated Main Branch
86102

87103
Switch back to main and pull the merged changes:
88104

@@ -102,7 +118,7 @@ C:\Users\dlinke\MyProg_local\gh-nfdi4cat\voc4cat(main -> origin)
102118
λ git branch -d release-prep-vYYYY-MM-DD
103119
```
104120

105-
### Step 4: Create and Push Release Tag
121+
### Step 6: Create and Push Release Tag
106122

107123
Create an annotated tag following the pattern `vYYYY-MM-DD` (e.g., `v2025-05-22`):
108124

@@ -115,16 +131,16 @@ Push the tag to GitHub:
115131

116132
```bat
117133
C:\Users\dlinke\MyProg_local\gh-nfdi4cat\voc4cat(main -> origin)
118-
λ git push origin v2025-05-22
134+
λ git push --tags
119135
Enumerating objects: 1, done.
120136
Counting objects: 100% (1/1), done.
121-
Writing objects: 100% (1/1), 164 bytes | 164.00 KiB/s, done.
137+
Writing objects: 100% (1/1), 170 bytes | 164.00 KiB/s, done.
122138
Total 1 (delta 0), reused 0 (delta 0), pack-reused 0
123139
To https://github.com/nfdi4cat/voc4cat.git
124140
* [new tag] v2025-05-22 -> v2025-05-22
125141
```
126142

127-
### Step 5: Monitor Automated Publish Workflow
143+
### Step 7: Monitor Automated Publish Workflow
128144

129145
The push of a tag matching `v[0-9]+-[0-9]+-[0-9]+` triggers the `.github/workflows/publish.yml` workflow automatically. This workflow:
130146

@@ -153,19 +169,19 @@ git tag -d vYYYY-MM-DD # delete local tag
153169
git push --delete origin vYYYY-MM-DD # delete remote tag
154170
```
155171

156-
### Step 6: Create GitHub Release
172+
### Step 8: Create GitHub Release
157173

158174
Once the publish workflow completes successfully, create a GitHub Release from the tag:
159175

160176
1. Navigate to <https://github.com/nfdi4cat/voc4cat/releases>
161177
2. Click "Draft a new release"
162178
3. Click "Choose a tag" and select your version tag (e.g., `v2025-05-22`)
163-
4. Set the release title to match the tag (e.g., `v2025-05-22`)
179+
4. Set a release title that matches the tag (e.g., `Release 2025-05-22`)
164180
5. In the release notes, summarize the changes included in the new release. Follow the style of the previous release notes.
165181
6. Check "Set as the latest release"
166182
7. Click "Publish release"
167183

168-
### Step 7: Verify Release
184+
### Step 9: Verify Release
169185

170186
After publishing, verify the release is accessible:
171187

0 commit comments

Comments
 (0)