Publishing a release

Creating a Pull Request

Once all the new changes for the next release have been added to our WRF4G github fork, it is time to create a Pull Request to merge our changes to WRF4G devel branch.

As there are chances that the main WRF4G repository has changed, you should first update your local repository and check that there are no conflicts.

git checkout devel
git remote add github https://github.com/SantanderMetGroup/WRF4G.git #just do run this command the first time to add the main repository to the list of your remotes
git pull github devel

If there have been any changes, but there are no conflicts, you can just push your changes into your remote repository.

git push origin devel

In the case that there are conflicts, resolve them and commit the changes, after do the push to update your remote repository.

After, you just have to go to your repository's web page and click on the "New pull request" button.

Once all the new changes for the next release have been added to the devel branch and it is at a stable point, it's time to publish a new release.

Getting ready for a release

Once all the new changes for the next release have been added to the devel branch and it is at a stable point, it's time to publish a new release.

When ready, all that needs to be done is merge it into the main, create a tag and update the remote repository.

git clone https://github.com/SantanderMetGroup/WRF4G.git
git checkout main
git merge --squash devel
git commit -v
git tag 3.0.1 -m "Annotated Tag"
git push --tags

Publishing a release in Pypi

After having updated the main branch, it's time to publish the release. In order to do so, first we have to create the wheel and dist pip packages and then upload them to pypi (you'll need to have an account with access to the groups ​PyPI page).

python setup.py sdist bdist_wheel
twine upload dist/*

The last step is to update the realese wiki page and the references in the section "New releases" of the WRF4G's main wiki page.