Skip to content
This repository has been archived by the owner on Aug 30, 2023. It is now read-only.

Commit

Permalink
Merge pull request #108 from openedx/tcril/fix-gh-org-url
Browse files Browse the repository at this point in the history
Fix github url strings (org edx -> openedx)
  • Loading branch information
sarina committed Sep 14, 2022
2 parents 5d0a417 + 811adf7 commit c50a8b4
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 78 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/commitlint.yml
Expand Up @@ -7,4 +7,4 @@ on:

jobs:
commitlint:
uses: edx/.github/.github/workflows/commitlint.yml@master
uses: openedx/.github/.github/workflows/commitlint.yml@master
75 changes: 17 additions & 58 deletions .github/workflows/upgrade-python-requirements.yml
@@ -1,68 +1,27 @@
name: Upgrade Requirements
name: Upgrade Python Requirements

on:
schedule:
# will start the job at midnight every monday (UTC)
- cron: "0 0 * * 1"
workflow_dispatch:
inputs:
branch:
description: "Target branch to create requirements PR against"
description: "Target branch against which to create requirements PR"
required: true
default: 'master'
default: '$default-branch'

jobs:
upgrade_requirements:
runs-on: ubuntu-20.04

strategy:
matrix:
python-version: ["3.8"]

steps:
- name: setup target branch
run: echo "target_branch=$(if ['${{ github.event.inputs.branch }}' = '']; then echo 'master'; else echo '${{ github.event.inputs.branch }}'; fi)" >> $GITHUB_ENV

- uses: actions/checkout@v1
with:
ref: ${{ env.target_branch }}

- name: setup python
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}

- name: make upgrade
run: |
cd $GITHUB_WORKSPACE
make upgrade
- name: setup testeng-ci
run: |
git clone https://github.com/edx/testeng-ci.git
cd $GITHUB_WORKSPACE/testeng-ci
pip install -r requirements/base.txt
- name: create pull request
env:
GITHUB_TOKEN: ${{ secrets.REQUIREMENTS_BOT_GITHUB_TOKEN }}
GITHUB_USER_EMAIL: ${{ secrets.REQUIREMENTS_BOT_GITHUB_EMAIL }}
run: |
cd $GITHUB_WORKSPACE/testeng-ci
python -m jenkins.pull_request_creator --repo-root=$GITHUB_WORKSPACE \
--target-branch="${{ env.target_branch }}" --base-branch-name="upgrade-python-requirements" \
--commit-message="chore: Updating Python Requirements" --pr-title="Python Requirements Update" \
--pr-body="Python requirements update.Please review the [changelogs](https://openedx.atlassian.net/wiki/spaces/TE/pages/1001521320/Python+Package+Changelogs) for the upgraded packages." \
--user-reviewers="" --team-reviewers="community-engineering" --delete-old-pull-requests
- name: Send failure notification
if: ${{ failure() }}
uses: dawidd6/action-send-mail@v3
with:
server_address: email-smtp.us-east-1.amazonaws.com
server_port: 465
username: ${{secrets.EDX_SMTP_USERNAME}}
password: ${{secrets.EDX_SMTP_PASSWORD}}
subject: Upgrade python requirements workflow failed in ${{github.repository}}
to: community-engineering@edx.org
from: github-actions <github-actions@edx.org>
body: Upgrade python requirements workflow in ${{github.repository}} failed! For details see "github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
call-upgrade-python-requirements-workflow:
uses: openedx/.github/.github/workflows/upgrade-python-requirements.yml@master
with:
branch: ${{ github.event.inputs.branch || '$default-branch' }}
# optional parameters below; fill in if you'd like github or email notifications
# user_reviewers: ""
# team_reviewers: ""
# email_address: ""
# send_success_notification: false
secrets:
requirements_bot_github_token: ${{ secrets.REQUIREMENTS_BOT_GITHUB_TOKEN }}
requirements_bot_github_email: ${{ secrets.REQUIREMENTS_BOT_GITHUB_EMAIL }}
edx_smtp_username: ${{ secrets.EDX_SMTP_USERNAME }}
edx_smtp_password: ${{ secrets.EDX_SMTP_PASSWORD }}
10 changes: 5 additions & 5 deletions README.rst
Expand Up @@ -61,13 +61,13 @@ How To Contribute

