Skip to content

Creating release procedure file#47

Open
york-stsci wants to merge 4 commits intomainfrom
upgrade_add_release_procedure
Open

Creating release procedure file#47
york-stsci wants to merge 4 commits intomainfrom
upgrade_add_release_procedure

Conversation

@york-stsci
Copy link
Collaborator

This PR adds a file describing the SAMOS release procedures and code change procedures, intended to make sure that the repository is consistent and that the WS code and repo code are matching.

@york-stsci york-stsci self-assigned this Feb 20, 2026
@york-stsci york-stsci marked this pull request as draft February 20, 2026 16:25
Copy link

@hayescr hayescr left a comment

Choose a reason for hiding this comment

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

@york-stsci I left a few comments (feel free to take or leave them). The only other question I had, was if there were any recommendations for what to do if there are multiple new features that need to be tested on observations. I'm not sure if such a case happens, but I thought I'd check.

Comment on lines +62 to +63
2. Immediately commit and push the changes, and create a pull request to add them to main.
3. Once the PR has been approved, merge it and then delete the branch.
Copy link

Choose a reason for hiding this comment

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

Would it be worth adding some simple git instructions to this like in the above section (I'm not sure how familiar the users are with git, but reminder's never hurt).

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good thought! I added a quick set of GitHub references at the bottom.

Comment on lines +81 to +82
- If you are making other changes to the repository, remember to update the working
branch so it has those changes added.
Copy link

Choose a reason for hiding this comment

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

Some recommended instructions here might be useful too, for ease of adoption.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

See above.

In this case, we want to make sure the changes are understandable, and we want to make
sure that they are added to the WS before the next observations are taken.

1. Create a new branch on the repository. For the branch name, _describe the specific
Copy link

Choose a reason for hiding this comment

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

I took a look at the formatted rst version of this (https://github.com/mrobberto/SAMOS_NEWGUI/blob/upgrade_add_release_procedure/RELEASE_PROCEDURE.rst#id3) and I'm not sure that these _text_ formats are rendering quite right. I'm assuming that they were supposed to be underlines or other emphasis formatting, but it seems to want to format only these as references?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Of course. Sometimes rst is markdown, sometimes not. Fixed I think.

Copy link

@hayescr hayescr left a comment

Choose a reason for hiding this comment

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

The changes look good to me, thanks @york-stsci !

@york-stsci york-stsci marked this pull request as ready for review February 27, 2026 15:48
@york-stsci york-stsci requested a review from mrobberto February 27, 2026 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants