Skip to content

Commit

Permalink
Update deploy CI job with missing dependency
Browse files Browse the repository at this point in the history
  • Loading branch information
djhoese committed Feb 17, 2022
1 parent 3b20e64 commit 2b0246d
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 23 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/deploy-sdist.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ jobs:

- name: Create sdist
shell: bash -l {0}
run: python -m build --sdist
run: |
python -m pip install -U build pip
python -m build --sdist
- name: Publish package to PyPI
if: github.event.action == 'published'
Expand Down
52 changes: 30 additions & 22 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,35 +3,43 @@
1. checkout main branch
2. pull from repo
3. run the unittests
4. run `loghub`. Replace <github username> and <previous version> with proper
values. To get the previous version run `git tag` and select the most
recent with highest version number.
4. run `loghub` and update the `CHANGELOG.md` file:

```
loghub pytroll/pydecorate -u <github username> -st v<previous version> -plg bug "Bugs fixed" -plg enhancement "Features added" -plg documentation "Documentation changes" -plg backwards-incompatibility "Backwards incompatible changes"
```
```
loghub pytroll/pydecorate --token $LOGHUB_GITHUB_TOKEN -st v<previous version> -plg bug "Bugs fixed" -plg enhancement "Features added" -plg documentation "Documentation changes" -plg backwards-incompatibility "Backward incompatible changes" -plg refactor "Refactoring"
```

This command will create a CHANGELOG.temp file which need to be added
to the top of the CHANGELOG.md file. The same content is also printed
to terminal, so that can be copy-pasted, too. Remember to update also
the version number to the same given in step 5. Don't forget to commit
CHANGELOG.md!
This uses a `LOGHUB_GITHUB_TOKEN` environment variable. This must be created
on GitHub and it is recommended that you add it to your `.bashrc` or
`.bash_profile` or equivalent.

5. Create a tag with the new version number, starting with a 'v', eg:
This command will create a CHANGELOG.temp file which need to be added
to the top of the CHANGLOG.md file. The same content is also printed
to terminal, so that can be copy-pasted, too. Remember to update also
the version number to the same given in step 5. Don't forget to commit
CHANGELOG.md!

```
git tag -a v<new version> -m "Version <new version>"
```
5. Create a tag with the new version number, starting with a 'v', eg:

For example if the previous tag was `v0.9.0` and the new release is a
patch release, do:
```
git tag -a v<new version> -m "Version <new version>"
```

```
git tag -a v0.9.1 -m "Version 0.9.1"
```
For example if the previous tag was `v0.9.0` and the new release is a
patch release, do:

See [semver.org](http://semver.org/) on how to write a version number.
```
git tag -a v0.9.1 -m "Version 0.9.1"
```

See [semver.org](http://semver.org/) on how to write a version number.

6. push changes to github `git push --follow-tags`
7. Verify travis tests passed and deployed sdist and wheel to PyPI
7. Verify github action unittests passed.
8. Create a "Release" on GitHub by going to
https://github.com/pytroll/pydecorate/releases and clicking "Draft a new release".
On the next page enter the newly created tag in the "Tag version" field,
"Version X.Y.Z" in the "Release title" field, and paste the markdown from
the changelog (the portion under the version section header) in the
"Describe this release" box. Finally click "Publish release".
9. Verify the GitHub actions for deployment succeed and the release is on PyPI.

0 comments on commit 2b0246d

Please sign in to comment.