Skip to content

Commit

Permalink
Fix github url strings (org edx -> openedx) (#274)
Browse files Browse the repository at this point in the history
* fix: fix github url strings (org edx -> openedx)

* fix: update path to .github workflows to read from openedx org

* docs: Update catalog-search README badges
  • Loading branch information
sarina authored Mar 2, 2023
1 parent 7f10fc1 commit 9e10009
Show file tree
Hide file tree
Showing 16 changed files with 190 additions and 191 deletions.
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
- *Note*: This may be found in the "Preview Updated Versions (dry run)" step in the Github Action CI workflow logs.

**Post merge:**
- [ ] Verify Lerna created a release commit (e.g., ``chore(release): publish``) that incremented versions in relevant package.json and CHANGELOG files, and created [Git tags](https://github.com/edx/frontend-enterprise/tags) for those versions.
- [ ] Run the ``Publish from package.json`` Github Action [workflow](https://github.com/edx/frontend-enterprise/actions/workflows/publish-from-package.yml) to publish these new package versions to NPM.
- [ ] Verify Lerna created a release commit (e.g., ``chore(release): publish``) that incremented versions in relevant package.json and CHANGELOG files, and created [Git tags](https://github.com/openedx/frontend-enterprise/tags) for those versions.
- [ ] Run the ``Publish from package.json`` Github Action [workflow](https://github.com/openedx/frontend-enterprise/actions/workflows/publish-from-package.yml) to publish these new package versions to NPM.
- This may be triggered by clicking the "Run workflow" option for the ``master`` branch.
- [ ] Verify the new package versions were published to NPM (i.e., ``npm view <package_name> versions --json``).
- *Note*: There may be a slight delay between when the workflow finished and when NPM reports the package version as being published. If it doesn't appear right away in the above command, try again in a few minutes.
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ To install a new NPM module in one or more specific workspace package(s), use th
Installing local monorepo package(s) into an Open edX micro-frontend
-----

For any micro-frontend using `@edx/frontend-build <https://github.com/edx/frontend-build>` that consumes any packages from this monorepo may want to use a local copy of one or more packages during development rather than relying solely on the published NPM packages. To do this, you may modify your module.config.js file to create Webpack aliases to your local checkout of the monorepo packages:
For any micro-frontend using `@edx/frontend-build <https://github.com/openedx/frontend-build>` that consumes any packages from this monorepo may want to use a local copy of one or more packages during development rather than relying solely on the published NPM packages. To do this, you may modify your module.config.js file to create Webpack aliases to your local checkout of the monorepo packages:

::

Expand Down Expand Up @@ -115,14 +115,14 @@ This library has its version automatically updated by Lerna (i.e., ``lerna versi

When a PR is merged, Lerna creates a release commit (e.g., ``chore(release): publish``). In this commit, Lerna increments the versions in the appropriate package.json files for any changed packages, creates Git tags, and updates the CHANGELOG file.

To publish the packages that had their versions incremented, you must manually trigger the ``Publish from package.json`` Github Action workflow `found here <https://github.com/edx/frontend-enterprise/actions/workflows/publish-from-package.yml>`_. It will publish any versions denoted in the package.json files that are not currently published on the NPM registry, publishing the incremented versions from the aforementioned release commit.
To publish the packages that had their versions incremented, you must manually trigger the ``Publish from package.json`` Github Action workflow `found here <https://github.com/openedx/frontend-enterprise/actions/workflows/publish-from-package.yml>`_. It will publish any versions denoted in the package.json files that are not currently published on the NPM registry, publishing the incremented versions from the aforementioned release commit.

Preview changed packages in CI with Github Actions
-----

As a convenience, a dry run of the ``lerna version`` command is run for each push to determine which packages in the monorepo will be published should a PR get merged.

.. |Build Status| image:: https://github.com/edx/frontend-enterprise/actions/workflows/release.yml/badge.svg
:target: https://github.com/edx/frontend-enterprise/actions
.. |Build Status| image:: https://github.com/openedx/frontend-enterprise/actions/workflows/release.yml/badge.svg
:target: https://github.com/openedx/frontend-enterprise/actions
.. |Codecov| image:: https://codecov.io/gh/edx/frontend-enterprise/branch/master/graph/badge.svg?token=lBHoe5P4Q3
:target: https://codecov.io/gh/edx/frontend-enterprise
2 changes: 1 addition & 1 deletion docs/how_tos/resolving_publishing_issues_with_lerna.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ In setting up the Lerna monorepo, there was a moment when the ``lerna publish``

The result of this publishing failure was that the Git repository was in a state as if the release had been published, without the same, matching version existing on the NPM registry. This document serves as a starting point to resolve that situation.

In the scenario where Git tags and a "chore: publish" commit were created for a new release without that release actually being published to NPM, you may `temporarily modify the release.yml Github Action workflow file <https://github.com/edx/frontend-enterprise/blob/master/.github/workflows/release.yml#L40>`_ to run the following command instead of the default ``lerna publish``:
In the scenario where Git tags and a "chore: publish" commit were created for a new release without that release actually being published to NPM, you may `temporarily modify the release.yml Github Action workflow file <https://github.com/openedx/frontend-enterprise/blob/master/.github/workflows/release.yml#L40>`_ to run the following command instead of the default ``lerna publish``:

::

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"description": "Frontend libraries and UI components for Enterprise in a monorepo managed by Lerna",
"repository": {
"type": "git",
"url": "git+https://github.com/edx/frontend-enterprise.git"
"url": "git+https://github.com/openedx/frontend-enterprise.git"
},
"workspaces": [
"./packages/*"
Expand Down
Loading

0 comments on commit 9e10009

Please sign in to comment.