Skip to content

Commit 12a6748

Browse files
committed
2 parents 23f3773 + 36daf94 commit 12a6748

2 files changed

Lines changed: 10 additions & 3 deletions

File tree

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,18 @@ If we create our instance of the graph with `tailored-graph-builder`, we will ge
5353

5454
# Deploying concore-editor in GitHub
5555

56+
If you have forked this repository, make sure to configure the GitHub actions. This is done *only once* for the entire GitHub deployment. Go to your fork's settings/pages (for example, https://github.com/pradeebanlab/concore-editor/settings/pages), and enable the GitHub Pages as shown below.
57+
58+
![The Pages Configuration](figures/github-pages.png)
59+
60+
Once this is configured, every time you want to update the hosted concore-editor, you need to run the "Build and Deploy" action as elaborated below.
61+
5662
We have two workflows.
5763

5864
* Build - triggers automatically on every push and pull just to ensure the new PRs are consistent.
5965

60-
* Build and Deploy - Has to be triggered manually and updates the online deployed version. Please go to this url and trigger this particular workflow https://github.com/ControlCore-Project/concore-editor/actions/workflows/buildAndDeploy.yml
66+
* Build and Deploy - This has to be triggered manually and updates the online deployed version. This ensures that any PR containing breaking change doesn't affect the user directly
67+
6168

62-
This ensures that any PR containing breaking change doesn't affect the user directly
63-
69+
Please go to the url https://github.com/ControlCore-Project/concore-editor/actions/workflows/buildAndDeploy.yml and trigger this particular workflow. This will in turn automatically trigger the Pages Build and Deploy action. Once that action also completes successfully, the new page will be alive. Depending on the nature of the changes, you may need to clear the cache/cookies to make the changes visible to your browser. You can choose to delete just the cookies and data of controlcore-project.github.io as stored in your browser. Please check the browser documentation for more information on deleting the cookies.
70+

figures/github-pages.png

408 KB
Loading

0 commit comments

Comments
 (0)