Skip to content

Update release protocol#821

Merged
Bachibouzouk merged 7 commits intodevfrom
fix/release-protocol
Mar 11, 2021
Merged

Update release protocol#821
Bachibouzouk merged 7 commits intodevfrom
fix/release-protocol

Conversation

@Bachibouzouk
Copy link
Copy Markdown
Collaborator

@Bachibouzouk Bachibouzouk commented Mar 5, 2021

Fix #694

Changes proposed in this pull request:
Ask to first test package locally, then upload rc on pypi.org, then release on master, then official release on pypi.org

The following steps were realized, as well (if applies):

  • Update the CHANGELOG.md

For more information on how to contribute check the CONTRIBUTING.md.

Bachibouzouk added 3 commits March 5, 2021 10:30
Ask to first test package locally, then upload rc on pypi.org,
then release on master, then official release on pypi.org
Copy link
Copy Markdown
Contributor

@SabineHaas SabineHaas left a comment

Choose a reason for hiding this comment

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

Thanks for reworking @Bachibouzouk :)

I guess one has to do another release with this protocol and check whether everything works fine.
I suggest that @smartie2076 should give her "go", as well before you merge.

CONTRIBUTING.md Outdated
```
6. Create a new empty folder
```bash
mkdir empty_folder
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

5 and 6 is a duplicate

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Why do you need this empty_folder if you do not use it as output folder?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

To make sure you don't already have a default output folder in there and also to make sure none of the .py are within your path (i.e. you make sure you load the code from the package location, not from your current directory)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think if duplication in 5 and 6 is intentional, a sentence should be there that explains that it is so, because I would have skipped 6

CONTRIBUTING.md Outdated
```
9. Create a new empty folder
```bash
mkdir empty_folder
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

duplicate to 8.

@Bachibouzouk
Copy link
Copy Markdown
Collaborator Author

I guess one has to do another release with this protocol and check whether everything works fine.

This is the protocol which was followed during the last release (I used our experience to rewrite this protocol)

@SabineHaas
Copy link
Copy Markdown
Contributor

I guess one has to do another release with this protocol and check whether everything works fine.

This is the protocol which was followed during the last release (I used our experience to rewrite this protocol)

Ah so have you written it before and then followed it?

@Bachibouzouk
Copy link
Copy Markdown
Collaborator Author

Ah so have you written it before and then followed it?

Not exactly, I wrote it as we were doing a release not following the previous protocol

CONTRIBUTING.md Outdated
```
6. Create a new empty folder
```bash
mkdir empty_folder
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think if duplication in 5 and 6 is intentional, a sentence should be there that explains that it is so, because I would have skipped 6

Checking dist/multi_vector_simulator-X.Y.Zrci-py3-none-any.whl: PASSED
Checking dist/multi-vector-simulator-X.Y.Zrci.tar.gz: PASSED
```
If one of the two is not `PASSED`, find out why and fix it.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

How do we fix things - we did not create a release branch jet, so I suppose we are fixing by fixing the dev branch? Maybe make it explicit that those fixes should be merged into dev first?

@Bachibouzouk Bachibouzouk merged commit 58a2db4 into dev Mar 11, 2021
@Bachibouzouk Bachibouzouk deleted the fix/release-protocol branch March 11, 2021 08:34
@smartie2076 smartie2076 mentioned this pull request May 31, 2021
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.

Solve release protocol confusion

3 participants