Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SIT-2 Release [dev] [v0.1.x] #180

Merged
merged 3 commits into from
Oct 2, 2023
Merged

SIT-2 Release [dev] [v0.1.x] #180

merged 3 commits into from
Oct 2, 2023

Conversation

bourque
Copy link
Collaborator

@bourque bourque commented Sep 29, 2023

Note: This PR is essentially the same as #83 and #177, but follows a new release procedure in which there is no main branch and uses the branch naming convention of vX.Y.x.

Change Summary

Overview

This PR marks the release of version 0.1.0 (which is the first release of imap_processing), which corresponds to the completion of SIT-2. This PR is being merged back into dev per the nominal git & GitHub workflow and release workflow.

These are the release notes that will go into the GitHub release:

This release marks the successful completion of SIT-2. Further information about what was tested in SIT-2 can be found in this [galaxy page](https://lasp.colorado.edu/galaxy/display/IMAP/SDC-SIT-2) and the [SIT-2 GitHub Project Board](https://github.com/orgs/IMAP-Science-Operations-Center/projects/2/views/4).

## Features
* Added project documentation (via Sphinx & ReadTheDocs), including Style Guide, development practices, and API reference
* Added Actions workflow to automatic documentation builds
* Added Actions workflow to automatic deployment to PyPI upon release
* Added pre-commit hooks
* Added Issue and Pull Request templates
* Added all-contributors section in README

New Dependencies

  • pydata-sphinx-theme
  • sphinx
  • myst-parser

New Files

The only new file to actually review is .github/workflows/release.yml, which is a workflow for uploading the release to PyPI.

Testing

The new release.yml workflow was tested by triggering the workflow upon push. The workflow successfully completed (see here: https://github.com/IMAP-Science-Operations-Center/imap_processing/actions/runs/6341963633).

The 0.1.0 version of the package was uploaded to PyPI: https://pypi.org/project/imap-processing/

To test this, one can pip install imap-processing in a new environment and make sure 0.1.0 gets successfully installed.

@bourque bourque self-assigned this Sep 29, 2023
@bourque bourque added the Repo: Release Related to a release label Sep 29, 2023
@bourque bourque added this to the SDC SIT-2 milestone Sep 29, 2023
@bourque bourque requested review from a team, sdhoyt, greglucas, tech3371, bryan-harter, laspsandoval, GFMoraga and maxinelasp and removed request for a team September 29, 2023 20:50
Copy link
Collaborator

@greglucas greglucas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

Copy link
Contributor

@laspsandoval laspsandoval left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Thanks for this.

@bourque bourque merged commit 658150a into dev Oct 2, 2023
38 of 40 checks passed
@bourque bourque deleted the v0.1.x branch October 2, 2023 16:45
@bourque bourque restored the v0.1.x branch October 11, 2023 16:50
laspsandoval pushed a commit to laspsandoval/imap_processing that referenced this pull request Nov 15, 2023
…ce-Operations-Center/v0.1.x

SIT-2 Release [dev] [v0.1.x]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Repo: Release Related to a release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants