SIT-2 Release [main] #83

bourque · 2023-08-28T18:46:57Z

For reviewers: Please review the release.yml file, as that is a new file being introduced in this PR. Also please review the release notes and let me know if anything should be added/removed/changed. Everything else has already been reviewed in past PRs.

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 main 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.

This adds the basics to start building our docs and organizing the sphinx page structure.

…kdown formatting throughout

Merge main to dev

…tead of 80, added instructions for installing pre-commit hooks

updates: - [github.com/psf/black: 22.12.0 → 23.3.0](psf/black@22.12.0...23.3.0) - [github.com/charliermarsh/ruff-pre-commit: v0.0.245 → v0.0.275](astral-sh/ruff-pre-commit@v0.0.245...v0.0.275) - [github.com/python-poetry/poetry: 1.4.0 → 1.5.0](python-poetry/poetry@1.4.0...1.5.0)

Adding documentation builds

greglucas

It looks like we already have released the code.
https://pypi.org/project/imap-processing/#history

Did you release that off of main, or the 0.1.0 branch? I don't see any tags, so I'm confused what that release corresponds to and how this workflow will go into that. Maybe that was just a temporary release on push? But, then I think we will get a complaint about a release already existing, so maybe you need to yank that one before triggering this actual workflow release?

greglucas · 2023-09-28T19:29:17Z

.github/workflows/release.yml

+          # Get the name of the build sdist file for later use
+          echo "SDIST_NAME=$(ls -1 dist)" >> $GITHUB_OUTPUT


Suggested change

# Get the name of the build sdist file for later use

echo "SDIST_NAME=$(ls -1 dist)" >> $GITHUB_OUTPUT

greglucas · 2023-09-28T19:30:07Z

.github/workflows/release.yml

+    outputs:
+      SDIST_NAME: ${{ steps.sdist.outputs.SDIST_NAME }}


Suggested change

outputs:

SDIST_NAME: ${{ steps.sdist.outputs.SDIST_NAME }}

I don't think we use that here. It is only used in those other examples when combining sdists and wheels, but it looks like you are just doing sdist and avoiding needing this.

greglucas · 2023-09-28T19:55:26Z

Thinking more about this. Do we need the main branch at all? I think main is just the "currently released version"? So, what if we just kept the branches named their version like you have here?

v0.1.x -> 0.1 series that would contain all 0.1 tags.
v0.2.x -> 0.2 series that would contain all 0.2 tags.

We could keep these branches around then and backport whatever we needed to them. This would also eliminate confusion over what version main is and where we are releasing from and remove this need for a massive PR. Thoughts?

bourque · 2023-09-28T20:44:22Z

It looks like we already have released the code. https://pypi.org/project/imap-processing/#history

Did you release that off of main, or the 0.1.0 branch? I don't see any tags, so I'm confused what that release corresponds to and how this workflow will go into that. Maybe that was just a temporary release on push? But, then I think we will get a complaint about a release already existing, so maybe you need to yank that one before triggering this actual workflow release?

@greglucas Yes, that release was from me testing out the Actions workflow (it worked!). I think you are right -- I will have to remove this release on PyPI before we make the GitHub release.

greglucas · 2023-09-28T20:57:02Z

I think you could try to use the test pypi: https://packaging.python.org/en/latest/guides/using-testpypi/ but you also might need to add credentials there and authenticate too so might be more work than it is worth...

Yanking might also not work because the artifacts are still there: https://snarky.ca/what-to-do-when-you-botch-a-release-on-pypi/
So maybe best to just leave it there, and I think you'll still get a failure in the release because it will say "hey this version already exists".

GFMoraga and others added 30 commits July 7, 2023 11:30

adding templates for issues

421d095

Initial commit of style guide

47d62d9

Reordered some sections, added some recommended tools/libraries

8cef76a

Some clarifications on the git workflow

1371063

DOC: Start of sphinx documentation

6976940

This adds the basics to start building our docs and organizing the sphinx page structure.

Fixed some broken links; addressed some review comments

ccef051

Added poetry section, added tl;dr section, more consistent use of mar…

64585b1

…kdown formatting throughout

