Skip to content

Commit

Permalink
fix wf, extract process from readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bkleinen committed Jun 15, 2024
1 parent c2f3912 commit 196fb74
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 21 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/gh-pages-fork.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:

jobs:
deploy:
if: github.repository_owner != 'htw-imi-showtime'
# if: github.repository_owner != 'htw-imi-showtime'
permissions:
contents: write
runs-on: ubuntu-latest
Expand All @@ -32,7 +32,7 @@ jobs:
run: |
hugo \
--environment production \
# --buildDrafts \
--buildDrafts \
--baseURL 'https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}'
- name: Deploy
Expand Down
25 changes: 6 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,36 +127,23 @@ cp -R content/ws23/master/m0-template/ content/ws23/master/m#-your-project/
6. Preview your changes locally to make sure everything looks fine by executing `hugo server --buildDrafts` and visiting http://localhost:1313/ in your browser. (of use `make`)
7. Add your changes to the git index, commit them to the repository and push them to GitHub:
```
git add content/ws23/<bachelor|master>/<project_number-your-project>
git add content/ss24/<bachelor|master>/<project_number-your-project>
git commit -m "Your commit message"
git push
```
8. Create a new pull request on GitHub that merges your version of the repo's `master` branch onto the htw-imi-showtime `master` branch. ([GitHub Help: Creating a pull request from a fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork))

Once your branch was merged, you may preview your project's page on our staging server: https://htw-imi-showtime.github.io/

One week before the Showtime takes place, the website will be published to our production server: https://showtime.f4.htw-berlin.de/
## Deploy your Fork on GH-Pages

### Please use Draft Mode
You can easily deploy your fork on GH-Pages by following the instructions here:
[http://about-hugo.github.io/hugo/quick/](http://about-hugo.github.io/hugo/quick/)

**tl;dr: use draft=true and --buildDraft to publish project sites only to staging.**
The workflow is "gh-pages fork".

- add draft = true to _index.md:
If you've created your project dir before 25.6.23:
Please add draft = true to the front matter of the top _index.md in your project subfolder.
(See the templates for an example.)
For a detailed Description of the Website Release process, see this page: [release-process.md](./release-process.md)

- for your local build as well as for staging, `hugo server --buildDrafts` is used
- on production, drafts are not included

- before the showtime, draft should be set to false

- this allows projects to be published on an individual schedule if needed,
but most importantly, it allows for publishing the Showtime Date and possibly other
info without the need for all or any projects to be ready
- see see hugo documentation
[https://gohugo.io/getting-started/usage/#draft-future-and-expired-content](https://gohugo.io/getting-started/usage/#draft-future-and-expired-content)
and this brief blog post: [https://makewithhugo.com/working-with-drafts/](https://makewithhugo.com/working-with-drafts/)
## Updating your Fork

To get the updates on the central repository into your fork, do the following:
Expand Down
25 changes: 25 additions & 0 deletions release-process.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@

# Release Process for the Showtime Website

One week before the Showtime takes place, the website will be published to our production server: https://showtime.f4.htw-berlin.de/

### Please use Draft Mode

**tl;dr: use draft=true and --buildDraft to publish project sites only to staging.**

- add draft = true to _index.md:
If you've created your project dir before 25.6.23:
Please add draft = true to the front matter of the top _index.md in your project subfolder.
(See the templates for an example.)

- for your local build as well as for staging, `hugo server --buildDrafts` is used
- on production, drafts are not included

- before the showtime, draft should be set to false

- this allows projects to be published on an individual schedule if needed,
but most importantly, it allows for publishing the Showtime Date and possibly other
info without the need for all or any projects to be ready
- see see hugo documentation
[https://gohugo.io/getting-started/usage/#draft-future-and-expired-content](https://gohugo.io/getting-started/usage/#draft-future-and-expired-content)
and this brief blog post: [https://makewithhugo.com/working-with-drafts/](https://makewithhugo.com/working-with-drafts/)

0 comments on commit 196fb74

Please sign in to comment.