Skip to content

Commit f358373

Browse files
committed
Backed up old workflow for releasing. Updated guide
1 parent 6b70287 commit f358373

File tree

11 files changed

+127
-10
lines changed

11 files changed

+127
-10
lines changed
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

CONTRIBUTING.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -74,20 +74,24 @@ find . -type f -iname "*.png" -exec optipng -nb -nc {} \;
7474

7575
## Test release build locally
7676

77-
Build a release with
77+
Build a local version with:
7878

7979
``` bash
80-
./.github/ci/build_site
80+
hugo server --buildDrafts --buildFuture
8181
```
8282

83-
The output will be in `./site/vdev`.
83+
This will start a local development server at [http://localhost:1313](http://localhost:1313).
8484

85-
To run a webserver that mimics GitHub Pages, install [devd][devd], e.g. with `brew install devd`.
85+
To test a production build locally:
8686

87-
Then run
87+
``` bash
88+
hugo --minify --destination "public" --baseURL "http://localhost:8000/observability-workshop"
89+
```
90+
91+
Then serve it with [devd][devd] (install with `brew install devd`):
8892

8993
``` bash
90-
devd /observability-workshop/vdev/=./site/vdev /=./site/vdev
94+
devd /observability-workshop/=./public /=./public
9195
```
9296

9397
and visit [http://localhost:8000/](http://localhost:8000/) to inspect the site.
@@ -98,10 +102,16 @@ and visit [http://localhost:8000/](http://localhost:8000/) to inspect the site.
98102

99103
1. On GitHub, navigate to the main page of the repository.
100104

101-
2. Under your repository name, click Actions.
105+
2. Under your repository name, click **Actions**.
106+
107+
3. In the left sidebar, click **Deploy Workshop to GitHub Pages**.
108+
109+
4. Above the list of workflow runs, select **Run workflow** dropdown.
102110

103-
3. In the left sidebar, click Deploy Workshop.
111+
5. Choose the release type:
112+
- **minor** - for incremental updates (e.g., 6.13 → 6.14)
113+
- **major** - for breaking changes (e.g., 6.14 → 7.0)
104114

105-
4. Above the list of workflow runs, select Run workflow dropdown and click Run workflow
115+
6. Click **Run workflow**.
106116

107-
Then the release will run through the CI/CD pipeline and be available shortly after.
117+
The release will run through the CI/CD pipeline and be deployed to `https://splunk.github.io/observability-workshop/` shortly after.

0 commit comments

Comments
 (0)