Skip to content
This repository has been archived by the owner on Apr 3, 2024. It is now read-only.

build: add maintance workflows #2

Merged

Conversation

Ian2012
Copy link
Contributor

@Ian2012 Ian2012 commented Apr 28, 2023

Description

This PR adds maintenance workflows and upgrade requirements.

Merge checklist:
Check off if complete or not applicable:

  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Manual testing instructions provided
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

@openedx-webhooks
Copy link

Thanks for the pull request, @Ian2012! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 28, 2023
@Ian2012 Ian2012 force-pushed the cag/add-maintenance-workflows branch 2 times, most recently from 0e3c263 to cfd8376 Compare May 4, 2023 15:04
README.rst Outdated
@@ -75,24 +75,23 @@ Every time you develop something in this repo
Deploying
=========

TODO: How can a new user go about deploying this component? Is it just a few
commands? Is there a larger how-to that should be linked here?
The Open edX Sink Clickhouse component is a django plugin which doesn't
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The Open edX Sink Clickhouse component is a django plugin which doesn't
The Open edX Event Sink Clickhouse component is a django plugin which doesn't

README.rst Outdated
PLACEHOLDER: For details on how to deploy this component, see the `deployment how-to`_

.. _deployment how-to: https://docs.openedx.org/projects/openedx-event-sink-clickhouse/how-tos/how-to-deploy-this-component.html
If the service you intend to use is either the LMS or CMS, then
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure what this means, do you mean that if it's installed as a requirement in, say, private.txt it will work out of the box?

README.rst Outdated
.. _deployment how-to: https://docs.openedx.org/projects/openedx-event-sink-clickhouse/how-tos/how-to-deploy-this-component.html
If the service you intend to use is either the LMS or CMS, then
the library is installed alongside their requirements since the
Nutmeg release.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we add something specific about the settings that need to be set for this to work here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That paragraph should be removed, and I will add the settings

@Ian2012 Ian2012 force-pushed the cag/add-maintenance-workflows branch from cfd8376 to 2524792 Compare May 4, 2023 19:41
@Ian2012
Copy link
Contributor Author

Ian2012 commented May 4, 2023

@bmtcril ready for review

@bmtcril
Copy link
Contributor

bmtcril commented May 5, 2023

@Ian2012 Sorry, this is going to need a rebase now but then I'll merge it

@Ian2012 Ian2012 force-pushed the cag/add-maintenance-workflows branch from 2524792 to a9f269b Compare May 5, 2023 15:06
@Ian2012
Copy link
Contributor Author

Ian2012 commented May 5, 2023

Rebased

Copy link
Contributor

@bmtcril bmtcril left a comment

Choose a reason for hiding this comment

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

👍

@bmtcril bmtcril merged commit b07e33f into openedx-unsupported:main May 5, 2023
@openedx-webhooks
Copy link

@Ian2012 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

@itsjeyd
Copy link

itsjeyd commented May 8, 2023

label: needs test run

@github-actions github-actions bot added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label May 8, 2023
@itsjeyd
Copy link

itsjeyd commented May 8, 2023

^^I added this label just for testing purposes. Please ignore.

@e0d e0d removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jun 7, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants