Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion .zenodo.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,29 @@
"name": "Götte, Michael",
"orcid": "0009-0008-1278-8890",
"affiliation": "Helmholtz-Zentrum Berlin für Materialien und Energie, 14109 Berlin, Germany"
},
{
"name": "Borgelt, Hendrik",
"orcid": "0000-0001-5886-7860",
"affiliation": "TU Dortmund University"
},
{
"name": "Nentwich, Melanie",
"orcid": "0000-0002-5850-4469",
"affiliation": "Deutsches Elektronen-Synchrotron DESY"
},
{
"name": "Terboven, Carla",
"orcid": "0009-0004-3786-0773",
"affiliation": "Helmholtz-Zentrum Berlin für Materialien und Energie"
},
{
"name": "Flecken, Franziska",
"orcid": "0000-0003-4418-7455",
"affiliation": "Karlsruhe Institute of Technology"
}
],
"description": "<p><b>Voc4Cat</b> is a SKOS vocabulary for the catalysis disciplines.</p><p>The vocabulary was created in the <a href=\"http://www.nfdi4cat.org\">NFDI4Cat</a> initiative. The first collection of terms was published in June 2023 with a focus on photo catalysis. Our goal is to continuously extend the vocabulary to other areas of catalysis and related disciplines like chemical engineering or materials science. The principles that we follow are summarized in the <a href=\"https://doi.org/10.5281/zenodo.7669182\">Voc4Cat Guidelines</a>.</p><p>If you want to help us building a catalysis vocabulary, please come to our <a href=\"https://github.com/nfdi4cat/voc4cat/\">GitHub repository</a>. Everyone is welcome! We tried to make contributing easy: Download the current vocabulary as Excel file, make your edits and upload the modified file in a pull request.</p><p>The voc4cat repository is based on <a href=\"https://github.com/nfdi4cat/voc4cat-template/\">voc4cat-template</a>. The workflows use <a href=\"https://github.com/nfdi4cat/voc4cat-tool/\">voc4cat-tool</a> and GitHub features like pull requests, gh-actions, gh-pages etc. to minimize the workload for contributors and editors.</p>",
"description": "<p><b>Voc4Cat</b> is a SKOS vocabulary for the catalysis disciplines, continuously growing to cover catalysis and related fields such as chemical engineering and materials science.</p><p>The vocabulary was created in the <a href=\"http://www.nfdi4cat.org\">NFDI4Cat</a> initiative. Starting with photocatalysis in 2023, we are steadily extending the vocabulary to other areas of catalysis. The principles that we follow are summarized in the <a href=\"https://doi.org/10.5281/zenodo.7669182\">Voc4Cat Guidelines</a>.</p><p>If you want to help us building a comprehensive catalysis vocabulary, please come to our <a href=\"https://github.com/nfdi4cat/voc4cat/\">GitHub repository</a>. Everyone is welcome! We tried to make contributing easy: Download the current vocabulary as Excel file, make your edits and upload the modified file in a pull request.</p><p>The voc4cat repository is based on <a href=\"https://github.com/nfdi4cat/voc4cat-template/\">voc4cat-template</a>. The workflows use <a href=\"https://github.com/nfdi4cat/voc4cat-tool/\">voc4cat-tool</a> and GitHub features like pull requests, gh-actions, gh-pages etc. to minimize the workload for contributors and editors.</p>",
"keywords": [
"SKOS", "vocabulary", "catalysis", "linked data", "rdf", "Excel"
],
Expand Down
46 changes: 31 additions & 15 deletions docs/docs_maintenance/making-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,7 @@ Before creating a release, ensure:

## Release Process

### Step 1: Update Release Information in Documentation

The `docs/index.md` file contains references to the latest release version that need to be updated before creating a new release.
### Step 1: Create Feature Branch

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

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

Create a feature branch for the documentation update:
Create a feature branch for the release preparation:

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

Update 2 files in the `docs/` folder:
### Step 2: Update Contributor Information (if needed)

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.

1. Check for new contributors by reviewing recent commit history and pull requests
2. For each new contributor, add an entry to the `creators` array in `.zenodo.json`:
```json
{
"name": "LastName, FirstName",
"orcid": "0000-0000-0000-0000",
"affiliation": "Institution Name"
}
```
3. Ensure contributors are listed in the order they should appear on Zenodo
4. Use the affiliation format as shown on the contributor's ORCID profile or their institution's ROR records

### Step 3: Update Release Information in Documentation

Update the following files in the `docs/` folder:

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

### Step 2: Create and Merge Pull Request
### Step 4: Create and Merge Pull Request

Commit and push your documentation changes:

```bat
C:\Users\dlinke\MyProg_local\gh-nfdi4cat\voc4cat(release-prep-vYYYY-MM-DD)
λ git add docs/index.md docs/conf.py
λ git add docs/index.md docs/conf.py .zenodo.json

C:\Users\dlinke\MyProg_local\gh-nfdi4cat\voc4cat(release-prep-vYYYY-MM-DD)
λ git commit -m "Prepare documentation for vYYYY-MM-DD release"
Expand All @@ -82,7 +98,7 @@ Create a pull request on GitHub and get the PR reviewed and approved by another

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

### Step 3: Pull Updated Main Branch
### Step 5: Pull Updated Main Branch

Switch back to main and pull the merged changes:

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

### Step 4: Create and Push Release Tag
### Step 6: Create and Push Release Tag

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

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

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

### Step 5: Monitor Automated Publish Workflow
### Step 7: Monitor Automated Publish Workflow

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

Expand Down Expand Up @@ -153,19 +169,19 @@ git tag -d vYYYY-MM-DD # delete local tag
git push --delete origin vYYYY-MM-DD # delete remote tag
```

### Step 6: Create GitHub Release
### Step 8: Create GitHub Release

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

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

### Step 7: Verify Release
### Step 9: Verify Release

After publishing, verify the release is accessible:

Expand Down