Contributions are very welcome.

Please read `How To Contribute <https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst>`_ for details.
Please read `How To Contribute <https://github.com/openedx/edx-platform/blob/master/CONTRIBUTING.rst>`_ for details.

Even though they were written with ``edx-platform`` in mind, the guidelines
should be followed for Open edX code in general.

PR description template should be automatically applied if you are sending PR from github interface; otherwise you
can find it it at `PULL_REQUEST_TEMPLATE.md <https://github.com/edx/edx-developer-docs/blob/master/.github/PULL_REQUEST_TEMPLATE.md>`_
can find it it at `PULL_REQUEST_TEMPLATE.md <https://github.com/openedx/edx-developer-docs/blob/master/.github/PULL_REQUEST_TEMPLATE.md>`_

Reporting Security Issues
-------------------------
Expand All @@ -82,14 +82,14 @@ refer to this `list of resources`_ if you need any assistance.

.. _list of resources: https://open.edx.org/getting-help

.. |ci-badge| image:: https://github.com/edx/edx-developer-docs/actions/workflows/ci.yml/badge.svg
:target: https://github.com/edx/edx-developer-docs/actions/workflows/ci.yml
.. |ci-badge| image:: https://github.com/openedx/edx-developer-docs/actions/workflows/ci.yml/badge.svg
:target: https://github.com/openedx/edx-developer-docs/actions/workflows/ci.yml
:alt: Continuous Integration

.. |doc-badge| image:: https://readthedocs.org/projects/edx-developer-docs/badge/?version=latest
:target: http://edx-developer-docs.readthedocs.io/en/latest/
:alt: Documentation

.. |license-badge| image:: https://img.shields.io/github/license/edx/edx-developer-docs.svg
:target: https://github.com/edx/edx-developer-docs/blob/master/LICENSE.txt
:target: https://github.com/openedx/edx-developer-docs/blob/master/LICENSE.txt
:alt: License
2 changes: 1 addition & 1 deletion docs/index.rst
Expand Up @@ -91,7 +91,7 @@ New Plugin
Plugins can be built independently of the core platform and do not require review from the Open edX team to build or use.
If you want to add a new feature outside of courseware (learner/educator/operator experience) a new platform plugin might be a great option for you.

Check out `this overview of our Django plugin design <https://github.com/edx/edx-django-utils/blob/master/edx_django_utils/plugins/docs/decisions/0001-plugin-contexts.rst>`_ to get started.
Check out `this overview of our Django plugin design <https://github.com/openedx/edx-django-utils/blob/master/edx_django_utils/plugins/docs/decisions/0001-plugin-contexts.rst>`_ to get started.

New update to the core platform
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
26 changes: 13 additions & 13 deletions docs/micro_frontends/index.rst
Expand Up @@ -74,32 +74,32 @@ Service URLs

Example: ``https://credentials.example.com``

The fully-qualified URL of the `Credentials Service <https://github.com/edx/credentials>`_ in the target environment.
The fully-qualified URL of the `Credentials Service <https://github.com/openedx/credentials>`_ in the target environment.

``DISCOVERY_API_BASE_URL``

Example: ``https://discovery.example.com``

The fully-qualified URL of the `Course Discovery Service <https://github.com/edx/course-discovery>`_ for the target environment.
The fully-qualified URL of the `Course Discovery Service <https://github.com/openedx/course-discovery>`_ for the target environment.

``PUBLISHER_BASE_URL``

Example: ``https://publisher.example.com``
Status: DEPRECATED

**This should be considered deprecated and will be removed from a future release until such time as publisher itself is included in an Open edX release.** The fully-qualified URL of the `Publisher Micro-frontend <https://github.com/edx/frontend-app-publisher>`_. Today this is only used by micro-frontends that are not offically supported in any Open edX release, such as the `Support Tools Micro-frontend <https://github.com/edx/frontend-app-support-tools>`_.
**This should be considered deprecated and will be removed from a future release until such time as publisher itself is included in an Open edX release.** The fully-qualified URL of the `Publisher Micro-frontend <https://github.com/openedx/frontend-app-publisher>`_. Today this is only used by micro-frontends that are not offically supported in any Open edX release, such as the `Support Tools Micro-frontend <https://github.com/openedx/frontend-app-support-tools>`_.

