Skip to content

Commit

Permalink
Update umami.md (#19)
Browse files Browse the repository at this point in the history
* Update umami.md

Added instructions to get updates deployed automatecally.

* Update umami.md

* Update umami.md

---------

Co-authored-by: Adam Miedema <[email protected]>
  • Loading branch information
pointout and armgitaar authored Feb 10, 2024
1 parent 0701fc9 commit 7db8b6f
Showing 1 changed file with 68 additions and 2 deletions.
70 changes: 68 additions & 2 deletions content/guides/umami.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,39 @@ In the deployment workflow section, select **Complete Setup** for the deployment

### Enter repository

#### Option 1 - quick and simple but with no automatic updates

On the **Code Repository** tab, enter the following:

**Version Control Provider:** GitHub

**Repository:** mikecao/umami
**Repository:** umami-software/umami

**Branch:** master

Click **Update**.

#### Option 2 - automatic updates

Before making the settings in the **Code Repository** tab, open antoher browser tab and login to github. Clone the repository https://github.com/umami-software/umami.

Back in cleavr.io:

On the **Code Repository** tab, enter the following:

**Version Control Provider:** Your GitHub Profile

**Repository:** \<your-github-profile-name\>/umami

**Branch:** master

turn on **Deploy on Code Push to master**

Click **Update**.

We will add a github action to automatically sync the umami-software/umami repository with your fork at the end.
If you don't want to have the updates automated, ignore Step 5. Then you can alternatively trigger the cleavr.io deploment by syncing your fork in github manually.

<base-info>
You will need a GitHub VC provider account created for this step.
</base-info>
Expand Down Expand Up @@ -103,7 +126,50 @@ Once you have everything configured, deploy! 🚀

Select the URL for the site, and then enter the default user credentials:

**Username:** admin
**Username:** admin
**Password:** umami

## Step 5: Optional if you went for option 2 in step 3 above

Head over to the **Code**-Tab in your forked umami repository.

Go into the `.github/workflows` directory and add a new file `sync-to-fork.yml` and add the following contents:

```
name: Sync Fork
on:
workflow_dispatch:
schedule:
# check for updates every Sunday at 1a.m.
- cron: "0 1 * * 0"
jobs:
sync:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Sync and merge upstream repository with your current repository
# using dabreadman/sync-upstream-repo from the marketplace
# You may pin to the exact commit or the version.
# uses: dabreadman/sync-upstream-repo@fc5fe9952946b1daaafd9abd7fcd7e260b81ddbe
uses: dabreadman/[email protected]
with:
# URL of gitHub public upstream repo
upstream_repo: "https://github.com/umami-software/umami.git"
# Branch to merge from upstream (defaults to downstream branch)
upstream_branch: "master"
# Branch to merge into downstream
downstream_branch: "master"
# GitHub Bot token
token: ${{ secrets.GITHUB_TOKEN }}
```
Commit the new file. This may start a deployment on Cleavr if GitHub Actions is enabled for the branch.

In the GitHub repo, go to the project's **Actions** tab and select the "Sync Fork" Action. Next, run the workflow.

This action will look for updates at your scheduled time (cron). Changes to the original repo will be synced and Cleavr will run a deployment.

![Admin page](/images/umami/admin-page.png)

0 comments on commit 7db8b6f

Please sign in to comment.