Merge pull request #20 from IMAP-Science-Operations-Center/main

f235f2e

Merge main to dev

Added release workflow section, reformatted to use 120 characters ins…

ed73bf9

…tead of 80, added instructions for installing pre-commit hooks

Added section on updating poetry environments

7cdb578

Added checklist for contributors and reviewers of PRs

6dcb24b

Added all-contributors section and badge

35210dc

docs: update README.md [skip ci]

d4480e9

docs: create .all-contributorsrc [skip ci]

1cdae3a

Merge pull request #15 from greglucas/docs

b253925

Adding documentation builds

docs: update README.md [skip ci]

2cf10d4

docs: create .all-contributorsrc [skip ci]

b598479

docs: update README.md [skip ci]

a08e5dd

docs: create .all-contributorsrc [skip ci]

5fecfcb

docs: update README.md [skip ci]

ce6c35a

docs: create .all-contributorsrc [skip ci]

6e86993

docs: update README.md [skip ci]

6e56c49

docs: create .all-contributorsrc [skip ci]

a55a9d9

docs: update README.md [skip ci]

c632b52

docs: create .all-contributorsrc [skip ci]

cf14510

docs: update README.md [skip ci]

3514083

docs: create .all-contributorsrc [skip ci]

554ee02

docs: update README.md [skip ci]

8548e67

docs: update .all-contributorsrc [skip ci]

04eea50

bourque linked an issue Aug 29, 2023 that may be closed by this pull request

Deploy to PyPI via GitHub Actions #91

Closed

bourque added 2 commits September 28, 2023 10:55

Added workflow to uploading release to PyPI

c4468ff

Fixed indentation, added step to download sdist

e6915fd

bourque deployed to pypi September 28, 2023 16:59 — with GitHub Actions View deployment

bourque had a problem deploying to pypi September 28, 2023 16:59 — with GitHub Actions Failure

Workflow now triggers only on published release

690038f

bourque marked this pull request as ready for review September 28, 2023 17:35

bourque requested review from a team, sdhoyt, greglucas, tech3371, bryan-harter, laspsandoval, GFMoraga and maxinelasp and removed request for a team September 28, 2023 17:36

bourque changed the title ~~SIT-2 Release [WIP]~~ SIT-2 Release Sep 28, 2023

bourque changed the title ~~SIT-2 Release~~ SIT-2 Release [main] Sep 28, 2023

bourque mentioned this pull request Sep 28, 2023

SIT-2 Release [dev] #177

Closed

maxinelasp approved these changes Sep 28, 2023

View reviewed changes

sdhoyt approved these changes Sep 28, 2023

View reviewed changes

greglucas reviewed Sep 28, 2023

View reviewed changes

tech3371 approved these changes Sep 28, 2023

View reviewed changes

bourque closed this Sep 29, 2023

bourque deleted the 0.1.0 branch September 29, 2023 20:43

bourque mentioned this pull request Sep 29, 2023

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

Merged

bourque had a problem deploying to pypi September 29, 2023 20:54 — with GitHub Actions Failure

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SIT-2 Release [main] #83

SIT-2 Release [main] #83

bourque commented Aug 28, 2023 •

edited

Loading

greglucas left a comment

greglucas Sep 28, 2023

greglucas Sep 28, 2023

greglucas commented Sep 28, 2023

bourque commented Sep 28, 2023

greglucas commented Sep 28, 2023

		# Get the name of the build sdist file for later use
		echo "SDIST_NAME=$(ls -1 dist)" >> $GITHUB_OUTPUT

SIT-2 Release [main] #83

SIT-2 Release [main] #83

Conversation

bourque commented Aug 28, 2023 • edited Loading

Change Summary

Overview

New Dependencies

New Files

Testing

greglucas left a comment

Choose a reason for hiding this comment

greglucas Sep 28, 2023

Choose a reason for hiding this comment

greglucas Sep 28, 2023

Choose a reason for hiding this comment

greglucas commented Sep 28, 2023

bourque commented Sep 28, 2023

greglucas commented Sep 28, 2023

bourque commented Aug 28, 2023 •

edited

Loading