``ECOMMERCE_BASE_URL``

``Example: https://ecommerce.example.com``

The fully-qualified URL of the `Ecommerce Service <https://github.com/edx/ecommerce>`_ in the target environment.
The fully-qualified URL of the `Ecommerce Service <https://github.com/openedx/ecommerce>`_ in the target environment.

``LEARNING_BASE_URL``

Example: ``https://learning.example.com``

The fully-qualified URL of the `Frontend App Learning <https://github.com/edx/frontend-app-learning>`_ in the target environment.
The fully-qualified URL of the `Frontend App Learning <https://github.com/openedx/frontend-app-learning>`_ in the target environment.

``LMS_BASE_URL``

Expand All @@ -123,7 +123,7 @@ The fully-qualified URL to the API endpoint in the target environment which perf

Example: ``https://studio.example.com``

The fully-qualified URL of Studio in the target environment. This is often used by micro-frontends from which educators may wish to go edit course content, such as `frontend-app-learning <https://github.com/edx/frontend-app-learning>`_
The fully-qualified URL of Studio in the target environment. This is often used by micro-frontends from which educators may wish to go edit course content, such as `frontend-app-learning <https://github.com/openedx/frontend-app-learning>`_

``MARKETING_SITE_BASE_URL``

Expand All @@ -136,7 +136,7 @@ Status: DEPRECATED

Example: ``https://orders.example.com``

The fully-qualified URL to the `Order History page <https://github.com/edx/frontend-app-ecommerce>`_. This is often used in a user menu in the header of micro-frontends.
The fully-qualified URL to the `Order History page <https://github.com/openedx/frontend-app-ecommerce>`_. This is often used in a user menu in the header of micro-frontends.

Analytics
---------
Expand Down Expand Up @@ -223,12 +223,12 @@ Example: for edx.org the Open edX @edx/frontend-component-header is overridden w
npm install @edx/frontend-component-header@npm:@edx/frontend-component-header-edx@latest
# git repository
npm install @edx/frontend-component-header@git:https://github.com/edx/frontend-component-header-edx.git
npm install @edx/frontend-component-header@git:https://github.com/openedx/frontend-component-header-edx.git
# local folder
npm install @edx/frontend-component-header@file:../path/to/local/module
A list overridable packages is being developed. Currently only `@edx/frontend-component-header <https://github.com/edx/frontend-component-header>`_ and `@edx/frontend-component-footer <https://github.com/edx/frontend-component-footer>`_ are designed to be overridden. See those repositories for the interfaces they expose.
A list overridable packages is being developed. Currently only `@edx/frontend-component-header <https://github.com/openedx/frontend-component-header>`_ and `@edx/frontend-component-footer <https://github.com/openedx/frontend-component-footer>`_ are designed to be overridden. See those repositories for the interfaces they expose.

**********
Deployment
Expand All @@ -244,7 +244,7 @@ The basic deployment strategy:

Note: The following is edX-specific and depends upon automation set up in GoCD. A similar, more manual process will need to be defined for Open edX installations.

edX MFEs are deployed automatically upon updates to the master branch in Github. GoCD collects three materials: the MFE source code, .yml configuration, and pipeline scripts (`edX tubular <https://github.com/edx/tubular>`_).
edX MFEs are deployed automatically upon updates to the master branch in Github. GoCD collects three materials: the MFE source code, .yml configuration, and pipeline scripts (`edX tubular <https://github.com/openedx/tubular>`_).

.yml configuration contains:

Expand All @@ -254,9 +254,9 @@ edX MFEs are deployed automatically upon updates to the master branch in Github.

Relevant pipeline scripts (edX tubular):

- https://github.com/edx/tubular/blob/master/tubular/scripts/frontend_utils.py
- https://github.com/edx/tubular/blob/master/tubular/scripts/frontend_build.py
- https://github.com/edx/tubular/blob/master/tubular/scripts/frontend_deploy.py
- https://github.com/openedx/tubular/blob/master/tubular/scripts/frontend_utils.py
- https://github.com/openedx/tubular/blob/master/tubular/scripts/frontend_build.py
- https://github.com/openedx/tubular/blob/master/tubular/scripts/frontend_deploy.py

The pipeline scripts perform a routine like below:

Expand Down

0 comments on commit c50a8b4

Please sign in to comment.