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

PyPi-push CI changes: unit tests, include releases/* branches #143

Closed
wants to merge 13 commits into from

Conversation

pandu-k
Copy link
Collaborator

@pandu-k pandu-k commented Aug 10, 2023

  • Please check if the PR fulfills these requirements
  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes/features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
    CI pipeline update

  • What is the current behavior? (You can also link to an open issue here)
    PyPi-push CI only runs on pushes to mainline, does not run unit tests.
    The unit tests pipeline also runs on pushes to mainline.

  • What is the new behavior (if this is a feature change)?
    PyPi-push CI now also runs on branches matching the releases/* pattern. The pipeline also runs unit tests, which must pass, before being pushed to PyPi.
    The unit tests pipeline no longer also runs on pushes to mainline, as these tests are run in the upgraded push-to-pypi workflow
    The unit tests pipeline now also runs on update to PRs matching the releases/* pattern.

  • Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
    No

  • Testing
    After changes are merged, the follow tests will be run through:

image

Notes and observations

  • The GH workflow runs the on-push commands after merging, using the updated workflow.

To Do:
- consider adding a "needs" section
@pandu-k pandu-k changed the title PyPi-push CI changes: run unit tests and include releases/* branches PyPi-push CI changes: unit tests, include releases/* branches Aug 10, 2023
@pandu-k pandu-k temporarily deployed to py-marqo-test-suite August 10, 2023 00:06 — with GitHub Actions Inactive
@pandu-k pandu-k temporarily deployed to py-marqo-test-suite August 10, 2023 00:10 — with GitHub Actions Inactive
@pandu-k pandu-k temporarily deployed to py-marqo-test-suite August 10, 2023 00:42 — with GitHub Actions Inactive
* added unit tests jobs

To Do:
- consider adding a "needs" section

* Update publish-to-PyPI.yml

* Update open-source-unit-tests.yml

* Update open-source-unit-tests.yml
@pandu-k pandu-k temporarily deployed to py-marqo-test-suite August 10, 2023 01:03 — with GitHub Actions Inactive
@pandu-k pandu-k temporarily deployed to py-marqo-test-suite August 10, 2023 01:54 — with GitHub Actions Inactive
@pandu-k pandu-k temporarily deployed to py-marqo-test-suite August 10, 2023 02:16 — with GitHub Actions Inactive
@pandu-k pandu-k temporarily deployed to py-marqo-test-suite August 10, 2023 02:23 — with GitHub Actions Inactive
@pandu-k pandu-k temporarily deployed to py-marqo-test-suite August 10, 2023 02:26 — with GitHub Actions Inactive
@@ -20,12 +20,10 @@ on:
image_tag:
description: 'Marqo image tag. Examples: "1.1.0", "test" "latest"'
required: true
push:
branches:
- mainline
pull_request:
Copy link
Contributor

Choose a reason for hiding this comment

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

just clarifying this runs unit tests every time there's a push to a mainline or releases branch, right? If so, this might be a good thing to add to the marqo repo as well.

Copy link
Collaborator Author

@pandu-k pandu-k Aug 10, 2023

Choose a reason for hiding this comment

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

Do you mean the pull_requests trigger? It runs every time there is a push to a branch that is in PR directed at mainline/releases. This would be really useful to be added to Marqo too (I plan to add this to Marqo at some point)

Copy link
Contributor

Choose a reason for hiding this comment

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

yep i meant the pull_requests trigger. Does it also run when the pull request itself is created, or only on pushes to it? Also doing a bit of research, the pull_request_review trigger may also be cool to think about. But that can be done another time.

.github/workflows/publish-to-PyPI.yml Show resolved Hide resolved
.github/workflows/open-source-unit-tests.yml Show resolved Hide resolved
.github/workflows/publish-to-PyPI.yml Show resolved Hide resolved
@pandu-k pandu-k temporarily deployed to py-marqo-test-suite August 10, 2023 09:05 — with GitHub Actions Inactive
@pandu-k pandu-k closed this Aug 10, 2023
@pandu-k pandu-k mentioned this pull request Aug 10, 2023
3 tasks
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