documentation-for-maintainers.md

Documentation for repository maintainers

Making a release

1. Write the release notes

2. Update CITATION.cff

3. Generate the metadata file for Zenodo using cffconvert.

   pip install --user cffconvert
   cffconvert --outputformat zenodo --ignore-suspect-keys --outfile .zenodo.json

   # git add, commit, and push everything

4. Make sure that everything is pushed

   cd $(mktemp -d)
   git clone https://github.com/research-software-directory/research-software-directory.git
   cd research-software-directory

5. Follow the notes from the 'For developers' section above, and verify that it all works as it should.

6. Use GitHub's Draft a new release button here to make a release.

Pulling in changes from upstream using a three-way merge

Set UPSTREAM and DOWNSTREAM to the different sources you want to three-way merge between, e.g.

UPSTREAM=https://github.com/research-software-directory/research-software-directory.git
DOWNSTREAM=https://github.com/process-project/research-software-directory.git

Then:

cd $(mktemp -d)
mkdir left middle right
cd left && git clone $UPSTREAM . && cd -
cd middle && git clone $DOWNSTREAM . && git branch develop && git checkout develop && cd -
cd right && git clone $DOWNSTREAM . && cd -
meld left middle right &

You should only make changes to the middle one. When you're done making your changes,

git add <the files>
git commit
git push origin develop